openapi: 3.0.0
info:
  title: API Reference
  version: '2026-02-20'
  contact:
    email: docs@zuora.com
  description: >


    Welcome to the v1 API reference for the Zuora Billing, Payments, and
    Platform!



    To learn about the common use cases of the Zuora v1 API, check out the [API
    Tutorials](https://developer.zuora.com/docs/get-started/tutorials/).



    **Important**: This API Reference only showcases the parameters, fields, and
    behaviors available for the latest API minor version (`2025-08-12`). 

    For more information about Zuora API versions, see [API
    versions](https://developer.zuora.com/v1-api-reference/api-versions/) and
    [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).



    We recommend that you upgrade to the latest API version to take advantage of
    the latest Zuora capabilities. 

    For instructions about upgrading the API version, see [API upgrade
    guide](https://developer.zuora.com/v1-api-reference/api-upgrade-guide/).


    Try the v1 API in our Postman collection:

      
    <a
    href="https://god.gw.postman.com/run-collection/931729-e324e9d4-9443-4759-8862-a25aa186dbbd?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D931729-e324e9d4-9443-4759-8862-a25aa186dbbd%26entityType%3Dcollection%26workspaceId%3D96800895-4ec5-4a21-af99-d701ba81924e"><img
    src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width:
    128px; height: 32px;"></a>



    Some 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](https://developer.zuora.com/v1-api-reference/older-api/overview/).


    ### More OpenAPI specification options


    To support your integration with our OpenAPI specifications, whether using
    in-house solutions or third-party tools, we provide the following resources:


    - **Order-to-Cash operations (detailed)**: Download <a
    href="https://developer.zuora.com/yaml/apis/zuora-openapi-for-otc.yaml"
    download>Order-to-Cash OpenAPI spec</a>, which includes full descriptions
    and examples

    - **Order-to-Cash operations (compact)**: Download <a
    href="https://developer.zuora.com/yaml/apis/zuora-openapi-for-otc-compact.yaml"
    download>Order-to-Cash Compact OpenAPI spec</a>, which excludes descriptions
    and code examples.

    - **Full OpenAPI spec (compact)**: Download <a
    href="https://developer.zuora.com/yaml/apis/zuora-openapi-full-compact.yaml"
    download>Compact OpenAPI Spec</a>, which covers the entire API set without
    descriptions or samples.
      
    If you need a different API specification beyond the options above, contact
    <a href="https://support.zuora.com" target="_blank">Zuora Global
    Support</a>, and we will provide a custom spec tailored to your needs.
servers:
  - url: https://rest.test.zuora.com
    description: US Developer & Central Sandbox (incl. Test Drive)
  - url: https://rest.sandbox.na.zuora.com
    description: US API Sandbox Cloud 1
  - url: https://rest.apisandbox.zuora.com
    description: US API Sandbox Cloud 2
  - url: https://rest.na.zuora.com
    description: US Production Cloud 1
  - url: https://rest.zuora.com
    description: US Production Cloud 2
  - url: https://rest.test.eu.zuora.com
    description: EU Developer & Central Sandbox
  - url: https://rest.sandbox.eu.zuora.com
    description: EU API Sandbox
  - url: https://rest.eu.zuora.com
    description: EU Production
  - url: https://rest.test.ap.zuora.com
    description: APAC Developer & Central Sandbox
  - url: https://rest.ap.zuora.com
    description: APAC Production
security:
  - bearerAuth: []
tags:
  - description: >
      A Test Environment is a dedicated sandbox tenant designed for development,
      integration, and user acceptance testing of your system configurations and
      business processes.
    name: Test Environments
  - description: >
      A Test Environment Job represents an asynchronous operation initiated to
      refresh a Test Environment. These jobs track the status and progress of
      environment provisioning and refresh.
    name: Test Environment Jobs
  - description: >
      A Test Environment Notification is an automated email dispatched to inform
      stakeholders when a Test Environment Job is completed or cancelled.
    name: Test Environment Notifications
  - description: >
      Actions are operations that are batch in nature. For example, the
      "create", "update", "delete", and other operations allow changes to up-to
      50 objects at a time. The "query" operation will return up-to 2000 result
      records back at a time, before requiring additional pages of data to be
      returned via a subsequent "queryMore" operation.


      The default WSDL version for Actions is 79. If you want to change the WSDL
      version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL
      version a particular object or field was introduced, see [Zuora SOAP API
      Version
      History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).


      **Note**: Actions do not support the Invoice Settlement feature. This
      feature includes Unapplied Payments, Credit and Debit Memo, and Invoice
      Item Settlement. Actions also do not support the Orders feature.
    name: Actions
  - description: >
      Accounting Codes are commonly referred to as General Ledger Accounts or
      General Ledger Account Codes. In Zuora, the use of accounting codes are
      optional but recommended. 


      This section contains the operations that allow you to create, update,
      get, delete, activate, or deactivate accounting codes in Zuora.
    name: Accounting Codes
  - description: >
      A key step in configuring Finance is to create accounting periods in Zuora
      to match your company's financial calendar. 

      This allows Zuora to produce reports and data exports organized by
      accounting periods, and to perform the work of closing the accounting
      periods for the revenue sub-ledger.
    name: Accounting Periods
  - description: >
      Some operations in this section are similar to each other, but are

      provided for different use scenarios. You should choose the one that best
      suits

      your needs.



      For example, the [Retrieve an
      account](https://developer.zuora.com/v1-api-reference/api/operation/GET_Account/)
      operation retrieves the basic information of an account, such as bill-to
      and sold-to contacts, billing and payments setup information, and metrics
      data for the account.


      The [Retrieve an account
      summary](https://developer.zuora.com/v1-api-reference/api/operation/GET_AccountSummary/)
      operation returns the more detailed information of an account, such as
      bill-to and sold-to contacts, subscriptions, invoices, payments, and
      usages associated with this account.
    name: Accounts
  - description: >
      Delivery Adjustments are used to handle end customer delivery complaints
      for the Delivery Pricing charge model. For more information, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Delivery_Adjustments"
      target="_blank">Delivery Adjustments</a>.  
    name: Delivery Adjustments
  - description: >
      The Aggregate Query API (AQuA) is a REST API that executes multiple <a
      href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Query/Export_ZOQL"
      target="_blank">Export ZOQL</a> or <a
      href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Query/ZOQL"
      target="_blank">ZOQL</a> queries. The queries are performed in a
      sequential order and in a single read-only database transaction. 


      AQuA enforces the following limits:


      - The maximum processing time per query is 3 hours. If a query in an AQuA
      job is executed for longer than 3 hours, this job will be killed
      automatically. See the <a
      href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA"
      target="_blank">best practices for bulk data extraction with AQuA</a>.


      - AQuA enforces limits on both the stateful concurrent AQuA jobs and the
      stateless concurrent AQuA jobs per tenant:
        - The maximum number of stateful concurrent AQuA jobs per tenant is 50.  - The maximum number of stateless concurrent AQuA jobs per tenant is 50.
      AQuA jobs in the following status are counted towards your concurrent AQuA
      job limits:
        - Submitted  - Executing
      Zuora system will reject the subsequent stateful or stateless job requests
      once the corresponding concurrent job limit is reached.


      For more information about the Aggregate Query API(AQuA), see <a
      href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API"
      target="_blank">Aggregate Query</a>.      
    name: Aggregate Queries
  - description: >
      Zuora System Health dashboard for API (API dashboard) collects and
      displays data about API usage, failure, performance, and concurrency limit
      in near real time. It enables you to view all the APIs in your Zuora
      tenant within the last 14 days. For more information, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard"
      target="_blank">APIs dashboard</a>.
    name: API Health
  - description: >
      Use attachments in Zuora to upload documents of various formats to
      associate additional information with accounts, subscriptions, invoices,
      credit memos, or debit memos. 

      Example attachments could be purchase orders (PO's), tax exemption
      document, or ownership transfer forms.


      For more information about attachments, see <a
      href="https://knowledgecenter.zuora.com/Billing/Tenant_Management/F_Attachments"
      target="_blank">Attachments</a>.
    name: Attachments
  - description: >
      Zuora System Health dashboard for Bill Run (Bill Run dashboard) collects
      and displays data about bill run usage, failure, and performance in near
      real time. Through the Bill Run dashboard, you can view data about all the
      bill runs in your Zuora tenant within the last 30 days. For more
      information, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/C_Bill_Run_dashboard"
      target="_blank">Bill Run dashboard</a>.
    name: Bill Run Health
  - description: >
      Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query,
      and Delete bill runs. 


      For more information about bill runs, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs"
      target="_blank">Bill runs</a>.
    name: Bill Run
  - description: >
      Billing documents include invoices, credit memos, and debit memos. 


      **Note**: Credit memos and debit memos are only available if you have the
      <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement"
      target="_blank">Invoice Settlement</a> feature enabled. 
    name: Billing Documents
  - description: >
      A billing preview run asynchronously generates a downloadable CSV file
      containing a preview of future invoice item data and credit memo item data
      for a batch of customer accounts. 


      **Note**: Credit memo item data is only available if you have the <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement"
      target="_blank">Invoice Settlement</a> feature enabled. 
    name: Billing Preview Run
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.

      For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"

      target="_blank">Commerce API</a>.



      The Zuora Billing product catalog is where you define your products

      and pricing. The product catalog's ability to handle sophisticated pricing
      models

      gives you the power to easily adapt your pricing to customer and market
      needs,

      to grow your business and drive more revenue. 
    name: Catalog
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.

      For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"

      target="_blank">Commerce API</a>.



      A catalog group is used to group a list of product rate plans with

      a specific grade.
    name: Catalog Groups
  - description: >
      Configuration Templates in Zuora Deployment Manager enable you to
      configure your tenants in minutes by importing a templated metadata
      configuration file. This feature eliminates the need for long manual
      configuration processes that would have previously taken hours. You will
      be able to access a comprehensive repository of industry-specific
      templates. It will be easier for you to deploy and release. To use this
      API  for migrating metadata from a source tenant to a destination
      tenant,   you should authenticate using credentials of the source tenant  
      The user will have to provide the client id and secret key from the
      sou.rce tenant.   To understand the known behavior of configuration
      templates and APIs, see the following sections: [Product Catalog
      deployment known facts and system
      behavior](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AE_Known_facts_and_system_behavior)
      [Product Catalog deployment
      FAQs](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AF_Product_Catalog_deployment_FAQs)
      [Deployment Manager Known Facts and
      Limitations](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/C_Deployment_Manager_Limitations) 
    name: Configuration Templates
  - name: Metadata
    description: >
      The Metadata API in Zuora promotes a programmatic way to retrieve,
      compare, and validate 

      metadata within Zuora tenants for performing create and update actions
      between the source and the target.

      To use this API  for migrating metadata from a source tenant to a
      destination tenant, 

      you should authenticate using credentials of the source tenant. 

      The user will have to provide the client id and secret key from the source
      tenant. 

      To understand the known behavior of configuration templates and APIs, see
      the following sections:

      [Product Catalog deployment known facts and system
      behavior](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AE_Known_facts_and_system_behavior)

      [Product Catalog deployment
      FAQs](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AF_Product_Catalog_deployment_FAQs)

      [Deployment Manager Known Facts and
      Limitations](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/C_Deployment_Manager_Limitations)
  - description: >
      The Bulk Data API operations allow you to manage bulk data loader services
      and perform programmatic CRUD (Create, Update, Read/export, Delete)
      operations. \

      To perform data ingestion with a CSV file in Zuora Billing using the Data
      Loader Bulk Data APIs, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Platform/Data_Management/Data_Loader/Tutorial_for_Bulk_job_API_with_CSV"
      target="_blank">Tutorial for Bulk job API with CSV</a>. 

      For more information, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Platform/Data_Management/Data_Loader/Process_Bulk_Job_with_JSON-lines_in_Data_Loader"
      target="_blank">Process Bulk Job with JSON-lines in Data Loader</a>.
    name: Bulk Data
  - description: >
      The Commerce APIs provide access to product catalog, plans, charges, and
      order

      management functionality in Zuora. These endpoints are used to create,
      update,

      and query product rate plans, charges, and dynamic pricing details that
      drive

      subscription and billing behavior.


      In a typical use case, the Commerce APIs are called to provision new
      products

      or plans in the catalog, configure dimensional pricing, or submit orders
      that

      create and modify subscriptions.


      Changes made with these APIs affect the product catalog and active
      subscriptions,

      depending on the endpoint. Catalog changes update future subscription
      behavior,

      while order operations directly impact customer subscriptions in real
      time.'
    name: Commerce
  - description: >
      A commitment represents a minimum or maximum spend amount a customer is
      obligated to pay within a spend period, compared with customer's actual
      fees incurred in connection with customer's accounts and their use of
      applicable products. 

      The Commitments API allows you to retrieve details of the commitments a
      customer has.
    name: Commitments
  - description: |
      Every time a contact is updated a snapshot is taken.
    name: Contact Snapshots
  - description: >
      Configurable Payment Retry APIs use basic authentication. The user name is
      the email address that you use for logging in Zuora. The password is the
      API token that is shown in the settings of Configurable Payment Retry.

      Click the drop-down arrow at the end of an endpoint to display the full
      endpoint. To learn more about the configuration and usage of Configurable
      Payment Retry, see [Configurable Payment
      Retry](https://knowledgecenter.zuora.com/Zuora_Payments/Configure_payment_orchestration/Payment_Retry/Configurable_Payment_Retry).
    name: Configurable Payment Retry
  - description: >
      A contact defines the customer who holds an account or who is otherwise a
      person to contact about an account. An account requires a contact for the
      `BillToId` and `SoldToId` fields before the account can be active.
    name: Contacts
  - description: >
      Credit memos reduce invoice and account balances. By applying one or more
      credit memos to invoices with positive balances, you can reduce the
      invoice balances in the same way that applying a payment to an invoice.


      For more information about credit memos, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos"
      target="_blank">Credit and debit memos</a>.
    name: Credit Memos
  - description: >
      The Event Trigger service manages the business events and trigger
      conditions that are defined on [Zuora Business Object
      Model](http://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Zuora_Business_Objects_Relationship)
      or custom objects. When a Zuora object changes, the trigger conditions
      defined on the object are evaluated, and if any condition qualifies, a
      business event will be triggered and turned into a notification.


      **Note**: Event Triggers operations are only applicable to custom events.
    name: Custom Event Triggers
  - description: >
      If you use a custom exchange rate provider and upload rates with the
      Import Foreign Exchange Rates mass action, you can query custom foreign
      exchange rates from Zuora through API. 


      This feature is in **Limited Availability**. If you wish to have access to
      the feature, submit a request at <a href="http://support.zuora.com/"
      target="_blank">Zuora Global Support</a>.
    name: Custom Exchange Rates
  - description: >
      With Custom Objects service, you can define custom objects, extending the
      Zuora data model to accommodate your specific use cases.


      If you use Postman, you can import the custom objects endpoints as a
      collection into your Postman app and try out different requests to learn
      how the API works. 


      You can sign up for a free account on the [Postman
      website](https://identity.getpostman.com/signup) and download the app in
      case you do not use Postman yet.


      Note that the Custom Object Definitions API is versioned by
      `Zuora-Version` in the request header. The response may be different for
      the same request with a different API version. Specify `Zuora-Version` in
      the request header if you expect a specific response schema.


      ### Error handling      

      If the Custom Objects API call fails, an error code will be returned in
      the response body. See See <a
      href='https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code'
      target='_blank'>Custom Objects API error code</a> for details.
    name: Custom Object Definitions
  - description: >
      With Custom Objects service, you can create, update, delete and find
      custom object records.


      If you use Postman, you can import the custom objects endpoints as a
      collection into your Postman app and try out different requests to learn
      how the API works. 


      You can sign up for a free account on the [Postman
      website](https://identity.getpostman.com/signup) and download the app in
      case you do not use Postman yet.


      Note that the Custom Object Records API is versioned by `Zuora-Version` in
      the request header. The response may be different for the same request
      with a different API version. Specify `Zuora-Version` in the request
      header if you expect a specific response schema.


      ### Error handling      

      If the Custom Objects API call fails, an error code will be returned in
      the response body. See <a
      href='https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code'
      target='_blank'>Custom Objects API error code</a> for details.
    name: Custom Object Records
  - description: >
      With Custom Objects service, you can submit a bulk job request to create,
      update, or delete custom object records in a batch.


      If you use Postman, you can import the custom objects endpoints as a
      collection into your Postman app and try out different requests to learn
      how the API works. 


      You can sign up for a free account on the [Postman
      website](https://identity.getpostman.com/signup) and download the app in
      case you do not use Postman yet.


      Note that the Custom Object Jobs API is versioned by `Zuora-Version` in
      the request header. The response may be different for the same request
      with a different API version. Specify `Zuora-Version` in the request
      header if you expect a specific response schema.


      ### Error handling      

      If the Custom Objects API call fails, an error code will be returned in
      the response body. See <a
      href='https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code'
      target='_blank'>Custom Objects API error code</a> for details.
    name: Custom Object Jobs
  - description: >
      Open Payment Method (OPM) service is a framework developed by Zuora, which
      allows you to integrate your custom payment method to Zuora subscription,
      billing, and revenue management in a dynamic and flexible manner. With the
      support of the OPM service, you are able to define your custom payment
      method types and create custom payment methods of the defined types. The
      custom payment method of the defined type can only be used with the custom
      payment gateway that you set up through the Universal Payment Connector
      (UPC) service. It cannot be used with the Zuora out-of-box gateway
      integrations such as GoCardless, Stripe, etc.


      You can define up to 20 custom payment method types for one tenant. Do not
      define your fields with the [Zuora-reserved
      fields](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods/C_Configure_and_manage_your_custom_payment_method_types_through_Zuora_REST_APIs#Zuora-reserved_fields).


      See [Set up custom payment gateways and payment
      methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
      for more information about the OPM and UPC services.


      Note: You can only use the bearer token to access the "Custom Payment
      Method Types" API operations. Access with `apiAccessKeyId` and
      `apiSecretAccessKey` is not supported.
    name: Custom Payment Method Types
  - description: >
      A custom scheduled event notification is evaluated at the scheduled time
      of the related scheduled event on a daily basis. If the date meets the
      combination of the base field and the notification parameters, the
      notification will be triggered immediately.


      For more information about Custom Scheduled Events, see <a
      href="https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events"
      target="_blank">Custom Scheduled Events</a>.
    name: Custom Scheduled Events
  - description: >
      If you are an <a
      href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
      target="_blank">Order to Revenue</a> user, you can use the data backfill
      operations to perform, view or stop data backfill tasks.
    name: Data Backfill
  - description: >
      The Data Labeling APIs help you to label your existing data with
      organization(s) in Zuora. 


      Once you turned on Multi Org feature, if you don't label your existing
      data, they are simply unlabeled, and unlabeled data can be accessed by all
      organizations in your tenant.


      To limit the access of your existing data, you need to label them with
      organization(s) you defined in the organization hierarchy management
      setting page. Once labeled, the data can only be accessed by users who
      have been granted with the labeled organization(s).


      Note that you have to enable the "Multi Org" feature before using the Data
      Labeling APIs. 


      ### General guidelines


      * Firstly, create the org hierarchy and determine the data categorization
      strategy, for example, by currency, by region, by custom fields etc.


      * You have to migrate all customer accounts before labeling products in
      the product catalog


      * You can leave the users at the root, just so long as you understand that
      the user would have access to all the Org Units within the Multi-org
      enabled tenant.


      ### Order of object labeling


      Except for `Account` and `Product`, there are no dependencies between
      objects, users can label them in parallel.


      But please keep in mind that the data access control ensues from the
      object labeling. For example, if you label a scheduled `BillRun` with `US`
      org, when it's triggered next time, the bill run will only pick up
      customer accounts of the `US` org, not others.


      Likewise, labeling a user will change the user's visible data scope, for
      example, an `EU` user won't be able to see `US` accounts anymore.

       ### Caveats⚠️

      This API is primarily designed for data migration to assist in  labeling
      existing datasets. 

      It may also serve for data corrections, such as  reassigning an account's
      organizational label, 

      thereby transferring the account  and its transaction data from one
      organization to another. 



      It's important  to note that this process does not include business logic
      validation. 

      Users  should exercise caution and judgment when employing this API for
      data labeling tasks.
    name: Data Labeling
  - description: >
      The Data Query feature enables you to perform SQL queries in your Zuora
      tenant. To learn how to get started with Data Query, see [Overview of Data
      Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/A_Overview_of_Data_Query).
    name: Data Queries
  - description: >
      Debit memos increase the amount a customer owes. It is a separate document
      from the invoice. Debit memos can be used to correct undercharging on an
      invoice or to levy ad hoc charges outside the context of a subscription.
      Just like an invoice, debit memo balances can be settled by applying
      either a payment or a credit memo.


      For more information about debit memos, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos"
      target="_blank">Credit and debit memos</a>.
    name: Debit Memos
  - description: >
      You can use the [Describe an
      object](https://developer.zuora.com/v1-api-reference/api/operation/GET_Describe/)
      operation to get a reference listing of each object that is available in
      your Zuora tenant.


      By default, the information returned by the "Describe an object" operation
      corresponds to the latest version of the Zuora WSDL.
    name: Describe
  - description: >
      With the <a
      href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
      target="_blank">E-Invoicing</a> feature, Zuora supports electronic
      invoices through an integration with partners that have a local presence,
      where required, which guarantees compliance with local invoice
      regulations. 


      All the operations in this section are available only if you have the
      E-Invoicing feature enabled.
    name: E-Invoicing
  - description: >
      Zuora System Health dashboard for Electronic Payments (Electronic Payment
      dashboard) collects and displays usage, failure, and performance data
      about electronic payments in near real time. It enables you to view all
      the electronic payments in your Zuora tenant within the last 30 days. For
      more information, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/D_Electronic_Payments_dashboard"
      target="_blank">Electronic Payments dashboard</a>.
    name: Electronic Payments Health
  - description: >-
      Zuora System Health dashboard for Tax Health (Tax Health dashboard)
      collects and displays usage, failure, and performance data about Tax in
      near real time. It enables you to view all the tax details in your Zuora
      tenant within the last 30 days. For more information, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Apply_taxes/A_Zuora_Tax"
      target="_blank">Tax Health Dashboard</a>.
    name: Tax Health
  - description: >
      You can use the operations contained in this section to retrieve files
      such as export results, invoices, accounting period reports, and so on.
    name: Files
  - description: >
      Fulfillments are subordinate objects attached to their related order line
      item. Fulfillment items are subordinate objects attached to their related
      fulfillment. 


      For more information, see <a
      href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items"
      target="_blank">Overview of Order Line Items</a>. 
    name: Fulfillments
  - description: >
      Hosted payment pages allow your customers to set up a payment method, such
      as providing a credit card. Since it only handles the payment method, it
      is suitable for a simple workflow or a complex multi-page, multi-product
      workflow. 


      For more information, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages"
      target="_blank">Hosted Payment Pages</a>.
    name: Hosted Pages
  - description: >
      An import uploads content, especially when you have a large amount of
      content. The Import object contains all of the information you need to
      upload content, such as a large number of usage records. 
    name: Imports
  - description: >
      Use invoice schedules to trigger invoice generation processes. 


      For more information about invoice schedules, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_overview"
      target="_blank">Billing Schedule overview</a>.
    name: Invoice Schedules
  - description: >
      Invoices provides information about customers' accounts for invoices, for
      examples, dates, status, and amounts. 


      For more information about invoices, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/A1_Invoice_Introduction"
      target="_blank">Invoice</a>.
    name: Invoices
  - description: >
      Use journal runs to automatically create summary journal entities that are
      suitable for importing into your general ledger system.


      For more information about journal runs, see <a
      href="https://knowledgecenter.zuora.com/Billing/Finance/F_Summary_Journal_Entries/h_Journal_Runs"
      target="_blank">Journal Runs</a>.
    name: Journal Runs
  - description: >
      Use mass updater to perform mass actions more easily.


      For more information about mass updater, see <a
      href="https://knowledgecenter.zuora.com/Billing/Finance/Mass_Updater"
      target="_blank">Mass Updater</a>.
    name: Mass Updater
  - description: >
      Notifications are the actions taken to inform users or call third-party
      endpoints when a certain event happens. Typical actions include emails and
      callouts. Callouts typically refer to HTTP invocations, such as HTTP calls
      to REST services.


      Zuora notification system processes the events in the same order in which
      they are triggered. The timing and delivery of notifications can still
      vary based on factors such as retries, concurrency, and network latency.
      But Zuora guarantees the best performance possible with the right
      performance boosters and tuning. 


      Notifications are associated with Communication Profiles, which allow you
      to send specific event-driven notifications to targeted customers. Zuora
      provides the following Settings API to access the settings of
      Communication Profiles:* [Get all Communication
      Profiles](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Communication_Profiles)
        * [Create a new Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Create_a_new_Communication_Profile)
        * [Modify a Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Modify_a_Communication_Profile)
        * [Get all Notifications under a particular Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Notifications_under_a_particular_Communication_Profile)
    name: Notifications
  - description: >-
      The Zuora Mediation APIs provide a comprehensive set of endpoints to
      manage, test, run, and monitor usage meters. These APIs support actions
      such as running or testing specific meter versions, importing and
      exporting meter configurations, managing input files, performing event
      store operations, and ingesting usage data in real time via streaming. All
      APIs follow a consistent response structure to simplify integration and
      error handling. Use these APIs to automate and streamline your usage
      processing pipeline—from data ingestion to transformation and billing.
    name: Meters
  - description: >
      Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST
      API. 


      You must first create an OAuth client in the Zuora UI before using the
      [Create an OAuth
      token](https://developer.zuora.com/api-references/api/operation/createToken)
      operation to create an OAuth token. See
      [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/)
      for more information.
    name: OAuth
  - description: >
      System for Cross-domain Identity Management, or SCIM, is an API
      specification created to facilitate the management of people and groups of
      people in cloud-based applications and services.
        Universal Identity SCIM API is built on top of the SCIM 2.0 specification and can be integrated with major Identity Providers like Okta, Microsoft Entra ID and OneLogin.



      Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST
      API. 


      You must first create an OAuth client in the Zuora UI before using the
      [Create an OAuth
      token](https://developer.zuora.com/api-references/api/operation/createToken)
      operation to create an OAuth token. See
      [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/)
      for more information.


      ### Prerequisites

      1. You need to have a One-ID account.

      2. You need to create OAuth 2.0 Clients.

      3. Use the client credentials to generate the bearer token.

      4. Generate the authentication token by hitting the endpoint.



      ### Steps to generate the bearer token

      1. Hit the endpoint to get the token:
         ```bash
         curl --location 'https://one.zuora.com/oauth2/token' \
           --header 'Content-Type: application/x-www-form-urlencoded' \
           --data-urlencode 'client_id=52a1d024-b7cc-4d3d-8d0b-dd7b23959e10' \
           --data-urlencode 'client_secret=aQWDDjn3x9JXbMUQaddvBa2vQQMDCHXL8BgeER8' \
           --data-urlencode 'grant_type=client_credentials'
         ```

         You will get the response as below:
         ```json
         {
           "access_token": "eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg",
           "scope": "admin rc141dc2-901e-4813-a25d-ef480cff1e26",
           "token_type": "Bearer",
           "expires_in": 3600
         }
         ```
      2. Use the access token in all the following API calls. Sample curl
      request:
         ```bash
         curl --location --request GET 'https://one.zuora.com/scim/v2/Schemas' \
           --header 'Authorization: Bearer eyJraWQiOiIxNTYwMDBkMi1lY2FjLTQxMGYtOTJmYy02Y2IxMjU1YjQ3NTAiLCJhbGciOiJSUzI1NiJ9.eyIzdWIiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJhdWQiOiI1MWExZDAyNC1iN2NjLTRkM2QtOGQwYi1kZDdiMjM5NTllMTAiLCJuYmYiOjE2OTA1MzcyODksInNjb3BlIjpbImFkbWluIiwiZWMxNDFkYzItOTAxZS00ODEzLWEyNWQtZWY0ODBjZmYxZTI2Il0sImlzcyI6Imh0dHA6XC9cL2xvY2FsaG9zdDo5OTAwIiwiZXhwIjoxNjkwNTQwODg5LCJpYXQiOjE2OTA1MzcyODl9.NMZV-aERA8lTKPPsMtk_WK9ApvX-Bj-6FEIF9GP_duObzdReQkCA2ykcsPSmimw3IbJu7F4XbjZkwTCZL_vBiTaJlnQ7k3hXUzw30b3olDP2Dwc_W6Eh-CvT6s5ZxsFURCZJitfuqh82ezxHdT2lUdcDEMbELw9VpqUSBz0Dqh0tmfnFQyw4yX1be-jflT_0c8SvjyOFGRFScoxcPLq8TrrmpFvgxhT3MqowvQ9butxX6_4mTc3831FnJ6tQIihlBLH4DY11k38x3BBPzb0s9iVcEn7iczWbT0VrSr4A6g1ltATAHNChdzGTqGrhSN8JGG_PPCjJnHY_edaCmcPrUg' \
           --header 'Content-Type: application/json'
         ```
    name: SCIM
  - description: >
      The Object Query API contains GET operations that allow you to query
      objects in your Zuora tenant in an efficient, consistent, and flexible
      manner.


      With the `expand[]` and `filter[]` query parameters, you have the
      flexibility to retrieve related object information in a single call and
      define the returned response that best suits your needs.

      You can also use the `fields[]` query parameter to define which fields are
      returned in the response for a given object.

      The `sort[]` query parameter allows you to sort the results in ascending
      or descending order based on the specified field.


      These parameters are case-insensitive matching.


      For general Object Queries limitations and comprehensive introduction to
      these query parameters, see [Expand, filter, fields, and
      sort](https://developer.zuora.com/docs/guides/expand-filter-fields-sort/).


      For filterable, expandable, and sortable fields on each object, refer to
      the Query Parameters section for each API operation.
    name: Object Queries
  - description: >
      Use operations to generate invoices and credit memos, collect payments for
      posted invoices, and generate previews of future invoice items for
      customer accounts.
    name: Operations
  - description: >
      Orders are contractual agreements between merchants and customers. 


      You can create multiple subscriptions and subscription amendments at once
      in a single order. All the operations on subscriptions in orders are done
      by order actions. 

      You can also create order line items to support your non-subscription
      based business models. 


      Zuora calculates order delta metrics when orders take place. You can
      retrieve order delta metrics and measure billed and unbilled amounts by
      order.


      For more information about Orders, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_accounts%2C_subscriptions%2C_and_non-subscription_transactions/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
      target="_blank">Overview Of Orders</a>. 

      To learn how orders interacts with billing accounts, subscriptions, and
      product catalog, see [Zuora object
      model](https://developer.zuora.com/v1-api-reference/object-model/).
    name: Orders
  - description: >
      You need to have the
      [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders)
      or [Orders
      Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization)
      feature enabled to use this API.
    name: Order Actions
  - description: >
      Use order line item to launch non-subscription and unified monetization
      business models in Zuora, in addition to subscription business models.

      For more information about order line items, see <a
      href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items"
      target="_blank">Order Line Items</a>.
    name: Order Line Items
  - description: >
      Use payment gateways to pass authorization, payments, and settlement data
      securely to and from the merchant's website to the merchant's processor. 


      For more information about payment gateways, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways"
      target="_blank">Payment Gateways</a>.
    name: Payment Gateways
  - description: >
      Gateway reconciliation is the process of verifying that the electronic
      payment and refund transactions processed in Zuora match the transactions
      reported by the gateway. 

      For example, if Zuora processed 200 transactions through a gateway, you
      should see the same number of transactions on the gateway's reconciliation
      report, sometimes also called the settlement report.


      You can complete the following Gateway Reconciliation tasks through API:

      - [Settle a
      payment](https://developer.zuora.com/api-references/api/operation/POST_SettlePayment/)

      - [Reject a
      payment](https://developer.zuora.com/api-references/api/operation/POST_RejectPayment/)

      - [Reverse a
      payment](https://developer.zuora.com/api-references/api/operation/POST_ReversePayment/)

      - [Reconcile a
      refund](https://developer.zuora.com/api-references/api/operation/POST_ReconcileRefund/)
    name: Payment Gateway Reconciliation
  - description: >
      A Payment Method Snapshot is a copy of the particular Payment Method used
      in a transaction. If the Payment Method is deleted, the Snapshot continues
      to retain the data used in each of the past transactions. 

      As such, the Snapshot helps with display of historical transactions,
      integrations to external systems, and reporting.
    name: Payment Method Snapshots
  - description: >
      The PaymentMethodTransactionLog object contains payment method transaction
      log data.


      You can use the [CRUD: Retrieve a payment method transaction
      log](https://developer.zuora.com/v1-api-reference/api/operation/Object_GETPaymentMethodTransactionLog/)
      operation to export such data.
    name: Payment Method Transaction Logs
  - description: >
      Payment methods represents payment method details associated with a
      customer account.
    name: Payment Methods
  - description: >
      Zuora Payment Method Updater (PMU) enables merchants to automatically
      incorporate changes made to a customer's credit cards. For more
      information about Zuora PMU, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Method_Updater"
      target="_blank">Payment Method Updater</a>.
    name: Payment Method Updater
  - description: >
      Use payment runs to collect payments using electronic payment methods, for
      example, credit cards and ACH.

      For more information about payment runs, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/K_Payment_Operations/CA_Payment_Runs/A_Introduction_to_Payment_Runs"
      target="_blank">Payment Runs</a>.
    name: Payment Runs
  - description: >
      Payment profiles enable payment flexibility for subscribers by allowing
      payment methods to be associated with specific subscriptions. 


      To learn more about the configuration and usage of Payment Profiles, see
      <a
      href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/Payment_Profiles"
      target="_blank">Payment Profiles</a>.  
    name: Payment Profiles
  - 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>.
    name: Payment Schedules
  - description: >
      Use payment transaction logs to export logs of all transactions from Zuora
      to the Gateway for Payments.
    name: Payment Transaction Logs
  - description: >
      The Delayed Capture feature allows you to authorize the availability of
      funds for a transaction but delay the capture of funds until a later time.


      You can use the [Create
      authorization](https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/)
      operation to authorize a payment amount before capturing the payment. 

      Subsequently, you can use [Create a
      payment](https://developer.zuora.com/api-references/api/operation/POST_CreatePayment)
      or [Create an
      order](https://developer.zuora.com/api-references/api/operation/POST_Order/)
      to capture the authorized funds, or use [Cancel
      authorization](https://developer.zuora.com/api-references/api/operation/POST_CancelAuthorization)
      to cancel the authorization.
    name: Payment Authorization
  - description: >
      Use payments to process payments, for example, automate recurring
      payments, manage overpayments, and create refunds.

      For more information about payments, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/K_Payment_Operations"
      target="_blank">Payments</a>.
    name: Payments
  - description: >
      The Prepaid with Drawdown feature is a pricing model for consumption-based
      services, such as data storage. Under this model, customers pay upfront to
      receive a number of units, usually for a period of time like a month or a
      year. Then they consume against that prepayment balance in a
      use-it-or-lose-it fashion, with a possibility of topping up more units or
      being charged for any overage. This model strikes a balance between
      upfront commitment and the pure pay-as-you-go pricing models. For more
      information, see <a
      href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
      target="_blank">Prepaid with Drawdown</a>.
    name: Prepaid with Drawdown
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.

      For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"

      target="_blank">Commerce API</a>.



      Use product charge definitions to define the attributes that can determine

      the charge behavior, such as billing attributes, pricing attributes,
      taxation

      attributes, or accounting attributes.\n\nThe Product Charge Definition
      object

      is in the **Early Adopter** phase. We are actively soliciting feedback
      from

      a small set of early adopters before releasing it as generally available.
      If

      you are interested, please reach out to your CSM. 
    name: Product Charge Definitions
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.

      For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"

      target="_blank">Commerce API</a>.



      Use product rate plan definitions to reuse charges in different product

      rate plans. The Product Rate Plan Definition object is in the **Early
      Adopter**

      phase. We are actively soliciting feedback from a small set of early
      adopters

      before releasing it as generally available. If you are interested, please
      reach

      out to your CSM. 
    name: Product Rate Plan Definitions
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.

      For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"

      target="_blank">Commerce API</a>.



      To manage product rate plan charge tiers, use the [Product Rate Plan

      Charges](https://developer.zuora.com/api-references/api/tag/Product-Rate-Plan-Charges)

      operations instead to update the corresponding product rate plan charge
      with all

      the tiers.
    name: Product Rate Plan Charge Tiers
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.

      For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"

      target="_blank">Commerce API</a>.



      A product rate plan charge represents a charge model or a set of fees

      associated with a product rate plan, which is the part of a product that
      your

      customers subscribe to. Each product rate plan can have multiple product
      rate

      plan charges.



      Product rate plan charges can be of three types: one-time fees, recurring
      fees,

      and usage fees. For example, the $50 activation fee for the Topaz product
      rate

      plan is a one-time product rate plan charge.
    name: Product Rate Plan Charges
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.

      For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"

      target="_blank">Commerce API</a>.



      A product rate plan is the part of a product that your customers subscribe

      to. Each product can have multiple product rate plans, and each product
      rate plan

      can have multiple product rate plan charges, which are fees for products
      and their

      product rate plans.
    name: Product Rate Plans
  - description: >
      **Note** - The APIs in this section are legacy APIs. Zuora recommends
      using the newer, faster APIs for managing products and catalogs more
      efficiently instead.
       For more information, see our latest <a href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"
       target="_blank">Commerce API</a>.


       A product is an item or service that your company sells. In the subscription
       economy, a product is generally a service that your customers subscribe to rather
       than a physical item that they purchase one time. For example, customers subscribe
       to a service that provides them a car when and where they need a car rather than
       buying a car outright.


       A Product object contains all of the items in a specific product, especially product
       rate plans and product rate plan charges. Each Product object can have multiple
       rate plans, which in turn can each have multiple rate plan charges. Each rate
       plan charge can have multiple tiers. Taken together, all of these items create
       a single product.


       Customers subscribe to products that are in your product catalog. Product objects
       collectively compose your product catalog. You create your product catalog by
       creating products. As soon as you create your first product, you create your product
       catalog.
    name: Products
  - description: >
      A Ramp is a time container to associate with rate plan charges in your
      subscription. Inside the Ramp, you can further define a set of Ramp
      Intervals (time-based periods) where products or pricing can change. These
      periods are sub time containers to enable you to report out-of-the-box
      metrics based on Ramp Intervals.


      **Notes**: You must have both the Ramps feature and Orders feature enabled
      for your tenant to use the Ramps operations.


      For more information, see <a
      href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics"
      target="_blank">Ramps and Ramp Metrics</a>.
    name: Ramps
  - description: >
      A rate plan is part of a subscription or an amendment to a subscription,
      and it comes from a product rate plan. Like a product and its product rate
      plans, a subscription can have one or more rate plans. 

      Rate plans are sometimes called subscription rate plans. Rate plans that
      are part of an amendment are sometimes called amendment rate plans.


      Rate plans represent a price or a collection of prices for a service you
      sell. An individual rate plan contains all charges specific to a
      particular subscription.
    name: Rate Plans
  - description: >
      Zuora allows you to issue and track refunds on payments. Similar to
      external payments, users can enter external refunds to track refunds that
      have been performed outside of Zuora Payments (for example, by issuing a
      check). 

      In addition, you can make electronic refunds using our supported payment
      gateways, which will automatically refund money to the customer.
    name: Refunds
  - description: >
      If you are an <a
      href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
      target="_blank">Order to Revenue</a> user, you can use the Regenerate
      operations to regenerate transactions objects.     
    name: Regenerate
  - description: >
      The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource
      Sharing) enabled and therefore requires a digital signature. 


      You can use the [Generate an RSA
      signature](https://developer.zuora.com/v1-api-reference/api/operation/POST_RSASignatures/)
      operation to generate the required digital signature and token for a
      Payment Pages 2.0 form, then use the [Decrypt an RSA
      signature](https://developer.zuora.com/v1-api-reference/api/operation/POST_DecryptRSASignatures/)
      operation to decrypt the signature to validate the signature and key." 
    name: RSA Signatures
  - description: >
      You can create billing document sequence sets through the REST API or the
      Zuora UI, allowing distinct numbering sequences for billing documents,
      payments, and refunds. 


      To create a billing document sequence set through the Zuora UI, see <a
      href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Settings/Prefix_and_Numbering_Configuration_for_Billing_Documents/Create_Billing_Document_Sequence_Sets"
      target="_blank">Create Billing Document Sequence Sets</a> for more
      information.
    name: Sequence Sets
  - description: >
      The Setting API provides a central API for managing settings in your Zuora
      tenant.


      If you use Postman, you can import the Settings API endpoints as a
      collection into your Postman app and try out different requests to learn
      how the API works.

      You can sign up for a free account on the [Postman
      website](https://identity.getpostman.com/signup) and download the app in
      case you do not use Postman yet.
    name: Settings
  - description: >
      A light-weight API to sign up customers and subscribe. 


      You need to have the
      [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders)
      or [Orders
      Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization)
      feature enabled to use this API.
    name: Sign Up
  - description: >
      A subscription is a product or service that has recurring charges,

      such as a monthly flat fee or charges based on usage. Subscriptions can
      also include

      one-time charges, such as activation fees. Every subscription must be
      associated

      with an account. At least one active account must exist before any
      subscriptions

      can be created.



      For more information, see <a
      href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Subscriptions"

      target="_blank">Subscriptions</a>.
    name: Subscriptions
  - description: >
      An omnichannel subscription is a subscription originating from external
      and source systems, such as the Apple App Store, Google Play Store, and
      Roku Store. 


      To create, update, delete, or retrieve an omnichannel subscription, you
      must turn on the Omni-Channel Subscription feature. For more information,
      see <a
      href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/common-subscription-information/omni-channel-subscription"

      target="_blank">Omni-Channel Subscription</a>.  
    name: Omnichannel Subscriptions
  - description: >
      The change histories of single version subscriptions.


      **Note**: To access the change histories, you must turn on the following
      features:

        - <a href="https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders" target="_blank">Orders</a>
        
        - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Single_Version_Subscription" target="_blank">Single Version Subscription</a>
    name: Subscription Change History
  - description: >
      A summary journal entry is a summary of Zuora transaction amounts
      organized by accounting code and general ledger segments. A segment adds
      more reporting granularity through business dimensions, such as country or
      product. 


      For more information, see <a
      href="https://knowledgecenter.zuora.com/Billing/Finance/F_Summary_Journal_Entries/A_SJE_Introduction"
      target="_blank">Summary Journal Entries Introduction</a>
    name: Summary Journal Entries
  - description: >
      The Summary Statement feature provides a comprehensive overview of billing
      activities for each account using HTML templates that compile data like
      invoices, credit memos, payments, and more.  The associated APIs help
      automate the creation and management of these statements. See <a
      href="https://knowledgecenter.zuora.com/Zuora_Billing/Zuora_Billing_Reporting/Account_Summary_Statement"
      target="_blank">Account Summary Statements </a> for more information.
    name: Summary Statements
  - description: >
      The TaxationItem object is used to add a tax amount to an invoice item. In
      the typical use case, the tax amount that you specify in the object is
      calculated by <a
      href="https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax"
      target="_blank">Z-Tax</a> or a third-party tax engine such as <a
      href="https://knowledgecenter.zuora.com/Billing/Taxes/Direct_Avalara_Integration"
      target="_blank">Avalara</a> or <a
      href="https://knowledgecenter.zuora.com/Billing/Taxes/Additional_resources_on_taxes/AA_Connect_Tax_Engines"
      target="_blank">Connect tax engine</a>.


      Changes that you make with this object affect the product charges in your
      product catalog, but not the charges in existing subscriptions.
    name: Taxation Items
  - description: >
      Consumption of a billable service or resource (such as database storage
      space or bundles of emails sent) provides the basis for some charge models
      - simple usage, tiered pricing, or volume pricing. 

      To make this work, usage must be tracked in the system and usage charges
      must be calculated and invoiced. 

      Usage is always billed in arrears - for example, you might bill customers
      in February for their January usage. Usage can be billed on a recurring
      monthly, quarterly, semi-annual, or annual basis.


      ### Limitations for dynamic pricing usage charges  


      Legacy Billing Usage APIs (for example, "Upload a usage file" and the
      "CRUD: Create/Update/Delete a   usage record" operations) do not support
      usage records that are associated with a dynamic pricing   usage charge.
      When a usage record is associated with a product rate plan charge that is
      configured   for dynamic pricing, these endpoints reject the request and
      do not create, update, or delete the record. For dynamic pricing usage
      charges, usage events must be ingested through Mediation  (for example,
      via Meters and the Rating processor) rather than through the legacy
      Billing usage upload APIs. 


      For more information about working with usage data, see <a
      href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/usage-billing---prepayment-credits-and-commitment"
      target="_blank">Usage</a>.
    name: Usage
  - description: >
      A workflow is a sequence of tasks that are performed based on predefined
      logic. A workflow improves efficiency and reduces errors by automating a
      series of complex tasks that otherwise need to be performed manually and
      repetitively.


      For more information, see <a
      href="https://knowledgecenter.zuora.com/Central_Platform/Workflow"
      target="_blank">Workflow</a>.
    name: Workflows
  - description: >
      **Note:** You can only use the operations in this section if you have the
      Billing - Revenue Integration feature enabled. See <a
      href="https://knowledgecenter.zuora.com/Zuora_Revenue/Billing_-_Revenue_Integration"
      target="_blank">Billing - Revenue Integration</a> for more information.

      The APIs in this section are legacy APIs. Zuora recommends using the
      newer, faster APIs for managing products and catalogs more efficiently
      instead. For more information, see our latest <a
      href="https://developer.zuora.com/v1-api-reference/api/tag/Commerce/"
      target="_blank">Commerce API</a>.
    name: Zuora Revenue Integration
paths:
  /test-environments:
    get:
      tags:
        - Test Environments
      summary: List all test environments
      operationId: getAllTestEnvironments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
      responses:
        '200':
          description: Successfully retrieved a list of Test Environment responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentArrayResponse'
        '400':
          description: Bad request
          content: {}
        '500':
          description: Internal Error
          content: {}
      description: |
        Use this operation to retrieves a list of all Test Environments. 
        It returns an ArrayResponse containing TestEnvironmentResponse objects, 
        representing the available Test Environments in the system. 

        ### User Access Permission

        You must be assigned the **Refresh Central Sandbox** permission to run 
        this operation.
  /test-environments/{id}:
    get:
      tags:
        - Test Environments
      summary: Retrieve a test environment response
      operationId: getTestEnvironment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved Test Environment response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentResponse'
        '404':
          description: The resource you were trying to reach is not found
          content: {}
        '500':
          description: Internal Error
          content: {}
      description: >
        Use this operation to retrieves a specific Test Environment by its
        unique identifier. 

        It returns a TestEnvironmentResponse object if the environment is found.
        If the specified 

        Test Environment does not exist, it returns a 404 error.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run 

        this operation.
  /test-environments/{id}/jobs:
    post:
      tags:
        - Test Environment Jobs
      summary: Create a test environment job
      operationId: createTestEnvironmentJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        description: jobRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '201':
          description: Successfully created a new Test Environment job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
        '403':
          description: Only one refresh can be performed during a set period
          content: {}
        '500':
          description: Internal Error
          content: {}
      x-codegen-request-body-name: jobRequest
      description: >
        Use this operation to create a new job for a specific Test Environment. 

        It handles HTTP POST requests to the /test-environments/{id}/jobs
        endpoint, 

        accepting a JobRequest object in the request body. Upon successful
        creation, 

        it returns a JobResponse object and sets the Location header to the
        polling 

        URL for the created job.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
    get:
      tags:
        - Test Environment Jobs
      summary: List all jobs of a test environment
      operationId: getAllJobsOfTestEnvironment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved a list of Test Environment job responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobArrayResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal Error
          content: {}
      description: |
        Use this operation to retrieve a list of job responses associated 
        with a specific Test Environment. It handles HTTP GET requests to 
        the /test-environments/{id}/jobs endpoint and returns an ArrayResponse 
        containing JobResponse objects. This method is documented in Swagger, 
        including possible responses for successful retrieval and bad requests.

        ### User Access Permission

        You must be assigned the **Refresh Central Sandbox** 
        permission to run this operation.
  /test-environments/{id}/jobs/{jobId}:
    get:
      tags:
        - Test Environment Jobs
      summary: Retrieve a job of a test environment
      operationId: getJobOfTestEnvironment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Test Environment Job ID
          in: path
          name: jobId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved a Test Environment job response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '404':
          description: The resource you were trying to reach was not found
          content: {}
        '500':
          description: Internal Error
          content: {}
      description: >
        Use this operation to retrieve a specific job associated 

        with a Test Environment by its unique job ID. It handles 

        HTTP GET requests to the /test-environments/{id}/jobs/{jobId} 

        endpoint and returns a JobResponse object if the job is found. 

        If the specified job does not exist, it returns a 404 error.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
  /test-environments/{id}/jobs/{jobId}/actions:
    post:
      tags:
        - Test Environment Jobs
      summary: Perform an action on a test environment job
      operationId: performActionOfJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Test Environment Job ID
          in: path
          name: jobId
          required: true
          schema:
            type: string
      requestBody:
        description: jobActionRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobActionRequest'
        required: true
      responses:
        '200':
          description: Successfully submitted Test Environment job action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '400':
          description: Bad request
          content: {}
        '404':
          description: The resource you were trying to reach is not found
          content: {}
        '500':
          description: Internal Error
          content: {}
      x-codegen-request-body-name: jobActionRequest
      description: >
        Use this operation to perform a specified action 

        on a Test Environment job. It handles HTTP POST 

        requests to the /test-environments/{id}/jobs/{jobId}/actions 

        endpoint, accepting a JobActionRequest object in the 

        request body. Upon successful execution, it returns a 

        JobResponse object reflecting the updated job state.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
  /test-environments/{id}/notifications:
    post:
      tags:
        - Test Environment Notifications
      summary: Create a test environment notification
      operationId: createTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        description: notificationRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestEnvironmentNotificationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '201':
          description: Successfully created a new Test Environment notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal Error
          content: {}
      x-codegen-request-body-name: notificationRequest
      description: >
        Use this operation to create a new notification 

        for a specific Test Environment. It handles HTTP 

        POST requests to the /test-environments/{id}/notifications 

        endpoint, accepting a TestEnvironmentNotificationRequest 

        object in the request body. Upon successful creation, 

        it returns a TestEnvironmentNotificationResponse object 

        and sets the Location header to the URL of the created 

        notification.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
    get:
      tags:
        - Test Environment Notifications
      summary: List all email notifications of a test environment
      operationId: getAllEmailNotificationOfTestEnv
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully fetched all notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationArrayResponse'
        '404':
          description: The resource you were trying to reach was not found
          content: {}
        '500':
          description: Internal Error
          content: {}
      description: >
        Use this operation to retrieve all notifications associated 

        with a specific Test Environment. It handles HTTP GET 

        requests to the /test-environments/{id}/notifications 

        endpoint and returns an ArrayResponse containing 

        TestEnvironmentNotificationResponse objects. 


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
  /test-environments/{id}/notifications/{notificationId}:
    get:
      tags:
        - Test Environment Notifications
      summary: Retrieve a notification response of a test environment
      operationId: getTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Test Environment Notification ID
          in: path
          name: notificationId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved a Test Environment notification response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '404':
          description: The resource you were trying to reach was not found
          content: {}
        '500':
          description: Internal Error
          content: {}
      description: >
        Use this operation to retrieve a specific notification associated 

        with a Test Environment by its unique notification ID. It handles 

        HTTP GET requests to the
        /test-environments/{id}/notifications/{notificationId} 

        endpoint and returns a TestEnvironmentNotificationResponse object 

        if the notification is found. If the specified notification does 

        not exist, it returns a 404 error.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
    patch:
      tags:
        - Test Environment Notifications
      summary: Update a test environment notification
      operationId: updateTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Test Environment Notification ID
          in: path
          name: notificationId
          required: true
          schema:
            type: string
      requestBody:
        description: notificationRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestEnvironmentNotificationRequest'
        required: true
      responses:
        '200':
          description: Successfully updated a Test Environment notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
        '500':
          description: Internal Error
          content: {}
      x-codegen-request-body-name: notificationRequest
      description: >
        Use this operation to update an existing notification 

        for a specific Test Environment. It handles HTTP PATCH 

        requests to the /test-environments/{id}/notifications/{notificationId} 

        endpoint, accepting a TestEnvironmentNotificationRequest 

        object in the request body. Upon successful update, it 

        returns a TestEnvironmentNotificationResponse object.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
    delete:
      tags:
        - Test Environment Notifications
      summary: Delete a notification of a test environment
      operationId: deleteTestEnvironmentNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - description: Test Environment ID
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Test Environment Notification ID
          in: path
          name: notificationId
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted a notification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        '404':
          description: The resource you were trying to reach is not found
          content: {}
        '500':
          description: Internal Error
          content: {}
      description: >
        Use this operation to delete a specific notification associated 

        with a Test Environment. It handles HTTP DELETE requests to the 

        /test-environments/{id}/notifications/{notificationId} endpoint 

        and returns a TestEnvironmentNotificationResponse object for the 

        deleted notification. If the specified notification does not exist, 

        it returns a 404 error.


        ### User Access Permission


        You must be assigned the **Refresh Central Sandbox** permission to run
        this operation.
  /oauth/token:
    post:
      security: []
      description: >
        Creates a bearer token that enables an OAuth client to authenticate with
        the Zuora REST API. The OAuth client must have been created using the
        Zuora UI. See
        [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/)
        for more information.


        **Note:** When using this operation, do not set any authentication
        headers such as `Authorization`, `apiAccessKeyId`, or
        `apiSecretAccessKey`.


        You should not use this operation to generate a large number of bearer
        tokens in a short period of time; each token should be used until it
        expires. If you receive a 429 Too Many Requests response when using this
        operation, reduce the frequency of requests. This endpoint is rate
        limited by IP address.


        For the rate limit information of authentication, see [Rate and
        concurrent request
        limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/).
      operationId: createToken
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - name: Zuora-Entity-Ids
          in: header
          required: false
          description: >
            An entity ID if you have <a
            href="https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity"
            target="_blank">Multi-entity</a> enabled. 


            The value must be a 36-character UUID that contains hyphens(`-`). 

            If your entity ID is not a valid UUID, convert it to a valid UUID
            before specifying this parameter.
          schema:
            type: string
            format: uuid
            example: 11e643f4-a3ee-8bad-b061-0025904c756d
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                client_id:
                  description: |
                    The Client ID of the OAuth client.
                  maxLength: 36
                  minLength: 36
                  type: string
                client_secret:
                  description: >
                    The Client Secret that was displayed when the OAuth client
                    was created.
                  maxLength: 42
                  type: string
                grant_type:
                  description: >
                    The OAuth grant type that will be used to generate the
                    token. The value of this parameter must be
                    `client_credentials`.
                  enum:
                    - client_credentials
                  type: string
              required:
                - client_id
                - client_secret
                - grant_type
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    access_token: c652cbc0ea384b9f81856a93a2a74538
                    expires_in: 3599
                    jti: c652cbc0ea384b9f81856a93a2a74539
                    scope: >-
                      user.7c4d5433dc234c369a01b9719ecd059f
                      entity.1a2b7a37-3e7d-4cb3-b0e2-883de9e766cc
                      entity.c92ed977-510c-4c48-9b51-8d5e848671e9
                      service.echo.read tenant.19
                    token_type: bearer
              schema:
                $ref: '#/components/schemas/tokenResponse'
          description: OK
          headers:
            X-RateLimit-Limit-minute:
              description: >
                The rate limit of this operation, in requests per minute. See
                [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: >
                The number of requests that you may make in the next minute. See
                [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: integer
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '429':
          description: Too Many Requests
          headers:
            X-RateLimit-Limit-minute:
              description: >
                The rate limit of this operation, in requests per minute. See
                [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: >
                The number of requests that you may make in the next minute. See
                [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: integer
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an OAuth token
      tags:
        - OAuth
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d
            "client_id=b64e42ba-7e1a-4bc6-9146-5e1b420306b5" --data-urlencode
            "client_secret=dOFENLWU193EEoEsWjPZrcjLKVr5OrN1HC9Kqg" -d
            "grant_type=client_credentials" "https://rest.zuora.com/oauth/token"
  /v1/object/product:
    post:
      description: ''
      operationId: Object_POSTProduct
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyCreateProduct'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c93808457d787030157e03246ae5129
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Create a product'
      tags:
        - Products
  /v1/object/product/{id}:
    get:
      description: Retrieve a specific product.
      operationId: Object_GETProduct
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    CreatedById: 2c93808457d787030157e02e62af2097
                    CreatedDate: '2016-10-20T05:42:05.000+02:00'
                    Description: Create product via API_new
                    EffectiveEndDate: '2066-10-20'
                    EffectiveStartDate: '1966-10-20'
                    Id: 2c93808457d787030157e02e7be22210
                    Name: P_1476934925293_new
                    SKU: API-SKU1476934925293
                    UpdatedById: 2c93808457d787030157e02e62af2097
                    UpdatedDate: '2016-10-20T05:42:05.000+02:00'
              schema:
                $ref: '#/components/schemas/ProxyGetProduct'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a product'
      tags:
        - Products
    put:
      description: Updates a Product object.
      operationId: Object_PUTProduct
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyModifyProduct'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c93808457d787030157e02e7be22210
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Update a product'
      tags:
        - Products
    delete:
      description: Deletes a specific product.
      operationId: Object_DELETEProduct
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c93808457d787030157e02e7a22220e
                    success: true
              schema:
                $ref: '#/components/schemas/ProxyDeleteResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Delete a product'
      tags:
        - Products
  /v1/catalog/products:
    get:
      description: >
        Retrieves the entire product catalog, including all products, features,
        and their corresponding product rate plans, charges. Products are
        returned in reverse chronological order on the `UpdatedDate` field. 


        For each product, this operation returns a maximum of 300 product rate
        plans in the response. Across the returned product rate plans, up to 300
        product rate plan charges can be returned for each product. 
      operationId: GET_Catalog
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_catalog'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    products:
                      - category: Base Products
                        description: ''
                        effectiveEndDate: '2020-01-01'
                        effectiveStartDate: '2017-01-01'
                        id: 8a8082c45aa81b51015ad5a2d07d0e89
                        name: ABC
                        productNumber: PC-00000011
                        productRatePlans: >-
                          https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan
                        sku: SKU-00000987
                    success: true
              schema:
                $ref: '#/components/schemas/GETCatalogType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all products
      tags:
        - Catalog
  /v1/catalog/products/{product-key}:
    get:
      description: >
        Retrieves detailed information about a specific product, including
        information about its product rate plans and charges. 


        This operation returns a maximum of 300 product rate plans and 300
        product rate plan charges across all product rate plans in the response.
      operationId: GET_Product
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID, SKU, or product number of the product that you want
            to retrieve. For example, 8a808255575bdae4015774e9602e16fe,
            SKU-00000987, or PC-00000006.
          in: path
          name: product-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    category: Base Products
                    description: ''
                    effectiveEndDate: '2020-01-01'
                    effectiveStartDate: '2017-01-01'
                    id: 8a8082c45aa81b51015ad5a2d07d0e89
                    name: ABC
                    productNumber: PC-00000006
                    productRatePlans: >-
                      https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan
                    sku: SKU-00000987
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a product
      tags:
        - Catalog
  /v1/catalog-groups:
    post:
      description: >
        **Note**: This operation is in the Early Adopter phase. We are actively
        soliciting feedback from a small set of early adopters before releasing
        it as generally available. If you want to join this early adopter
        program, submit a request at [Zuora Global
        Support](http://support.zuora.com/).


        Creates a catalog group which groups a list of product rate plans.
      operationId: POST_CreateCatalogGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTCatalogGroupRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    catalogGroupNumber: CG-00000001
                    description: some description
                    id: 4028e5ab7f1b600c017f1b7a5e8901d2
                    name: test
                    productRatePlans:
                      - description: null
                        effectiveEndDate: '2023-02-21'
                        effectiveStartDate: '2022-02-21'
                        grade: 1
                        id: 4028e5ab7f1b600c017f1b787d5d01cf
                        name: '222'
                        status: Active
                    type: Grading
              schema:
                $ref: '#/components/schemas/CatalogGroupResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a catalog group
      tags:
        - Catalog Groups
    get:
      description: >
        **Note**: This operation is in the Early Adopter phase. We are actively
        soliciting feedback from a small set of early adopters before releasing
        it as generally available. If you want to join this early adopter
        program, submit a request at [Zuora Global
        Support](http://support.zuora.com/).


        Retrieves basic information about all catalog groups.
      operationId: GET_ListAllCatalogGroups
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    catalogGroups:
                      - catalogGroupNumber: CG-00000001
                        description: some description
                        id: 4028e5ab7f1b600c017f1b7a5e8901d2
                        name: test
                        productRatePlans:
                          - description: null
                            effectiveEndDate: '2023-02-21'
                            effectiveStartDate: '2022-02-21'
                            grade: 1
                            id: 4028e5ab7f1b600c017f1b787d5d01cf
                            name: '222'
                            status: Active
                        type: Grading
                    nextPage: false
              schema:
                $ref: '#/components/schemas/ListAllCatalogGroupsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all catalog groups
      tags:
        - Catalog Groups
  /v1/catalog-groups/{catalog-group-key}:
    get:
      description: >
        **Note**: This operation is in the Early Adopter phase. We are actively
        soliciting feedback from a small set of early adopters before releasing
        it as generally available. If you want to join this early adopter
        program, submit a request at [Zuora Global
        Support](http://support.zuora.com/).


        Retrieves basic information about a catalog group.
      operationId: GET_RetrieveCatalogGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique number or ID of the catalog group to be retrieved.
          in: path
          name: catalog-group-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    catalogGroupNumber: CG-00000001
                    description: some description
                    id: 4028e5ab7f1b600c017f1b7a5e8901d2
                    name: test
                    productRatePlans:
                      - description: null
                        effectiveEndDate: '2023-02-21'
                        effectiveStartDate: '2022-02-21'
                        grade: 1
                        id: 4028e5ab7f1b600c017f1b787d5d01cf
                        name: '222'
                        status: Active
                    type: Grading
              schema:
                $ref: '#/components/schemas/CatalogGroupResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a catalog group
      tags:
        - Catalog Groups
    put:
      description: >
        **Note**: This operation is in the Early Adopter phase. We are actively
        soliciting feedback from a small set of early adopters before releasing
        it as generally available. If you want to join this early adopter
        program, submit a request at [Zuora Global
        Support](http://support.zuora.com/).


        Updates a catalog group by its unique number or ID.


        ### Notes

        - It is best practice to only specify the fields that you want to change
        in the request body.

        - If you specify an empty value for a field in the request body, the
        corresponding field in the catalog group is emptied.

        - The catalog group type cannot be changed.
      operationId: PUT_UpdateCatalogGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique number or ID of the catalog group to be updated. 
          in: path
          name: catalog-group-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTCatalogGroup'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    catalogGroupNumber: CG-00000001
                    description: some description
                    id: 4028e5ab7f1b600c017f1b7a5e8901d2
                    name: test
                    productRatePlans:
                      - description: null
                        effectiveEndDate: '2023-02-21'
                        effectiveStartDate: '2022-02-21'
                        grade: 1
                        id: 4028e5ab7f1b600c017f1b787d5d01cf
                        name: '222'
                        status: Active
                    type: Grading
              schema:
                $ref: '#/components/schemas/CatalogGroupResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a catalog group
      tags:
        - Catalog Groups
    delete:
      description: >
        **Note**: This operation is in the Early Adopter phase. We are actively
        soliciting feedback from a small set of early adopters before releasing
        it as generally available. If you want to join this early adopter
        program, submit a request at [Zuora Global
        Support](http://support.zuora.com/).


        Deletes a catalog group.
      operationId: DELETE_CatalogGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique number or ID of the catalog group to be deleted.
          in: path
          name: catalog-group-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: 'true'
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a catalog group
      tags:
        - Catalog Groups
  /v1/products/{product-key}/product-rate-plans:
    get:
      description: >
        Retrieves information about all product rate plans of a specific
        product.
      operationId: GET_ProductRatePlans
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID or SKU of a product. For example,
            2c92c0f96487e16a016487f663c71a61 or SKU-00000987.
          in: path
          name: product-key
          required: true
          schema:
            type: string
        - description: >
            Specifies whether to include the product charge definitions of this
            rate plan in the response.


            **Note**: This parameter is applicable only if the Attribute Based
            Pricing feature is enabled. To access this feature, submit a request
            at <a href="https://support.zuora.com" target="_blank">Zuora Global
            Support</a>.
          in: query
          name: show-charge-definitions
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    productRatePlans:
                      - description: ''
                        effectiveEndDate: '2020-07-31'
                        effectiveStartDate: '2016-07-01'
                        grade: 3
                        id: 40289f466464127601646473d6f7000f
                        name: New Rate Plan
                        productRatePlanCharges:
                          - applyDiscountTo: null
                            billingDay: DefaultFromCustomer
                            billingPeriod: Month
                            billingPeriodAlignment: AlignToCharge
                            billingTiming: IN_ADVANCE
                            defaultQuantity: null
                            description: ''
                            discountClass: null
                            discountLevel: null
                            endDateCondition: Subscription_End
                            financeInformation:
                              deferredRevenueAccountingCode: ''
                              deferredRevenueAccountingCodeType: null
                              recognizedRevenueAccountingCode: ''
                              recognizedRevenueAccountingCodeType: null
                            id: 40289f4664641276016464740dd0001c
                            listPriceBase: Per_Billing_Period
                            model: FlatFee
                            name: New Component
                            numberOfPeriods: null
                            overageCalculationOption: null
                            overageUnusedUnitsCreditOption: null
                            priceChangeOption: null
                            priceIncreasePercentage: null
                            pricing:
                              - currency: USD
                                discountAmount: null
                                discountPercentage: null
                                includedUnits: null
                                overagePrice: null
                                price: 100
                                tiers: null
                            pricingSummary:
                              - USD100
                            productChargeDefinitions: >-
                              https://rest.zuora.com/v1/product-charge-definitions?charge=8a80808e8aaf3b0a018aaf3f2beb022b&rateplan=8a80808e8aaf3b0a018aaf3ed4cf021e
                            productDiscountApplyDetails: []
                            productRatePlanChargeNumber: PRPC-00000001
                            revRecCode: ''
                            revRecTriggerCondition: ContractEffectiveDate
                            revenueRecognitionRuleName: Recognize upon invoicing
                            smoothingModel: null
                            specificBillingPeriod: null
                            specificListPriceBase: null
                            taxCode: ''
                            taxMode: null
                            taxable: false
                            triggerEvent: ContractEffective
                            type: Recurring
                            unusedIncludedUnitPrice: null
                            uom: null
                            upToPeriods: null
                            upToPeriodsType: null
                            usageRecordRatingOption: null
                            useDiscountSpecificAccountingCode: null
                            useTenantDefaultForPriceChange: null
                        productRatePlanNumber: PRP-00000001
                        status: Active
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductRatePlansResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all product rate plans of a product
      tags:
        - Product Rate Plans
  /v1/product-rate-plans/{id}:
    get:
      description: |
        Retrieves a product rate plan by its ID.
      operationId: GET_ProductRatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID, external ID, or the natural key of the product rate plan to
            be retrieved. For example, `402888e67f8b3a68017f8bbb2a06062d`,
            `Apple0001`, or `PRP-00000008`.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    description: ''
                    effectiveEndDate: '2032-02-01'
                    effectiveStartDate: '2012-02-01'
                    externalIdSourceSystem: apple
                    externallyManagedPlanIds:
                      - Apple0001
                      - Apple0002
                      - Google0003
                    grade: 3
                    id: 402888e67f8b3a68017f8bbb2a06062d
                    name: New Rate Plan Change
                    productRatePlanNumber: PRP-00000008
                    status: Active
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductRatePlanWithExternalIdResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a product rate plan by ID
      tags:
        - Product Rate Plans
  /v1/product-rate-plans/external-id/{id}:
    get:
      description: >
        Retrieves information about one or multiple product rate plans by
        external ID.
      operationId: GET_ProductRatePlansByExternalID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The external ID of the product rate plan to be retrieved. For
            example, `Apple0001`.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    productRatePlans:
                      - id: 2c989020823f450c01823fef40421eb6
                        status: Active
                        name: My rate plan - Monthly Basic
                        description: ''
                        effectiveStartDate: '2024-01-01'
                        effectiveEndDate: '2026-01-01'
                        externalIdSourceSystem: apple
                        externallyManagedPlanIds:
                          - zuora-us-monthly-basic
                        productRatePlanNumber: 1001
              schema:
                $ref: >-
                  #/components/schemas/GETProductRatePlanWithExternalIdMultiResponse
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List product rate plans by external ID
      tags:
        - Product Rate Plans
  /v1/object/product-rate-plan:
    post:
      description: |
        Retrieves a product rate plan.
      operationId: Object_POSTProductRatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyCreateProductRatePlan'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c93808457d787030157e0324735512b
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Create a product rate plan'
      tags:
        - Product Rate Plans
  /v1/object/product-rate-plan/{id}:
    get:
      description: |
        Retrieves a product rate plan.
      operationId: Object_GETProductRatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    CreatedById: 2c93808457d787030157e02d84c116d5
                    CreatedDate: '2016-10-20T05:41:09.000+02:00'
                    Description: Test create product rateplan via API
                    EffectiveEndDate: '2066-10-20'
                    EffectiveStartDate: '1966-10-20'
                    Grade: 3
                    Id: 2c93808457d787030157e02da0d91852
                    Name: ProductRatePlan1476934869186_new
                    ProductId: 2c93808457d787030157e02da0231850
                    UpdatedById: 2c93808457d787030157e02d84c116d5
                    UpdatedDate: '2016-10-20T05:41:09.000+02:00'
              schema:
                $ref: '#/components/schemas/ProxyGetProductRatePlan'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a product rate plan'
      tags:
        - Product Rate Plans
    put:
      description: |
        Updates a product rate plan.
      operationId: Object_PUTProductRatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyModifyProductRatePlan'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c93808457d787030157e02da0d91852
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Update a product rate plan'
      tags:
        - Product Rate Plans
    delete:
      description: |
        Deletes a product rate plan.
      operationId: Object_DELETEProductRatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c93808457d787030157e02d9dde184f
                    success: true
              schema:
                $ref: '#/components/schemas/ProxyDeleteResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Delete a product rate plan'
      tags:
        - Product Rate Plans
  /v1/product-rateplan-definitions:
    post:
      description: >
        Creates a product rate plan definition to use a charge in a product rate
        plan.


        In the request, you must specify either the unique ID or number of both
        the charge and the product rate plan to add the specified charge to a
        specific rate plan.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: POST_CreateProductRatePlanDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTRatePlanDefinitionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c9890f78aba5c16018ababa00120019
                    success: true
              schema:
                $ref: '#/components/schemas/POSTRatePlanDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a product rate plan definition
      tags:
        - Product Rate Plan Definitions
    get:
      description: >
        Retrieves basic information about the product rate plan definitions for
        a product rate plan. 


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: GET_RetrieveProductRatePlanDefinitions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique number or ID of the charge for which the product rate
            plan definitions are to be retrieved.
          in: query
          name: charge
          required: false
          schema:
            type: string
        - description: >
            The unique number or ID of the product rate plan for which the
            product rate plan definitions are to be retrieved.
          in: query
          name: rateplan
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    productRatePlanDefinitions:
                      - id: 2c9890f78b212d76018b218993c9005c
                        productRatePlanChargeId: 2c9890f78aba5c16018ababa00120019
                        productRatePlanChargeName: New Component
                        productRatePlanChargeNumber: PRPC-NEW-00000175
                        productRatePlanId: 2c9890678b1ca909018b1caea5c30000
                        productRatePlanName: New Rate Plan2
                        productRatePlanNumber: PRP-NEW-00000353
                      - id: 2c9890f78b212d76018b21742683005a
                        productRatePlanChargeId: 2c9890f78b212d76018b2174263c004a
                        productRatePlanChargeName: API_Usage_Tiered-multi
                        productRatePlanChargeNumber: PRPC-NEW-00000246
                        productRatePlanId: 2c9890678b1ca909018b1caea5c30000
                        productRatePlanName: New Rate Plan2
                        productRatePlanNumber: PRP-NEW-00000353
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductRatePlanDefinitionsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List product rate plan definitions
      tags:
        - Product Rate Plan Definitions
  /v1/product-rateplan-definitions/{product-rateplan-definition-key}:
    get:
      description: >
        Retrieves basic information about a product rate plan definition.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: GET_RetrieveProductRatePlanDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: |
            The unique ID of the product rate plan definition to be retrieved.
          in: path
          name: product-rateplan-definition-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c9890f78b212d76018b21937228005d
                    productRatePlanChargeId: 2c9890e489f227bd0189f22f3482001f
                    productRatePlanChargeName: Per Unit
                    productRatePlanChargeNumber: null
                    productRatePlanId: 2c9890678b1ca909018b1caea5c30000
                    productRatePlanName: New Rate Plan2
                    productRatePlanNumber: PRP-NEW-00000353
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductRatePlanDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a product rate plan definition
      tags:
        - Product Rate Plan Definitions
    delete:
      description: >
        Deletes a product rate plan definition.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: DELETE_ProductRatePlanDefnition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: |
            The unique ID of the product rate plan definition to be deleted.
          in: path
          name: product-rateplan-definition-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a product rate plan definition
      tags:
        - Product Rate Plan Definitions
  /v1/product-rate-plan-charges/{product-rate-plan-charge-key}:
    get:
      description: |
        Retrieves basic information about a product rate plan charge.
      operationId: GET_RetrieveProductRatePlanCharge
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique number or ID of the product rate plan charge to be
            retrieved.
          in: path
          name: product-rate-plan-charge-key
          required: true
          schema:
            type: string
        - description: >
            Specifies whether to include the product charge definitions of this
            charge in the response.


            **Note**: This parameter is applicable only if the Attribute-based
            Pricing feature is enabled. The Attribute-based Pricing feature in
            the **Early Adopter** phase. 

            We are actively soliciting feedback from a small set of early
            adopters. If you are interested, please reach out to your CSM.
          in: query
          name: show-charge-definitions
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: edca018c566983fa11f6d38381b10000
                    name: Attribute based pricing charge with formula
                    type: Recurring
                    model: FlatFee
                    uom: null
                    pricingSummary:
                      - USD60
                    pricing:
                      - currency: USD
                        price: 60
                        tiers: null
                        includedUnits: null
                        overagePrice: null
                        discountPercentage: null
                        discountAmount: null
                    defaultQuantity: null
                    applyDiscountTo: null
                    discountLevel: null
                    discountClass: null
                    applyToBillingPeriodPartially: false
                    productDiscountApplyDetails: []
                    endDateCondition: Subscription_End
                    upToPeriods: null
                    upToPeriodsType: null
                    billingDay: DefaultFromCustomer
                    listPriceBase: Per_Billing_Period
                    specificListPriceBase: null
                    billingTiming: IN_ADVANCE
                    ratingGroup: null
                    billingPeriod: Month
                    billingPeriodAlignment: AlignToCharge
                    specificBillingPeriod: null
                    smoothingModel: null
                    numberOfPeriods: null
                    overageCalculationOption: null
                    overageUnusedUnitsCreditOption: null
                    unusedIncludedUnitPrice: null
                    usageRecordRatingOption: null
                    priceChangeOption: null
                    priceIncreasePercentage: null
                    useTenantDefaultForPriceChange: true
                    taxable: false
                    taxCode: ''
                    taxMode: null
                    isPrepaid: false
                    prepaidOperationType: null
                    prepaidUom: null
                    prepaidQuantity: null
                    prepaidTotalQuantity: null
                    validityPeriodType: SUBSCRIPTION_TERM
                    drawdownRate: null
                    drawdownUom: null
                    creditOption: TimeBased
                    isRollover: false
                    rolloverPeriods: 0
                    rolloverPeriodLength: 0
                    rolloverApply: ApplyLast
                    triggerEvent: ContractEffective
                    description: ''
                    revRecCode: null
                    revRecTriggerCondition: null
                    revenueRecognitionRuleName: Recognize upon invoicing
                    useDiscountSpecificAccountingCode: null
                    excludeItemBookingFromRevenueAccounting: false
                    excludeItemBillingFromRevenueAccounting: false
                    financeInformation:
                      deferredRevenueAccountingCode: ''
                      deferredRevenueAccountingCodeType: null
                      recognizedRevenueAccountingCode: ''
                      recognizedRevenueAccountingCodeType: null
                      accountsReceivableAccountingCode: Accounts Receivable
                      accountsReceivableAccountingCodeType: AccountsReceivable
                      contractAssetAccountingCode: null
                      contractAssetAccountingCodeType: null
                      contractLiabilityAccountingCode: null
                      contractLiabilityAccountingCodeType: null
                      adjustmentLiabilityAccountingCode: null
                      adjustmentLiabilityAccountingCodeType: null
                      unbilledReceivablesAccountingCode: null
                      unbilledReceivablesAccountingCodeType: null
                      adjustmentRevenueAccountingCode: null
                      adjustmentRevenueAccountingCodeType: null
                      contractRecognizedRevenueAccountingCode: null
                      contractRecognizedRevenueAccountingCodeType: null
                    deliverySchedule: null
                    isStackedDiscount: false
                    productRatePlanChargeNumber: null
                    formula: >-
                      lookup("soldToRegion__c" = fieldLookup("subscription",
                      "soldToRegion__c"))
                    productChargeDefinitions: >-
                      https://rest-staging2.zuora.com/apps/v1/product-charge-definitions?charge=edca018c566983fa11f6d38381b10000
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductRatePlanChargeResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Retrieve a product rate plan charge
      tags:
        - Product Rate Plan Charges
  /v1/object/product-rate-plan-charge:
    post:
      description: >
        Creates a product rate plan charge for a specified rate plan charge. 


        Product rate plan charges can be of three types, one-time fees,
        recurring fees, and usage fees. 
      operationId: Object_POSTProductRatePlanCharge
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyCreateProductRatePlanCharge'
            examples:
              valid_per_specific_months:
                summary: SpecificListPriceBase at upper bound example
                value:
                  Name: Maximum Specific List Price Base Charge
                  Description: Charge with maximum specific list price base
                  ChargeModel: Flat Fee Pricing
                  ChargeType: Recurring
                  ProductRatePlanId: '{YourProductRatePlanId}'
                  BillCycleType: DefaultFromCustomer
                  BillingPeriod: Month
                  TriggerEvent: ContractEffective
                  ListPriceBase: Per Specific Months
                  SpecificListPriceBase: 120
                  ProductRatePlanChargeTierData:
                    ProductRatePlanChargeTier:
                      - Price: 99.99
                  UseDiscountSpecificAccountingCode: false
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c93808457d787030157e03197714910
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Create a product rate plan charge'
      tags:
        - Product Rate Plan Charges
  /v1/object/product-rate-plan-charge/{id}:
    get:
      description: Retrieves a specific product rate plan charge.
      operationId: Object_GETProductRatePlanCharge
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: >
            The unique ID of a product rate plan charge to be retrieved. For
            example, 2c93808457d787030157e031fcd34e19.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    AccountingCode: name_1476935155610
                    BillCycleDay: 1
                    BillCycleType: DefaultFromCustomer
                    BillingPeriod: Month
                    BillingPeriodAlignment: AlignToCharge
                    BillingTiming: In Advance
                    ChargeModel: Flat Fee Pricing
                    ChargeType: Recurring
                    CreatedById: 2c93808457d787030157e031dd264c85
                    CreatedDate: '2016-10-20T05:45:55.000+02:00'
                    DefaultQuantity: 1
                    DeferredRevenueAccount: name_1476935155610
                    Description: Recurring Flat Fee Pricing
                    EndDateCondition: SubscriptionEnd
                    Id: 2c93808457d787030157e032002b4e21
                    IncludedUnits: 0
                    LegacyRevenueReporting: false
                    ListPriceBase: Per Billing Period
                    Name: Recurring_Flat Fee Pricing1476935155610
                    NumberOfPeriod: 1
                    OverageCalculationOption: EndOfSmoothingPeriod
                    OverageUnusedUnitsCreditOption: NoCredit
                    PriceChangeOption: NoChange
                    PriceIncreasePercentage: 0
                    ProductRatePlanId: 2c93808457d787030157e031ff054e1e
                    RecognizedRevenueAccount: name_1476935155610
                    RevenueRecognitionRuleName: Recognize upon invoicing
                    Taxable: false
                    TriggerEvent: ContractEffective
                    UpToPeriodsType: Billing Periods
                    UpdatedById: 2c93808457d787030157e031dd264c85
                    UpdatedDate: '2016-10-20T05:45:55.000+02:00'
                    UseTenantDefaultForPriceChange: true
                    Formula: ''
              schema:
                $ref: '#/components/schemas/ProxyGetProductRatePlanCharge'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a product rate plan charge'
      tags:
        - Product Rate Plan Charges
    put:
      description: |
        Updates the information about a product rate plan charge.
      operationId: Object_PUTProductRatePlanCharge
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - description: >
            The unique ID of the product rate plan charge to be updated. For
            example, 2c93808457d787030157e031fcd34e19.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyModifyProductRatePlanCharge'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c93808457d787030157e03197714910
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Update a product rate plan charge'
      tags:
        - Product Rate Plan Charges
    delete:
      description: |
        Deletes a product rate plan charge.
      operationId: Object_DELETEProductRatePlanCharge
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The unique ID of the product rate plan charge to be deleted. For
            example, 2c93808457d787030157e031fcd34e19.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c93808457d787030157e031fcd34e19
                    success: true
              schema:
                $ref: '#/components/schemas/ProxyDeleteResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Delete a product rate plan charge'
      tags:
        - Product Rate Plan Charges
  /v1/product-charge-definitions:
    post:
      description: >
        Creates a product charge definition for a charge. You can create as many
        product charge definitions as needed for one charge.


        In the request, you must specify the unique ID or number of the charge
        for which this charge definition is to be created. 

        The ID or number of a product rate plan is optional.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
           
      operationId: POST_CreateProductChargeDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTChargeDefinitionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    chargeDefinitionId: 8a90988c8b177a24018b17857411002a
                    chargeDefinitionNumber: CD-00002089
                    success: true
              schema:
                $ref: '#/components/schemas/POSTChargeDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a product charge definition
      tags:
        - Product Charge Definitions
    get:
      description: >
        Retrieves basic information about the product charge definitions. 


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: GET_RetrieveProductChargeDefinitions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique number or ID of the charge for which the product charge
            definitions are to be retrieved.
          in: query
          name: charge
          required: false
          schema:
            type: string
        - description: >
            The unique number or ID of the product rate plan for which the
            product charge definitions are to be retrieved.
          in: query
          name: rateplan
          required: false
          schema:
            type: string
        - description: >
            The flag that controls whether the response will merge the default
            charge definition fields for those fields that are not overridden.
          in: query
          name: hide-inherited-values
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    chargeDefinitions:
                      - applyDiscountTo: null
                        billingDay: DefaultFromCustomer
                        billingPeriod: Month
                        billingPeriodAlignment: AlignToCharge
                        billingTiming: IN_ADVANCE
                        chargeModel: FlatFee
                        defaultQuantity: 1
                        deliverySchedule: null
                        description: ''
                        discountClass: null
                        discountLevel: null
                        effectiveEndDate: '2023-10-13 09:00:00'
                        effectiveStartDate: '2022-10-07 09:00:00'
                        endDateCondition: Subscription_End
                        financeInformation:
                          accountsReceivableAccountingCode: null
                          accountsReceivableAccountingCodeType: null
                          deferredRevenueAccountingCode: ''
                          deferredRevenueAccountingCodeType: null
                          recognizedRevenueAccountingCode: ''
                          recognizedRevenueAccountingCodeType: null
                        isDefault: true
                        isStackedDiscount: false
                        listPriceBase: Per_Billing_Period
                        numberOfPeriods: null
                        overageCalculationOption: null
                        overageUnusedUnitsCreditOption: null
                        priceChangeOption: null
                        priceIncreasePercentage: null
                        prices:
                          - currency: EUR
                            price: 10
                          - currency: JPY
                            price: 20
                          - currency: USD
                            price: 25
                        productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
                        productChargeDefinitionNumber: CD-00000201
                        productDiscountApplyDetails: []
                        productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
                        productRatePlanChargeNumber: null
                        productRatePlanId: null
                        productRatePlanName: null
                        productRatePlanNumber: null
                        ratingGroup: null
                        revRecCode: null
                        revRecTriggerCondition: null
                        revenueRecognitionRuleName: Recognize upon invoicing
                        smoothingModel: null
                        specificBillingPeriod: null
                        specificListPriceBase: null
                        taxCode: ''
                        taxMode: null
                        taxable: false
                        term: null
                        termPeriodType: null
                        termType: null
                        triggerEvent: ContractEffective
                        uom: null
                        upToPeriods: null
                        upToPeriodsType: null
                        usageRecordRatingOption: null
                        useDiscountSpecificAccountingCode: null
                        useTenantDefaultForPriceChange: true
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List product charge definitions
      tags:
        - Product Charge Definitions
  /v1/product-charge-definitions/bulk:
    post:
      description: >
        Bulk creates product charge definitions for a charge. You can create up
        to 1000 product charge definitions at a given time for a specific
        charge.


        In the request, you must specify the unique ID or number of the charge
        for which this charge definition is to be created. 

        The ID or number of a product rate plan is optional.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: POST_CreateProductChargeDefinitionBulk
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTChargeDefinitionRequestBulk'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    summary:
                      successCount: 1
                      failureCount: 0
                      failures: []
                    results:
                      - chargeDefinitionId: 8a9084f99325571d01932a15d64a3a1b
                        chargeDefinitionNumber: CD-00052014
                        success: true
                    success: true
              schema:
                $ref: '#/components/schemas/POSTChargeDefinitionBulkResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create product charge definitions
      tags:
        - Product Charge Definitions
    put:
      description: >
        Bulk updates multiple product charge definitions.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: PUT_UpdateProductChargeDefinitionBulk
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTProductChargeDefinitionBulkRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    chargeDefinitions:
                      - applyDiscountTo: null
                        billingDay: DefaultFromCustomer
                        billingPeriod: Month
                        billingPeriodAlignment: AlignToCharge
                        billingTiming: IN_ADVANCE
                        chargeModel: FlatFee
                        defaultQuantity: 1
                        deliverySchedule: null
                        description: ''
                        discountClass: null
                        discountLevel: null
                        endDateCondition: Subscription_End
                        financeInformation:
                          accountsReceivableAccountingCode: null
                          accountsReceivableAccountingCodeType: null
                          deferredRevenueAccountingCode: ''
                          deferredRevenueAccountingCodeType: null
                          recognizedRevenueAccountingCode: ''
                          recognizedRevenueAccountingCodeType: null
                        isDefault: true
                        isStackedDiscount: false
                        listPriceBase: Per_Billing_Period
                        numberOfPeriods: null
                        overageCalculationOption: null
                        overageUnusedUnitsCreditOption: null
                        priceChangeOption: null
                        priceIncreasePercentage: null
                        prices:
                          - currency: EUR
                            price: 10
                          - currency: JPY
                            price: 20
                          - currency: USD
                            price: 25
                        productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
                        productChargeDefinitionNumber: CD-00000201
                        productDiscountApplyDetails: []
                        productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
                        productRatePlanChargeNumber: null
                        productRatePlanId: null
                        productRatePlanName: null
                        productRatePlanNumber: null
                        ratingGroup: null
                        revRecCode: null
                        revRecTriggerCondition: null
                        revenueRecognitionRuleName: Recognize upon invoicing
                        smoothingModel: null
                        specificBillingPeriod: null
                        specificListPriceBase: null
                        taxCode: ''
                        taxMode: null
                        taxable: false
                        term: null
                        termPeriodType: null
                        termType: null
                        triggerEvent: ContractEffective
                        uom: null
                        upToPeriods: null
                        upToPeriodsType: null
                        usageRecordRatingOption: null
                        useDiscountSpecificAccountingCode: null
                        useTenantDefaultForPriceChange: true
                    success: true
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update product charge definitions
      tags:
        - Product Charge Definitions
  /v1/product-charge-definitions/{product-charge-definition-key}:
    get:
      description: >
        Retrieves basic information about a product charge definition.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: GET_RetrieveProductChargeDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique number or ID of the product charge definition to be
            retrieved.
          in: path
          name: product-charge-definition-key
          required: true
          schema:
            type: string
        - description: >
            The flag that controls whether the response will merge the default
            charge definition fields for those fields that are not overridden.
          in: query
          name: hide-inherited-values
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    applyDiscountTo: null
                    billingDay: DefaultFromCustomer
                    billingPeriod: Month
                    billingPeriodAlignment: AlignToCharge
                    billingTiming: IN_ADVANCE
                    chargeModel: FlatFee
                    defaultQuantity: 1
                    deliverySchedule: null
                    description: ''
                    discountClass: null
                    discountLevel: null
                    effectiveEndDate: '2023-10-13 09:00:00'
                    effectiveStartDate: '2022-10-07 09:00:00'
                    endDateCondition: Subscription_End
                    financeInformation:
                      accountsReceivableAccountingCode: null
                      accountsReceivableAccountingCodeType: null
                      deferredRevenueAccountingCode: ''
                      deferredRevenueAccountingCodeType: null
                      recognizedRevenueAccountingCode: ''
                      recognizedRevenueAccountingCodeType: null
                    isDefault: true
                    isStackedDiscount: false
                    listPriceBase: Per_Billing_Period
                    numberOfPeriods: null
                    overageCalculationOption: null
                    overageUnusedUnitsCreditOption: null
                    priceChangeOption: null
                    priceIncreasePercentage: null
                    prices:
                      - currency: EUR
                        price: 10
                      - currency: JPY
                        price: 20
                      - currency: USD
                        price: 25
                    productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
                    productChargeDefinitionNumber: CD-00000201
                    productDiscountApplyDetails: []
                    productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
                    productRatePlanChargeNumber: null
                    productRatePlanId: null
                    productRatePlanName: null
                    productRatePlanNumber: null
                    ratingGroup: null
                    revRecCode: null
                    revRecTriggerCondition: null
                    revenueRecognitionRuleName: Recognize upon invoicing
                    smoothingModel: null
                    specificBillingPeriod: null
                    specificListPriceBase: null
                    success: true
                    taxCode: ''
                    taxMode: null
                    taxable: false
                    term: null
                    termPeriodType: null
                    termType: null
                    triggerEvent: ContractEffective
                    uom: null
                    upToPeriods: null
                    upToPeriodsType: null
                    usageRecordRatingOption: null
                    useDiscountSpecificAccountingCode: null
                    useTenantDefaultForPriceChange: true
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a product charge definition
      tags:
        - Product Charge Definitions
    put:
      description: >
        Update a product charge definition.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: PUT_UpdateProductChargeDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique number or ID of the product charge definition to be
            updated.
          in: path
          name: product-charge-definition-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTProductChargeDefinitionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    applyDiscountTo: null
                    billingPeriod: Month
                    billingPeriodAlignment: AlignToCharge
                    billingTiming: IN_ADVANCE
                    chargeModel: FlatFee
                    defaultQuantity: 1
                    discountClass: null
                    discountLevel: null
                    effectiveEndDate: '2023-10-13 09:00:00'
                    effectiveStartDate: '2022-10-07 09:00:00'
                    isDefault: true
                    listPriceBase: Per_Billing_Period
                    numberOfPeriods: null
                    prices:
                      - currency: USD
                        price: 20
                    productChargeDefinitionId: 2c9890f78b0d09d2018b0d13c7fd0004
                    productChargeDefinitionNumber: CD-00000201
                    productRatePlanChargeId: 2c9890f78b0d09d2018b0d13c7fd0004
                    productRatePlanChargeNumber: null
                    productRatePlanId: null
                    productRatePlanName: null
                    productRatePlanNumber: null
                    ratingGroup: null
                    smoothingModel: null
                    specificBillingPeriod: null
                    specificListPriceBase: null
                    success: true
                    taxCode: ''
                    taxMode: null
                    taxable: false
                    term: null
                    termPeriodType: null
                    termType: null
                    uom: null
              schema:
                $ref: '#/components/schemas/GETProductChargeDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a product charge definition
      tags:
        - Product Charge Definitions
    delete:
      description: >
        Deletes a product charge definition.


        **Note**: This operation requires the [Attribute-based
        Pricing](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute_based_pricing/AA_Overview_of_Attribute-based_Pricing)
        feature to be enabled, which is in the **Early Adopter** phase. 
      operationId: DELETE_ProductChargeDefnition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique number or ID of the product charge definition to be
            deleted.
          in: path
          name: product-charge-definition-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a product charge definition
      tags:
        - Product Charge Definitions
  /v1/object/product-rate-plan-charge-tier/{id}:
    get:
      description: Retrieves a specific product rate plan charge tier.
      operationId: Object_GETProductRatePlanChargeTier
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    CreatedById: 2c93808457d787030157e02fd0f132a4
                    CreatedDate: '2016-10-20T05:43:38.000+02:00'
                    Currency: USD
                    EndingUnit: 0
                    Id: 2c93808457d787030157e02fe725341f
                    Price: 30
                    PriceFormat: Flat Fee
                    StartingUnit: 0
                    Tier: 1
                    UpdatedById: 2c93808457d787030157e02fd0f132a4
                    UpdatedDate: '2016-10-20T05:43:38.000+02:00'
              schema:
                $ref: '#/components/schemas/ProxyGetProductRatePlanChargeTier'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a product rate plan charge tier'
      tags:
        - Product Rate Plan Charge Tiers
    put:
      description: >
        Updates the price of a product rate plan charge tier.


        To make other updates to product rate plan charge tiers, use [CRUD:
        Update a product rate plan
        charge](https://developer.zuora.com/api-references/api/operation/Object_PUTProductRatePlanCharge)
        and specify `ProductRatePlanChargeTierData` in the request body.
      operationId: Object_PUTProductRatePlanChargeTier
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The unique ID of the product rate plan charge tier to be updated.
            For example, 2c92c0f86c85891e016c88d55a6e543b.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyModifyProductRatePlanChargeTier'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c92c0f86c85891e016c88d55a6e543b
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Update a product rate plan charge tier'
      tags:
        - Product Rate Plan Charge Tiers
  /v1/revpro-accounting-codes:
    put:
      description: >-
        Update the Zuora Revenue accounting code that corresponds to a specific
        Product Rate Plan Charge Id in Zuora Billing.
      operationId: PUT_RevProAccountingCodes
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevproAccountingCodes'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/PUTRevproAccCodeResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a Zuora Revenue accounting code
      tags:
        - Zuora Revenue Integration
  /commerce/charges:
    post:
      summary: Create a product rate plan charge with Dynamic Pricing
      description: >
        Create a product rate plan charge (PRPC) in the Product Catalog.

        Use this endpoint to configure Dynamic Pricing, including default
        pricing at the charge level 

        and conditional rate cards evaluated by attribute values.
      operationId: createProductRatePlanChargeWithDynamicPricing
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChargeRequest'
            examples:
              perUnitExample:
                summary: Per-unit charge example
                value:
                  charge:
                    charge_model: per_unit
                    charge_type: recurring
                    description: description
                    name: charge with dimensional price 1
                    unit_of_measure: Each
                    default_quantity: 10
                    bill_cycle:
                      period: bill_cycle_period_month
                      period_alignment: align_to_charge
                      timing: in_advance
                      type: default_from_customer
                    trigger_event: contract_effective
                    product_rate_plan_id: f5cf096c5ca94443f76446a981e50000
                    end_date_condition: subscription_end
                    up_to_periods_type: billing_periods
                    up_to_periods: 0
                    list_price_base: Per_Billing_Period
                    specific_list_price_base: 0
                    formula: price + 1
                    tax_mode: non_taxable
                    tax_code: TAX_EXEMPT
                    accounting:
                      accounting_code: PRPC-REV-001
                      accounts_receivable_account: Accounts Receivable
                      deferred_revenue_account: Deferred Revenue
                      recognized_revenue_account: Recognized Revenue
                      contract_asset_account: Contract Asset
                      contract_liability_account: Contract Liability
                      contract_recognized_revenue_account: Contract Recognized Revenue
                      unbilled_receivables_account: Unbilled Receivables
                      adjustment_liability_account: Adjustment Liability
                      adjustment_revenue_account: Adjustment Revenue
                    revenue:
                      revenue_recognition_rule_name: Recognize upon invoicing
                      exclude_item_billing_from_revenue_accounting: false
                      exclude_item_booking_from_revenue_accounting: false
                    custom_fields:
                      region__c: US
                      channel__c: Online
                    netsuite:
                      SubsidiaryNS: US
                      RecognizedRevAccountNS: 4000
                      DeferredRevAccountNS: 2500
                    attributes:
                      - name: Age
                        type: Integer
                        mapping:
                          object: account
                          field: age__c
                    rate_cards:
                      - attributes:
                          - name: Age
                            operator: <=
                            value: 12
                        pricing:
                          unit_amounts:
                            USD: 90
                      - attributes:
                          - name: Age
                            operator: between
                            value:
                              - 12
                              - 60
                        pricing:
                          unit_amounts:
                            USD: 100
                      - attributes:
                          - name: Age
                            operator: '>='
                            value: 60
                        pricing:
                          unit_amounts:
                            USD: 80
              tieredExample:
                summary: Tiered charge example
                value:
                  charge:
                    charge_model: tiered
                    charge_type: usage
                    name: tiered charge
                    unit_of_measure: Each
                    bill_cycle:
                      period: bill_cycle_period_month
                      period_alignment: align_to_charge
                      timing: in_arrears
                      type: default_from_customer
                    trigger_event: contract_effective
                    product_rate_plan_id: f5cf096c5ca94443f76446a981e50000
                    attributes:
                      - name: Region
                        type: String
                    rate_cards:
                      - attributes:
                          - name: Region
                            operator: '=='
                            value: US
                        pricing:
                          tiers:
                            - tier: '1'
                              from: 0
                              up_to: 10
                              price_format: price_format_per_unit
                              unit_amounts:
                                USD: 2.5
                              min_amounts:
                                USD: 6.25
                              max_amounts:
                                USD: 25
                            - tier: '2'
                              from: 11
                              price_format: price_format_per_unit
                              unit_amounts:
                                USD: 1.5
                              min_amounts:
                                USD: 15
                              max_amounts:
                                USD: 150
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChargeResponse'
              examples:
                response:
                  value:
                    accounting:
                      accountingCode: PRPC-REV-001
                      accountsReceivableAccount: Accounts Receivable
                      accountsReceivableAccountType: AccountsReceivable
                      deferredRevenueAccount: Deferred Revenue
                      deferredRevenueAccountType: DeferredRevenue
                      recognizedRevenueAccount: Recognized Revenue
                      recognizedRevenueAccountType: Recognized Revenue
                      adjustmentLiabilityAccount: adjustL-1
                      adjustmentLiabilityAccountType: AdjustmentLiability
                      adjustmentRevenueAccount: adjustRev-1
                      adjustmentRevenueAccountType: AdjustmentRevenue
                      contractAssetAccount: CA-2
                      contractAssetAccountType: ContractAsset
                      contractLiabilityAccount: CL-2
                      contractLiabilityAccountType: ContractLiability
                      contractRecognizedRevenueAccount: Contract Recognized Revenue
                      contractRecognizedRevenueAccountType: RecognizedRevenue
                      unbilledReceivablesAccount: unbilledR-1
                      unbilledReceivablesAccountType: UnbilledReceivables
                      productRatePlanChargeId: ad95b694d2b8442b84dc8ad26561c7d7
                    attributes: []
                    billCycle:
                      dayOfMonth: 5
                      period: bill_cycle_period_month
                      periodAlignment: align_to_charge
                      timing: in_advance
                      type: specific_day_of_month
                    chargeFunction: charge_function_standard
                    chargeModel: flat_fee
                    chargeType: recurring
                    createdById: 53c162482f054f3ca08e1ec82dccfec9
                    createdTime: '2025-10-13T07:46:02.000+00:00'
                    customFields: {}
                    discountOptions:
                      applyDetails: []
                      applyTo: []
                      applyToBillingPeriodPartially: false
                      reflectDiscountInNetAmount: false
                      rollover: false
                      stackedDiscount: false
                    drawdown: {}
                    endDateCondition: subscription_end
                    upToPeriodsType: billing_periods
                    upToPeriods: 0
                    extendedPrice: {}
                    id: ad95b694d2b8442b84dc8ad26561c7d7
                    isChargeLevelMinCommit: false
                    isCommitted: false
                    labels: {}
                    listPriceBase: Per_Billing_Period
                    specificListPriceBase: 0
                    mergedRateCards: []
                    name: Flat PRPC 1
                    negotiatedRateCards: []
                    ocmJsonByCurrency: {}
                    organizationLabels: []
                    overageOptions:
                      includedUnits: 0
                      unusedUnitsCreditRates: {}
                    prepaid: false
                    prepayment:
                      rollover: false
                      rolloverApply: apply_last
                      rolloverPeriodLength: 0
                      rolloverPeriods: 0
                    priceChangeOption: no_change
                    pricing:
                      adjustments: {}
                      discountAmounts: {}
                      discountPercentages: {}
                      flatAmounts:
                        USD: 100
                      maxAmounts: {}
                      minAmounts: {}
                      percentages: {}
                      tiers: []
                      unitAmounts: {}
                    pricingSummary:
                      - USD100
                    pricingWaterfalls: {}
                    productChargeDefinitions: []
                    productRatePlanChargeNumber: PRPC-00000279
                    productRatePlanId: ee2d1ce1036c4dd6ae9d6945565ff7a0
                    prorationOption: default_from_tenant_setting
                    rateCards: []
                    revenue:
                      excludeItemBillingFromRevenueAccounting: false
                      excludeItemBookingFromRevenueAccounting: false
                      legacyReporting: false
                      revenueRecognitionRuleName: Recognize upon invoicing
                    taxMode: non_taxable
                    taxCode: TAX_EXEMPT
                    taxable: false
                    triggerEvent: contract_effective
                    updatedById: 53c162482f054f3ca08e1ec82dccfec9
                    updatedTime: '2025-10-13T07:46:02.000+00:00'
                    useTenantDefaultForPriceChange: true
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
              examples:
                response:
                  value:
                    message: Authentication error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >-
                The value of this header is:\n\n```\n\nBasic realm=Zuora API,
                ZSession realm=Zuora API, Bearer realm=Zuora API\n\n```\n
              schema:
                type: string
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      tags:
        - Commerce
    put:
      description: >
        Update an existing product rate plan charge (PRPC). Use this API to
        update default pricing and/or conditional rate cards.
      operationId: updateProductRatePlanChargeWithDynamicPricing
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChargeRequest'
            example:
              charge:
                id: 9c4867ed55db43a89731605d5654d4ed
                pricing:
                  unit_amounts:
                    USD: 175
                rate_cards:
                  - attributes:
                      - name: Age
                        operator: <=
                        value: 12
                      - name: EffectiveDate
                        operator: '>='
                        value: '2025-02-01T00:00:00+00:00'
                    pricing:
                      unit_amounts:
                        USD: 180
                  - attributes:
                      - name: Age
                        operator: between
                        value:
                          - 12
                          - 60
                      - name: EffectiveDate
                        operator: '>='
                        value: '2025-02-01T00:00:00+00:00'
                    pricing:
                      unit_amounts:
                        USD: 200
                  - attributes:
                      - name: Age
                        operator: '>='
                        value: 60
                      - name: EffectiveDate
                        operator: '>='
                        value: '2025-02-01T00:00:00+00:00'
                    pricing:
                      unit_amounts:
                        USD: 160
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChargeResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          description: Request Errors or Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
              examples:
                response:
                  value:
                    message: Authentication error
          headers:
            Content-Encoding:
              schema:
                type: string
            WWW-Authenticate:
              schema:
                type: string
              description: >
                The value of this header is:

                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a product rate plan charge with Dynamic Pricing
      tags:
        - Commerce
  /commerce/charges/query:
    post:
      description: >
        Returns a product rate plan charge (PRPC) by evaluating Dynamic Pricing
        against the provided attribute values.  

        If a matching rate-card row is found, its pricing is returned;
        otherwise, the default charge-level pricing is used (if defined).  

        This operation can be used to simulate pricing resolution without
        creating or updating the charge.
      operationId: queryProductRatePlanChargeWithDynamicPricing
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryChargeRequest'
            examples:
              minimal:
                summary: Query with only the PRPC key (no attributes)
                value:
                  product_rate_plan_charge_key: ad95b694d2b8442b84dc8ad26561c7d7
              withAttributes:
                summary: Query with optional attribute values
                value:
                  product_rate_plan_charge_key: ad95b694d2b8442b84dc8ad26561c7d7
                  evaluation_level: LIST_PRICE
                  attributes:
                    - name: Age
                      number_value: 11
                    - name: EffectiveDate
                      datetime_value: '2025-02-01T00:00:00Z'
                    - name: AccountContext
                      value: Liquidity Provider
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChargeResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Query a product rate plan charge with Dynamic Pricing
      tags:
        - Commerce
  /commerce/products:
    post:
      summary: Create a product with plans and charges
      description: >
        Create a product in the Product Catalog with one or more plans and
        charges.

        Charges can be usage (per-unit), recurring (flat fee), or other
        supported models.
      operationId: createProduct
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProductRequest'
            examples:
              createProductExample:
                summary: Product with one plan and one recurring flat-fee charge
                value:
                  name: New prod
                  start_date: '2024-01-01'
                  end_date: '2050-12-31'
                  category: base
                  plans:
                    - name: Consumer Bronze Monthly
                      start_date: '2024-01-01'
                      end_date: '2050-12-31'
                      active_currencies:
                        - USD
                      charges:
                        - name: Flat PRPC
                          charge_type: recurring
                          charge_model: flat_fee
                          default_quantity: 10
                          min_quantity: 1
                          max_quantity: 999999
                          price_increase_percentage: 0
                          price_change_option: no_change
                          use_tenant_default_for_price_change: true
                          discount_options:
                            discount_class: ''
                            discount_level: rate_plan
                            stacked_discount: false
                            apply_to:
                              - one_time
                              - recurring
                              - usage
                            apply_to_billing_period_partially: false
                            reflect_discount_in_net_amount: false
                            rollover: false
                            specific_accounting_codes: false
                            apply_details: []
                          pricing:
                            flat_amounts:
                              USD: 100
                          bill_cycle:
                            type: specific_day_of_month
                            day_of_month: 5
                            period_alignment: align_to_charge
                            period: bill_cycle_period_month
                            timing: in_advance
                          trigger_event: contract_effective
                          end_date_condition: subscription_end
                          up_to_periods_type: billing_periods
                          up_to_periods: 0
                          list_price_base: Per_Billing_Period
                          specific_list_price_base: 0
                          accounting:
                            accounting_code: PRPC-REV-002
                            accounts_receivable_account: Accounts Receivable
                            deferred_revenue_account: Deferred Revenue
                            recognized_revenue_account: Recognized Revenue
                            adjustment_liability_account: adjustL-2
                            adjustment_revenue_account: adjustRev-2
                            contract_asset_account: CA-3
                            contract_liability_account: CL-3
                            contract_recognized_revenue_account: Contract Recognized Revenue
                            unbilled_receivables_account: unbilledR-2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProductResponse'
              examples:
                response:
                  value:
                    allowFeatureChanges: false
                    category: base
                    contextFilters: []
                    createdBy: 53c162482f054f3ca08e1ec82dccfec9
                    createdTime: '2025-10-17T04:02:54.621-07:00'
                    customFields: {}
                    customObjects: null
                    description: ''
                    endDate: '2050-12-31'
                    features: []
                    id: 7ec58fadb6f84bc18e59c7529058d941
                    legacyFeatures: []
                    name: New prod
                    netsuite: null
                    organizationLabels: []
                    plans:
                      - activeCurrencies:
                          - USD
                        attributes: []
                        contextFilters: []
                        createTime: '2025-10-17T04:02:54.655-07:00'
                        createdBy: 53c162482f054f3ca08e1ec82dccfec9
                        customFields: {}
                        description: ''
                        displayName: ''
                        endDate: '2050-12-31'
                        entitlements: []
                        externalIdSourceSystem: ''
                        externalRateplanId: []
                        id: 572a2efe711b449e80cbef94419bc050
                        name: Consumer Bronze Monthly
                        netsuite: null
                        organizationLabels: []
                        productId: 7ec58fadb6f84bc18e59c7529058d941
                        productRatePlanCharges:
                          - accounting:
                              accountingCode: Accounts Receivable
                              accountsReceivableAccount: Accounts Receivable
                              deferredRevenueAccount: Accounts Receivable
                              recognizedRevenueAccount: Recognized Revenue
                            attributes: []
                            billCycle:
                              dayOfMonth: 5
                              period: bill_cycle_period_month
                              periodAlignment: align_to_charge
                              timing: in_advance
                              type: specific_day_of_month
                            chargeFunction: charge_function_standard
                            chargeModel: flat_fee
                            chargeType: recurring
                            createdById: 53c162482f054f3ca08e1ec82dccfec9
                            createdTime: '2025-10-17T04:02:54.719-07:00'
                            customFields: {}
                            discountOptions:
                              applyDetails: []
                              applyTo: []
                              applyToBillingPeriodPartially: false
                              reflectDiscountInNetAmount: false
                              rollover: false
                              stackedDiscount: false
                            drawdown: {}
                            endDateCondition: subscription_end
                            upToPeriodsType: billing_periods
                            upToPeriods: 0
                            extendedPrice: {}
                            id: 42db6ead399a4521bae91b3af469c074
                            isChargeLevelMinCommit: false
                            isCommitted: false
                            labels: {}
                            listPriceBase: Per_Billing_Period
                            specificListPriceBase: 0
                            mergedRateCards: []
                            name: Flat PRPC
                            negotiatedRateCards: []
                            ocmJsonByCurrency: {}
                            organizationLabels: []
                            overageOptions:
                              includedUnits: 0
                              unusedUnitsCreditRates: {}
                            prepaid: false
                            prepayment:
                              rollover: false
                              rolloverApply: apply_last
                              rolloverPeriodLength: 0
                              rolloverPeriods: 0
                            priceChangeOption: no_change
                            pricing:
                              adjustments: {}
                              discountAmounts: {}
                              discountPercentages: {}
                              flatAmounts:
                                USD: 100
                              maxAmounts: {}
                              minAmounts: {}
                              percentages: {}
                              tiers: []
                              unitAmounts: {}
                            pricingSummary: []
                            pricingWaterfalls: {}
                            productChargeDefinitions: []
                            productRatePlanChargeNumber: PRPC-00000283
                            productRatePlanId: 572a2efe711b449e80cbef94419bc050
                            prorationOption: default_from_tenant_setting
                            rateCards: []
                            revenue:
                              excludeItemBillingFromRevenueAccounting: false
                              excludeItemBookingFromRevenueAccounting: false
                              legacyReporting: false
                              revenueRecognitionRuleName: Recognize upon invoicing
                            taxable: false
                            triggerEvent: contract_effective
                            updatedById: 53c162482f054f3ca08e1ec82dccfec9
                            updatedTime: '2025-10-17T04:02:54.719-07:00'
                            useTenantDefaultForPriceChange: true
                        productRatePlanNumber: PRP-00000198
                        startDate: '2024-01-01'
                        state: active
                        updateTime: '2025-10-17T04:02:54.655-07:00'
                        updatedBy: 53c162482f054f3ca08e1ec82dccfec9
                    productNumber: PC-00000105
                    sku: SKU-00000135
                    startDate: '2024-01-01'
                    state: product_active
                    updatedBy: 53c162482f054f3ca08e1ec82dccfec9
                    updatedTime: '2025-10-17T04:02:54.621-07:00'
          headers:
            Content-Encoding:
              description: >
                Returned if `Accept-Encoding: gzip` is specified and the
                response exceeds 1000 bytes. Supported MIME types:
                application/json, application/xml, text/html, text/csv,
                text/plain.
              schema:
                type: string
            RateLimit-Limit:
              schema:
                type: string
            RateLimit-Remaining:
              schema:
                type: number
            RateLimit-Reset:
              schema:
                type: number
            Zuora-Request-Id:
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
      tags:
        - Commerce
    put:
      summary: Update a product
      description: >
        Updates an existing product in the Product Catalog. Use this API to
        update core product fields

        such as name, description, category, effective dates, and custom fields.
      operationId: updateProduct
      tags:
        - Commerce
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProductRequest'
            example:
              id: 8ad088009840d1c2019855e15c993f2f
              name: Software Service
              description: Software service - basic edition
              category: base
              custom_fields:
                HelloBay__c: Updated value
                Tags__c:
                  - AI Powered
                  - Internet Required
              startDate: '2025-05-11'
              endDate: '2050-12-10'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateProductResponse'
              examples:
                response:
                  value:
                    allowFeatureChanges: false
                    category: base
                    contextFilters: []
                    createdBy: 8a90a2fd8030ea2e018032b11d3a3f06
                    createdTime: '2025-08-06T18:11:35.000-07:00'
                    customFields: {}
                    customObjects: null
                    description: Software service - basic edition
                    endDate: '2050-12-31'
                    features: []
                    id: 00c86e3a0595442c88ed9ef8474b10a7
                    legacyFeatures: []
                    name: Amadeus
                    netsuite: null
                    organizationLabels: []
                    productNumber: PC-00000095
                    productRatePlans: []
                    sku: SKU-00000122
                    startDate: '2024-01-08'
                    state: product_active
                    updatedBy: 53c162482f054f3ca08e1ec82dccfec9
                    updatedTime: '2025-10-23T04:55:54.000-07:00'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          description: Request Errors or Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
              examples:
                response:
                  value:
                    message: Authentication error
          headers:
            Content-Encoding:
              schema:
                type: string
            WWW-Authenticate:
              schema:
                type: string
              description: >
                The value of this header is:

                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /commerce/plans:
    post:
      summary: Create a product rate plan
      description: |
        Create a product rate plan (Plan) under an existing product.
        A plan includes one or more **charges**. Each charge **must** include:
          - `name`
          - `charge_model`
          - `charge_type`
          - `bill_cycle`
          - `trigger_event`
          - `end_date_condition`
          - `pricing`

          Optional charge fields include: `unit_of_measure`, `list_price_base`, and `accounting` (with `accounting_code`, `deferred_revenue_account`, `recognized_revenue_account`).
      operationId: createPlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePlanRequest'
            examples:
              createPlanExample:
                summary: Create a plan with two recurring flat-fee charges
                value:
                  product_key: 6b14067136304e64b090daccae6680cb
                  name: New plan
                  start_date: '2024-01-01'
                  end_date: '2049-12-31'
                  active_currencies:
                    - USD
                  charges:
                    - name: Flat PRPC 1
                      charge_model: flat_fee
                      charge_type: recurring
                      pricing:
                        flat_amounts:
                          USD: 100
                      bill_cycle:
                        type: specific_day_of_month
                        day_of_month: 5
                        period_alignment: align_to_charge
                        period: bill_cycle_period_month
                      end_date_condition: subscription_end
                      up_to_periods_type: billing_periods
                      up_to_periods: 0
                      list_price_base: Per_Billing_Period
                      specific_list_price_base: 0
                      trigger_event: contract_effective
                      accounting:
                        accounting_code: PRPC-REV-001
                        accounts_receivable_account: Accounts Receivable
                        deferred_revenue_account: Deferred Revenue
                        recognized_revenue_account: Recognized Revenue
                        adjustment_liability_account: adjustL-1
                        adjustment_revenue_account: adjustRev-1
                        contract_asset_account: CA-2
                        contract_liability_account: CL-2
                        contract_recognized_revenue_account: Contract Recognized Revenue
                        unbilled_receivables_account: unbilledR-1
                    - name: Flat PRPC 2
                      charge_model: flat_fee
                      charge_type: recurring
                      pricing:
                        flat_amounts:
                          USD: 100
                      bill_cycle:
                        type: specific_day_of_month
                        day_of_month: 5
                        period_alignment: align_to_charge
                        period: bill_cycle_period_month
                      end_date_condition: subscription_end
                      trigger_event: contract_effective
                      accounting:
                        accounting_code: PRPC-REV-002
                        accounts_receivable_account: Accounts Receivable
                        deferred_revenue_account: Deferred Revenue
                        recognized_revenue_account: Recognized Revenue
                        adjustment_liability_account: adjustL-2
                        adjustment_revenue_account: adjustRev-2
                        contract_asset_account: CA-3
                        contract_liability_account: CL-3
                        contract_recognized_revenue_account: Contract Recognized Revenue
                        unbilled_receivables_account: unbilledR-2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePlanResponse'
              examples:
                response:
                  value:
                    activeCurrencies:
                      - USD
                    attributes: []
                    contextFilters: []
                    createTime: '2025-10-13T07:46:02.314-07:00'
                    createdBy: 53c162482f054f3ca08e1ec82dccfec9
                    customFields: {}
                    description: ''
                    displayName: ''
                    endDate: '2049-12-31'
                    entitlements: []
                    externalIdSourceSystem: ''
                    externalRateplanId: []
                    id: ee2d1ce1036c4dd6ae9d6945565ff7a0
                    name: New plan
                    netsuite: null
                    organizationLabels: []
                    productId: 7228c9e6fd814e3a9e59bcdf0117e34f
                    productRatePlanCharges:
                      - accounting:
                          accountingCode: PRPC-REV-001
                          accountsReceivableAccount: Accounts Receivable
                          accountsReceivableAccountType: AccountsReceivable
                          deferredRevenueAccount: Deferred Revenue
                          deferredRevenueAccountType: DeferredRevenue
                          recognizedRevenueAccount: Recognized Revenue
                          recognizedRevenueAccountType: RecognizedRevenue
                          adjustmentLiabilityAccount: adjustL-1
                          adjustmentLiabilityAccountType: AdjustmentLiability
                          adjustmentRevenueAccount: adjustRev-1
                          adjustmentRevenueAccountType: AdjustmentRevenue
                          contractAssetAccount: CA-2
                          contractAssetAccountType: ContractAsset
                          contractLiabilityAccount: CL-2
                          contractLiabilityAccountType: ContractLiability
                          contractRecognizedRevenueAccount: Contract Recognized Revenue
                          contractRecognizedRevenueAccountType: RecognizedRevenue
                          unbilledReceivablesAccount: unbilledR-1
                          unbilledReceivablesAccountType: UnbilledReceivables
                          productRatePlanChargeId: ad95b694d2b8442b84dc8ad26561c7d7
                        attributes: []
                        billCycle:
                          dayOfMonth: 5
                          period: bill_cycle_period_month
                          periodAlignment: align_to_charge
                          timing: in_advance
                          type: specific_day_of_month
                        chargeFunction: charge_function_standard
                        chargeModel: flat_fee
                        chargeType: recurring
                        createdById: 53c162482f054f3ca08e1ec82dccfec9
                        createdTime: '2025-10-13T07:46:02.375-07:00'
                        customFields: {}
                        discountOptions:
                          applyToBillingPeriodPartially: false
                          reflectDiscountInNetAmount: false
                          rollover: false
                          stackedDiscount: false
                        drawdown: {}
                        endDateCondition: subscription_end
                        upToPeriodsType: billing_periods
                        upToPeriods: 0
                        listPriceBase: Per_Billing_Period
                        specificListPriceBase: 0
                        extendedPrice: {}
                        id: ad95b694d2b8442b84dc8ad26561c7d7
                        isChargeLevelMinCommit: false
                        isCommitted: false
                        labels: {}
                        mergedRateCards: []
                        name: Flat PRPC 1
                        negotiatedRateCards: []
                        ocmJsonByCurrency: {}
                        organizationLabels: []
                        overageOptions:
                          includedUnits: 0
                          unusedUnitsCreditRates: {}
                        prepaid: false
                        prepayment:
                          rollover: false
                          rolloverApply: apply_last
                          rolloverPeriodLength: 0
                          rolloverPeriods: 0
                        priceChangeOption: no_change
                        pricing:
                          discountAmounts: {}
                          discountPercentages: {}
                          flatAmounts:
                            USD: 100
                          maxAmounts: {}
                          minAmounts: {}
                          percentages: {}
                          tiers: []
                          unitAmounts: {}
                        pricingSummary: []
                        pricingWaterfalls: {}
                        productChargeDefinitions: []
                        productRatePlanChargeNumber: PRPC-00000279
                        productRatePlanId: ee2d1ce1036c4dd6ae9d6945565ff7a0
                        prorationOption: default_from_tenant_setting
                        rateCards: []
                        revenue:
                          excludeItemBillingFromRevenueAccounting: false
                          excludeItemBookingFromRevenueAccounting: false
                          legacyReporting: false
                          revenueRecognitionRuleName: Recognize upon invoicing
                        taxable: false
                        triggerEvent: contract_effective
                        updatedById: 53c162482f054f3ca08e1ec82dccfec9
                        updatedTime: '2025-10-13T07:46:02.375-07:00'
                        useTenantDefaultForPriceChange: true
                    productRatePlanNumber: PRP-00000195
                    startDate: '2024-01-01'
                    state: active
                    updateTime: '2025-10-13T07:46:02.314-07:00'
                    updatedBy: 53c162482f054f3ca08e1ec82dccfec9
          headers:
            Content-Encoding:
              description: >
                Returned if `Accept-Encoding: gzip` is specified and the
                response exceeds 1000 bytes. Supported MIME types:
                application/json, application/xml, text/html, text/csv,
                text/plain.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See rate limits docs.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See rate limits docs.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to exhaustion. See rate limits docs.
              schema:
                type: number
            Zuora-Request-Id:
              description: The Zuora internal identifier of the API call.
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
          headers:
            Content-Encoding:
              description: >
                Returned if `Accept-Encoding: gzip` is specified and the
                response exceeds 1000 bytes. Supported MIME types:
                application/json, application/xml, text/html, text/csv,
                text/plain.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See rate limits docs.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See rate limits docs.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to exhaustion. See rate limits docs.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:

                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                type: string
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
            Zuora-Request-Id:
              description: The Zuora internal identifier of the API call.
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      tags:
        - Commerce
    put:
      summary: Update a product rate plan
      description: >
        Updates an existing Product Rate Plan (PRP) in the Product Catalog. 

        Use this API to update core plan fields such as name, description,
        grade, and effective dates.
      operationId: updateProductRatePlan
      tags:
        - Commerce
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePlanRequest'
            example:
              id: 5758b1d5a589840e0e6855e1c2ce014d
              name: Bronze Plan
              description: Basic version of our software service
              grade: 1
              startDate: '2025-09-10'
              endDate: '2043-08-16'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePlanResponse'
              examples:
                response:
                  value:
                    activeCurrencies:
                      - USD
                    attributes: []
                    contextFilters: []
                    createTime: '2025-02-24T01:20:44.000+00:00'
                    createdBy: 8a90a2fd8030ea2e018032b11d3a3f06
                    customFields: {}
                    description: Basic version of our software service
                    displayName: ''
                    endDate: '2027-01-01'
                    entitlements: []
                    externalIdSourceSystem: ''
                    externalRateplanId: []
                    id: 38660706ef2f48cfb5222f7dde491895
                    name: Bronze Plan
                    netsuite: {}
                    organizationLabels: []
                    productId: 8a90aac8948deebf01949098b7790326
                    productRatePlanCharges:
                      - id: 99e226fec45943f4b80ed7bcf6d595d7
                        name: disc_currency
                        chargeType: recurring
                        chargeModel: discount_percentage
                        triggerEvent: contract_effective
                        billCycle:
                          period: bill_cycle_period_quarter
                          periodAlignment: align_to_term_start
                          type: term_start_day
                        pricing:
                          discountPercentages:
                            USD: 10
                          tiers: []
                        prepayment:
                          creditOption: time_based
                          rollover: false
                          rolloverApply: apply_last
                          rolloverPeriodLength: 0
                          rolloverPeriods: 0
                          validityPeriod: subscription_term
                        taxMode: non_taxable
                        taxable: false
                        createdById: 8a90a2fd8030ea2e018032b11d3a3f06
                        createdTime: '2025-02-24T01:21:51.000+00:00'
                        updatedById: 8a90a2fd8030ea2e018032b11d3a3f06
                        updatedTime: '2025-02-24T01:21:51.000+00:00'
                      - id: fe9b0e764dca4178a11c0e471e5dc0d8
                        name: prepay_currency
                        chargeType: recurring
                        chargeModel: flat_fee
                        listPriceBase: Per_Billing_Period
                        triggerEvent: contract_effective
                        billCycle:
                          period: bill_cycle_period_quarter
                          periodAlignment: align_to_term_start
                          timing: in_advance
                          type: term_start_day
                        pricing:
                          flatAmounts:
                            USD: 30
                          tiers: []
                        prepayment:
                          creditOption: consumption_based
                          operationType: prepaid_operation_type_topup
                          rollover: false
                          rolloverApply: apply_last
                          rolloverPeriodLength: 0
                          rolloverPeriods: 0
                          validityPeriod: quarter
                        taxMode: non_taxable
                        taxable: false
                        createdById: 8a90a2fd8030ea2e018032b11d3a3f06
                        createdTime: '2025-02-24T01:21:23.000+00:00'
                        updatedById: 8a90a2fd8030ea2e018032b11d3a3f06
                        updatedTime: '2025-02-24T01:21:23.000+00:00'
                    productRatePlanNumber: PRP-00000172
                    startDate: '2025-09-10'
                    state: active
                    status: ACTIVE
                    updateTime: '2025-10-23T05:16:28.334+00:00'
                    updatedBy: 53c162482f054f3ca08e1ec82dccfec9
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to exhaustion.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          description: Request Errors or Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
              examples:
                response:
                  value:
                    message: Authentication error
          headers:
            Content-Encoding:
              schema:
                type: string
            WWW-Authenticate:
              schema:
                type: string
              description: >
                The value of this header is:

                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
  /commerce/plans/query:
    post:
      description: >
        Retrieve details of a **single** product rate plan (PRP) from the
        Product Catalog. You can expand associated product rate plan charges for
        each plan.

        This operation is a **strict lookup** and **requires**
        `product_rate_plan_key`. It does **not** support `attributes` or other
        list-style filters.

        To browse or filter plans (including by `attributes`), use  the "Query
        product rate plans" operation (`POST /commerce/plans/list`).
      operationId: queryCommerceProductRatePlans
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryChargeRequest'
            examples:
              byPlanIdExpandCharges:
                summary: Query a single PRP by key and expand charges
                value:
                  product_rate_plan_key: 572a2efe711b449e80cbef94419bc050
                  expand:
                    product_rate_plan_charges: true
              byPlanKeyNoExpand:
                summary: Query a single PRP by key (no expansion)
                value:
                  product_rate_plan_key: 11dc762a07064ce496af73ff4cfb5614
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChargeResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Query product rate plan details
      tags:
        - Commerce
  /commerce/plans/list:
    post:
      summary: Query product rate plans
      description: >
        Queries product rate plans (PRPs) from the Product Catalog using filters
        such as plan ID, name, or product ID.  

        You can optionally expand related Product Rate Plan Charges (PRPCs) in
        the response.
      operationId: queryCommercePlansList
      tags:
        - Commerce
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListPlansRequest'
            example:
              filters:
                - field: prp_id
                  operator: EQ
                  value: 38660706ef2f48cfb5222f7dde491895
              expand:
                product_rate_plan_charges: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPlansResponse'
              examples:
                response:
                  value:
                    values:
                      - id: 38660706ef2f48cfb5222f7dde491895
                        createdBy: 8a90a2fd8030ea2e018032b11d3a3f06
                        createTime: '2025-02-24T01:21:23.000+00:00'
                        updatedBy: 8a90a2fd8030ea2e018032b11d3a3f06
                        updateTime: '2025-02-24T01:21:23.000+00:00'
                        displayName: Bronze Plan
                        name: Bronze Plan
                        description: Basic version of our software service
                        productId: 8a90aac8948deebf01949098b7790326
                        startDate: '2025-09-10'
                        endDate: '2027-01-01'
                        state: active
                        status: ACTIVE
                        activeCurrencies:
                          - USD
                        productRatePlanNumber: PRP-00000172
                        productRatePlanCharges:
                          - id: fe9b0e764dca4178a11c0e471e5dc0d8
                            productRatePlanChargeNumber: PRPC-00000279
                            name: prepay_currency
                            chargeType: recurring
                            chargeModel: flat_fee
                            listPriceBase: Per_Billing_Period
                            triggerEvent: contract_effective
                            unitOfMeasure: Each
                            defaultQuantity: 1
                            endDateCondition: subscription_end
                            upToPeriodsType: billing_periods
                            upToPeriods: 0
                            billCycle:
                              period: bill_cycle_period_quarter
                              periodAlignment: align_to_term_start
                              timing: in_advance
                              type: term_start_day
                            pricing:
                              flatAmounts:
                                USD: 30
                              tiers: []
                            pricingSummary:
                              - USD30
                            taxMode: non_taxable
                            taxable: false
                            createdById: 8a90a2fd8030ea2e018032b11d3a3f06
                            createdTime: '2025-02-24T01:21:23.000+00:00'
                            updatedById: 8a90a2fd8030ea2e018032b11d3a3f06
                            updatedTime: '2025-02-24T01:21:23.000+00:00'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /commerce/products/{product_key}:
    post:
      description: >
        Retrieves detailed information about a specific product by its unique
        product number or ID. 

        You can optionally specify related objects to expand in the request
        body.
      operationId: getProductByKey
      summary: Retrieve a product by key
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The unique number or ID of the product to be retrieved.
          in: path
          name: product_key
          required: true
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                expand:
                  type: object
                  description: >
                    Controls which related objects are expanded and included in
                    the response.
                  properties:
                    productRatePlans:
                      type: boolean
                      description: >-
                        When `true`, includes product rate plans in the
                        response.
                    productRatePlanCharges:
                      type: boolean
                      description: >-
                        When `true`, includes product rate plan charges in the
                        response.
                    businessContextFilters:
                      type: boolean
                      description: >-
                        When `true`, includes business context filters in the
                        response.
            examples:
              expand:
                summary: Expand related objects
                value:
                  expand:
                    productRatePlans: true
                    productRatePlanCharges: true
                    businessContextFilters: true
      responses:
        '200':
          description: |
            OK
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 7228c9e6fd814e3a9e59bcdf0117e34f
                    createdBy: 53c162482f054f3ca08e1ec82dccfec9
                    createdTime: '2025-10-13T07:44:55.000-07:00'
                    updatedBy: 53c162482f054f3ca08e1ec82dccfec9
                    updatedTime: '2025-10-13T07:44:55.000-07:00'
                    name: New prod
                    description: Example product description
                    productNumber: PC-00000103
                    sku: SKU-00000133
                    startDate: '2024-01-01'
                    endDate: '2050-12-31'
                    category: base
                    customFields: {}
                    customObjects: null
                    allowFeatureChanges: false
                    productRatePlans:
                      - id: 38660706ef2f48cfb5222f7dde491895
                        createdBy: 53c162482f054f3ca08e1ec82dccfec9
                        createTime: '2025-02-24T01:21:23.000+00:00'
                        updatedBy: 53c162482f054f3ca08e1ec82dccfec9
                        updateTime: '2025-02-24T01:21:23.000+00:00'
                        name: Bronze Plan
                        displayName: Bronze Plan
                        description: Basic version of our software service
                        productId: 7228c9e6fd814e3a9e59bcdf0117e34f
                        startDate: '2025-09-10'
                        endDate: '2027-01-01'
                        state: active
                        status: ACTIVE
                        activeCurrencies:
                          - USD
                        productRatePlanNumber: PRP-00000172
                        productRatePlanCharges:
                          - id: fe9b0e764dca4178a11c0e471e5dc0d8
                            productRatePlanChargeNumber: PRPC-00000279
                            name: prepay_currency
                            description: Prepaid recurring software fee
                            chargeType: recurring
                            chargeModel: flat_fee
                            listPriceBase: Per_Billing_Period
                            specificListPriceBase: 1
                            triggerEvent: contract_effective
                            endDateCondition: subscription_end
                            upToPeriodsType: billing_periods
                            upToPeriods: 1
                            billCycle:
                              period: bill_cycle_period_quarter
                              periodAlignment: align_to_term_start
                              timing: in_advance
                              type: term_start_day
                            pricing:
                              flatAmounts:
                                USD: 30
                              tiers: []
                            pricingSummary:
                              - USD30
                            taxMode: non_taxable
                            taxable: false
                            createdById: 53c162482f054f3ca08e1ec82dccfec9
                            createdTime: '2025-02-24T01:21:23.000+00:00'
                            updatedById: 53c162482f054f3ca08e1ec82dccfec9
                            updatedTime: '2025-02-24T01:21:23.000+00:00'
                    features: []
                    netsuite: null
                    organizationLabels: []
                    contextFilters: []
                    legacyFeatures: []
                    dacTag:
                      id: 1234567890abcdef
                      name: Example DAC Tag
                    error: null
              schema:
                $ref: '#/components/schemas/GetProductByKeyResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          description: Internal Server Error
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          description: Request Errors
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '40010020'
                        message: Invalid product_key
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Commerce
  /commerce/legacy/products/list:
    post:
      summary: Query legacy products from the Product Catalog
      description: >
        This operation is functionally equivalent to the "Query products from
        the Product Catalog" operation, except that it returns results

        in the **V1 response format**. It is primarily intended for customers
        migrating from older V1 integrations 

        who want to use new Commerce capabilities — such as **Dynamic
        Pricing**—without refactoring their existing integrations.



        Unlike the "Query products from the Product Catalog" operation, this
        operation does not retrieve a different set of products.  

        It returns the same product catalog data as the newer operation, but
        formatted in a flattened V1-style response structure that:
          - Uses **flattened fields** instead of grouped objects such as `discount_options`, `revenue`, or `bill_cycle`.
          - Retains **V1 field names** for easier migration from existing V1 operations, for example:
            - <a href="https://developer.zuora.com/v1-api-reference/api/operation/GET_RetrieveProductRatePlanCharge/" target="_blank">Retrieve a product rate plan charge</a>.
            - <a href="https://developer.zuora.com/v1-api-reference/api/operation/queryProductRatePlanByKey/" target="_blank">Retrieve a product rate plan</a>.
            - <a href="https://developer.zuora.com/v1-api-reference/api/operation/queryProductByKey/" target="_blank">Retrieve a product</a>.
          - Keeps certain objects, such as `netsuite` and `customFields`, as grouped structures instead of flattening them.

          **Recommended Usage** 
          - Use this operation if you are migrating from V1 APIs and need to maintain compatibility with existing integrations.
          - For new integrations, use the "Query products from the Product Catalog" operation instead, as it returns structured responses optimized for the **Commerce** feature.
      operationId: queryLegacyProducts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProductListLegacyRequest'
            examples:
              queryById:
                summary: Query product by ID and expand plans and charges
                value:
                  filters:
                    - field: id
                      operator: EQ
                      value: 7228c9e6fd814e3a9e59bcdf0117e34f
                  expand:
                    product_rate_plans: true
                    product_rate_plan_charges: true
      responses:
        '200':
          description: Successful query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProductListLegacyResponse'
              examples:
                response:
                  value:
                    values:
                      - id: ee2d1ce1036c4dd6ae9d6945565ff7a0
                        name: New prod
                        state: active
                        effectiveStartDate: '2024-01-01'
                        effectiveEndDate: '2050-12-31'
                        customFields:
                          InexedCFTest__c: Test1
                          nonidxpicklist__c: nidx1
                        productRatePlans:
                          - id: c3a52dd029704b7e89274c9e7e8fd99c
                            name: Demo Rate Plan
                            state: active
                            activeCurrencies:
                              - USD
                            productRatePlanCharges:
                              - id: ebcd93dc77b34d20912dbfae5881acff
                                name: Charge with state 2
                                type: Recurring
                                model: PerUnit
                                uom: Each
                                billingPeriod: Month
                                billingTiming: IN_ADVANCE
                                listPriceBase: Per_Billing_Period
                                pricing:
                                  - currency: USD
                                    price: 101
                                    tiers: []
                                attributes:
                                  - name: State
                                    type: String
                                    mapping:
                                      object: account
                                      field: state__c
                                  - name: EffectiveDate
                                    type: Datetime
                              - id: 5b8ec92e6af64e8fa2d8b9756b9fed10
                                name: Charge with state 1
                                type: Recurring
                                model: PerUnit
                                uom: Each
                                billingPeriod: Month
                                billingTiming: IN_ADVANCE
                                listPriceBase: Per_Billing_Period
                                pricing:
                                  - currency: USD
                                    price: 100
                                    tiers: []
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
          headers:
            Content-Encoding:
              description: >-
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses: - `application/json` - `application/xml` -
                `text/html` - `text/csv` - `text/plain` 
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >-
                The value of this header is:

                ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API ``` 
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
              examples:
                response:
                  value:
                    message: Authentication error
          headers:
            Content-Encoding:
              schema:
                type: string
            WWW-Authenticate:
              description: >
                The value of this header is:

                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                type: string
            Zuora-Request-Id:
              description: The Zuora internal identifier of the API call.
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Commerce
  /commerce/tiers:
    put:
      summary: Update a product rate plan charge tier
      description: >
        Updates the price and other editable attributes, when supported, for a
        specific **Product Rate Plan Charge Tier**.
      operationId: updateTier
      tags:
        - Commerce
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTierRequest'
            example:
              id: 8fe232784e7946f9aa79cfc8aad30bd9
              price: 450
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTierResponse'
              examples:
                response:
                  value:
                    createdById: 190758cda21c41138233263a951580b3
                    createdTime: '2025-10-15T19:07:25.000+00:00'
                    currency: USD
                    endingUnit: 0
                    id: 8fe232784e7946f9aa79cfc8aad30bd9
                    isOveragePrice: false
                    price: 450
                    priceFormat: price_format_flat_fee
                    startingUnit: 0
                    tier: '1'
                    updatedById: 190758cda21c41138233263a951580b3
                    updatedTime: '2025-10-15T20:47:58.000+00:00'
          headers:
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /commerce/purchase-options/list:
    post:
      description: >
        Retrieves one or more product rate plans (PRPs) from the Product Catalog
        based on specified filters such as product ID or PRP ID.

        You can optionally expand related product rate plan charges (PRPCs) in
        the response.
      operationId: queryPurchaseOptionsbyPRPID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseOptionRequest'
            examples:
              byPlanIdExpandCharges:
                summary: Filter by PRP ID and expand charges
                value:
                  filters:
                    - field: prp_id
                      operator: EQ
                      value:
                        string_value: 8a90f5088799c8ed01879cb4b47a3b1a
                  expand:
                    product_rate_plan_charges: true
              byProductId:
                summary: Filter by Product ID
                value:
                  filters:
                    - field: product_id
                      operator: EQ
                      value:
                        string_value: 8a90f5088799c8ed01879cb481d83b18
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOptionResponse'
              examples:
                sampleSuccess:
                  summary: Successful response with one PRP (matches the request above)
                  value:
                    error: null
                    productRatePlans:
                      - description: ''
                        endDate: '2026-04-20'
                        id: 8a90f5088799c8ed01879cb4b47a3b1a
                        name: New Rate Plan
                        product:
                          allowFeatureChanges: false
                          category: base
                          contextFilters: []
                          createdTime: '2023-04-19T20:28:08.000-07:00'
                          customFields:
                            prd_text_c__c: a
                          customObjects: null
                          description: ''
                          endDate: '2026-04-20'
                          features: []
                          id: 8a90f5088799c8ed01879cb481d83b18
                          legacyFeatures: []
                          name: ztax-product
                          netsuite: null
                          organizationLabels: []
                          productNumber: PC-00000037
                          productRatePlans: []
                          sku: SKU-00000043
                          startDate: '2022-04-04'
                          state: product_active
                        productId: 8a90f5088799c8ed01879cb481d83b18
                        productRatePlanCharges:
                          - accounting:
                              accountsReceivableAccount: Accounts Receivable
                              accountsReceivableAccountType: AccountsReceivable
                            attributes: []
                            billCycle:
                              period: bill_cycle_period_month
                              periodAlignment: align_to_charge
                              timing: in_advance
                              type: default_from_customer
                            chargeModel: flat_fee
                            chargeType: recurring
                            createdById: 2c92c8fb7a2d26b6017a2eaa64c72dea
                            customFieldId: '3687818732'
                            customFields:
                              IncludeTowardsMinimumCommitmentAmount__c: null
                              ProductType__c: null
                              TrueUpChargeLevel__c: null
                              TrueUpCharge__c: null
                              aaa__c: null
                            deliverySchedule:
                              frequency: delivery_frequency_unspecified
                              friday: false
                              monday: false
                              saturday: false
                              sunday: false
                              thursday: false
                              tuesday: false
                              wednesday: false
                            description: ''
                            discountOptions:
                              applyDetails: []
                              applyTo: []
                              applyToBillingPeriodPartially: false
                              reflectDiscountInNetAmount: false
                              rollover: false
                              stackedDiscount: false
                              drawdown: {}
                              endDateCondition: subscription_end
                              upToPeriodsType: billing_periods
                              upToPeriods: 0
                              listPriceBase: Per_Billing_Period
                              specificListPriceBase: 0
                            id: 8a90876c8799b81801879cb516f8400b
                            name: New Component
                            pricing:
                              adjustments: {}
                              discountAmounts: {}
                              discountPercentages: {}
                              flatAmounts:
                                USD: 100
                              maxAmounts: {}
                              metadata: {}
                              minAmounts: {}
                              percentages: {}
                              tiers: []
                              unitAmounts: {}
                            pricingSummary:
                              - USD100
                            revenue:
                              excludeItemBillingFromRevenueAccounting: false
                              excludeItemBookingFromRevenueAccounting: false
                              legacyReporting: false
                              revenueRecognitionCode: USD
                              revenueRecognitionRuleName: Recognize upon invoicing
                            taxMode: tax_exclusive
                            taxable: true
                            triggerEvent: contract_effective
                            updatedTime: '2023-04-19T20:28:46.000+00:00'
                        productRatePlanNumber: PRP-00000001
                        startDate: '2022-04-20'
                        state: active
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Query purchase options by PRP ID
      tags:
        - Commerce
  /v1/accounts:
    post:
      description: >
        Creates a customer account with a payment method, a bill-to contact,

        and optional sold-to and ship-to contacts. Request and response field
        descriptions and sample code are provided. Use this operation to
        optionally create a subscription,

        invoice for that subscription, and collect payment through the default
        payment method. The transaction is atomic; if any part fails for any
        reason, the entire

        transaction is rolled back.
         
        This operation is CORS Enabled, so you can use client-side Javascript to
        invoke the call.
         
        ### Notes


        1. The account is created in active status.  

        2. If the `autoPay` field is set to `true` in the request, you must
        provide one of the `paymentMethod`, `creditCard`, or
        `hpmCreditCardPaymentMethodId`

        field, but not multiple. The one provided becomes the default payment
        method

        for this account. If the credit card information is declined or cannot
        be verified,

        no account is created.

        3. Customer accounts created with this call are automatically

        be set to Auto Pay.

        4. If the `invoiceDeliveryPrefsEmail` field is not specified

        in the request, the account's email delivery preference is always
        automatically

        set to  `false`, no matter whether the  `workEmail`  or 
        `personalEmail`  field

        is specified.
         
        ### Defaults for customerAcceptanceDate and serviceActivationDate


        Default values for **customerAcceptanceDate** and
        **serviceActivationDate** are set as follows.


        |        | serviceActivationDate(SA) specified          |
        serviceActivationDate (SA) NOT specified  |

        | ------------- |:------------- | :-----|

        | customerAcceptanceDate (CA) specified| SA uses value in the request
        call; CA uses value in the request call| CA uses value in the request
        call;SA uses CE as default |

        | customerAcceptanceDate (CA) NOT specified      | SA uses value in the
        request call; CA uses SA as default |   SA and CA use CE as default |


        This call supports a subset of the functionality of our [Create an
        order](https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/)
        call. 

        For use cases where you create a subscription and a billing account at
        the same time, we recommend using "Create an order" instead of this
        call.

        The Orders call has the following advantages: 

        - Provides options for managing the entire subscription lifecycle from
        creation through to cancellation using different order actions. 

        - Allows the creation or modifying of multiple subscriptions in a single
        order. 

        - Allows a single order to combine both recurring subscription digital
        goods or services with order line items for physical goods.

        - Orders are treated as atomic transactions. If any part fails, the
        entire order, subscription, and billing account creation are rolled
        back.


        You should use this call if you need to create a standalone billing
        account, and create orders, subscriptions, standalone invoices, or
        dynamic usage charges later.

        There are no deprecation plans for this call and we will continue to
        support this call for existing users. 
      operationId: POST_Account
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTAccountType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    accountId: 8ad087d2909293cb0190964171da0999
                    accountNumber: A00000214
                    billToContactId: 8ad087d2909293cb019096417222099b
                    soldToContactId: 8ad087d2909293cb01909641723e099e
              schema:
                $ref: '#/components/schemas/POSTAccountResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an account
      tags:
        - Accounts
  /v1/accounts/{account-key}:
    delete:
      description: >
        Deletes a specific account asynchronously. 


        **Notes and Limitations:** 

        - For account deletion, the system will start a backend job to remove
        all transactions under the accounts and change the status of the
        accounts to 'Cancelled'. This backend job is asynchronous and will take
        some time, depending on the job size.  

        - An account cannot be deleted when the account is either the invoice
        owner or the subscription owner of a subscription and the subscription's
        invoice owner and subscription owner are two different accounts. An
        exception to this limitation is if the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Enable_Force_Deletion_for_Account.3F"
        target="_blank">Enable Force Deletion for Account?</a> setting is set to
        `Yes`, you can force delete an account that is the subscription owner of
        a subscription while the invoice owner is a different account. Force
        deleting this account deletes all its subscriptions, but the relevant
        invoices will not be impacted.

        - An account cannot be deleted if this account has ever been involved in
        an Owner Transfer amendment or order action, either as the current owner
        or as the previous owner. 
      operationId: DELETE_Account
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account number or account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 40288ae9600808280160081dc9c13f15
                    jobId: 40288ae9600808280160081db1533506
                    jobStatus: Pending
                    success: true
              schema:
                $ref: '#/components/schemas/DeleteAccountResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an account
      tags:
        - Accounts
    get:
      description: >
        Retrieves basic information about a customer account.


        This operation is a quick retrieval that doesn't include the account's
        subscriptions, invoices, payments, or usage details. Use Get account
        summary to get more detailed information about an account.
      operationId: GET_Account
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account number or account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    basicInfo:
                      accountNumber: A00000001
                      batch: Batch1
                      communicationProfileId: 303d186840e611df817c002185d714e1
                      crmId: ''
                      id: 402892c74c9193cd014c91d35b0a0132
                      invoiceTemplateId: null
                      name: Test
                      notes: ''
                      partnerAccount: false
                      profileNumber: CP-00000012
                      salesRep: ''
                      sequenceSetId: null
                      status: Active
                      summaryStatementTemplateId: ff808081298c6e5401298c7a845c007b
                    billToContact:
                      address1: ''
                      address2: ''
                      city: ''
                      country: null
                      county: null
                      fax: ''
                      firstName: Test
                      homePhone: ''
                      id: 2c9081a03c6d7b51013c6d7e46c80a17
                      lastName: Test
                      mobilePhone: ''
                      nickname: ''
                      otherPhone: ''
                      otherPhoneType: null
                      personalEmail: ''
                      state: ''
                      taxRegion: null
                      workEmail: contact@example.com
                      workPhone: ''
                      zipCode: ''
                    billingAndPayment:
                      additionalEmailAddresses:
                        - contact1@example.com
                        - contact2@example.com
                      autoPay: true
                      billCycleDay: 1
                      currency: USD
                      defaultPaymentMethodId: 2c93808457d787030157e03220ec4fad
                      invoiceDeliveryPrefsEmail: true
                      invoiceDeliveryPrefsPrint: false
                      paymentMethodCascadingConsent: false
                      paymentGateway: TestGateway
                      paymentTerm: Net 30
                    einvoiceProfile:
                      businessCategory: B2B
                      businessName: legal business name
                      businessNumber: '20002039'
                      businessNumberSchemeId: '88'
                      enabled: true
                      endpointId: '8992'
                      endpointSchemeId: '88'
                      taxRegisterNumber: TAX393999
                    metrics:
                      balance: 0
                      contractedMrr: -900
                      creditBalance: 0
                      totalInvoiceBalance: 0
                    metricsData:
                      - balance: 0
                        contractedMrr: -900
                        currency: USD
                        reservedPaymentAmount: 900
                        totalDebitMemoBalance: 0
                        totalInvoiceBalance: 0
                        unappliedCreditMemoAmount: 0
                        unappliedPaymentAmount: 0
                      - balance: 0
                        contractedMrr: -900
                        currency: EUR
                        reservedPaymentAmount: -900
                        totalDebitMemoBalance: 0
                        totalInvoiceBalance: 0
                        unappliedCreditMemoAmount: 0
                        unappliedPaymentAmount: 0
                    soldToContact:
                      address1: ''
                      address2: ''
                      city: ''
                      country: null
                      county: null
                      fax: ''
                      firstName: Test
                      homePhone: ''
                      id: 2c9081a03c6d7b51013c6d7e46cf0a18
                      lastName: Test
                      mobilePhone: ''
                      nickname: ''
                      otherPhone: ''
                      otherPhoneType: null
                      personalEmail: ''
                      state: ''
                      taxRegion: null
                      workEmail: contact@example.com
                      workPhone: ''
                      zipCode: ''
                    success: true
              schema:
                $ref: '#/components/schemas/GETAccountType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an account
      tags:
        - Accounts
    put:
      description: >
        Updates a customer account by specifying the account-key.


        ### Notes

        1. Only the fields to be changed should be specified.  Any field that is
        not included in the request body will not be changed.

        2. If an empty field is submitted with this operation, the corresponding
        field in the account is emptied.

        3. Email addresses: If no email addresses are specified, no change is
        made to the email addresses or to the email delivery preference. If
        either the **personalEmail** or **workEmail** of **billToContact** is
        specified (or both), the system updates the corresponding email
        address(es) and the email delivery preference is set to `true`. (In that
        case, emails go to the **workEmail** address, if it exists, or else the
        **personalEmail**.) On the other hand, if as a result of this call both
        of the email addresses for the account are empty, the email delivery
        preference is set to `false`.

        4. The Bill To, Sold To, and Ship To contacts are separate contact
        entities. However, if you set the `soldToSameAsBillTo` field to `true`
        when creating an account, the Bill To and Sold To contacts will refer to
        the same contact entity. As a result, updating either contact will
        update both. The same behavior applies to the `shipToSameAsBillTo` field
        and the Ship To contact. In this case, if you want to update only one of
        the contacts, you must create a new contact and then update the Bill To,
        Sold To, or Ship To contact to reference the newly created one.
      operationId: PUT_Account
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account number or account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTAccountType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an account
      tags:
        - Accounts
  /v1/accounts/{account-key}/payment-methods:
    get:
      description: >
        Retrieves the payment methods of the specified customer account.


        **Note:** This operation also supports retrieving custom payment methods
        created through the [Open Payment
        Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
        service.
      operationId: GET_AcountPaymentMethods
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account number or account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - description: >-
            Indicates whether to only retrieve the default payment method of the
            account. The default value is `false`. If this parameter is set to
            `true`, only the default payment method is retrieved.
          in: query
          name: isDefaultOnly
          required: false
          schema:
            type: boolean
        - description: >-
            Indicates whether to only retrieve the active payment methods of the
            account. The default value is `false`. If this parameter is set to
            `true`, only the active payment methods are retrieved.
          in: query
          name: isActiveOnly
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    ach:
                      - AA_PICKLIST__c: null
                        accountHolderInfo:
                          accountHolderName: null
                          addressLine1: DSDFD
                          addressLine2: ''
                          city: Example City
                          country: United States
                          email: test@test.com
                          phone: '2554444'
                          state: Example State
                          zipCode: '123456'
                        accountKey: 4028839f7ca29000017ca29c1ce8003f
                        bankABACode: '110000000'
                        bankAccountName: Test
                        bankAccountNumber: '********6789'
                        bankAccountType: Checking
                        bankIdentificationNumber: null
                        bankName: Chase
                        createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2021-10-27 05:32:19'
                        deviceSessionId: null
                        existingMandate: null
                        id: 4028839f7cc14262017cc1bca9eb0008
                        ipAddress: null
                        isDefault: false
                        lastFailedSaleTransactionDate: null
                        lastTransaction: Approved
                        lastTransactionDateTime: '2021-10-27 05:32:19'
                        lastTransactionStatus: Approved
                        mandateInfo:
                          existingMandateStatus: null
                          mandateCreationDate: null
                          mandateId: null
                          mandateReason: null
                          mandateReceivedStatus: null
                          mandateStatus: null
                          mandateUpdateDate: null
                        maxConsecutivePaymentFailures: null
                        numConsecutiveFailures: 0
                        paymentRetryWindow: null
                        status: Active
                        totalNumberOfErrorPayments: 0
                        totalNumberOfProcessedPayments: 0
                        type: ACH
                        updatedBy: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2021-11-10 00:50:12'
                        useDefaultRetryRule: true
                    creditcard:
                      - AA_PICKLIST__c: null
                        accountHolderInfo:
                          accountHolderName: John Smith
                          addressLine1: ABC
                          addressLine2: EFT
                          city: Example City
                          country: United States
                          email: example@google.com
                          phone: '86123456789'
                          state: Example State
                          zipCode: '123456'
                        accountKey: 4028839f7ca29000017ca29c1ce8003f
                        bankIdentificationNumber: '411111'
                        cardNumber: '************1111'
                        createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2021-11-15 18:59:08'
                        creditCardType: Visa
                        deviceSessionId: null
                        existingMandate: null
                        expirationMonth: 11
                        expirationYear: 2027
                        id: 4028839f7d26a155017d26af16ef0001
                        identityNumber: '97370192024'
                        ipAddress: null
                        isDefault: true
                        lastFailedSaleTransactionDate: null
                        lastTransaction: Approved
                        lastTransactionDateTime: '2021-11-15 18:59:08'
                        lastTransactionStatus: Approved
                        mandateInfo:
                          mitConsentAgreementRef: null
                          mitConsentAgreementSrc: null
                          mitProfileAction: null
                          mitProfileAgreedOn: null
                          mitProfileType: null
                          mitTransactionId: null
                        maxConsecutivePaymentFailures: null
                        numConsecutiveFailures: 0
                        paymentRetryWindow: null
                        status: Active
                        totalNumberOfErrorPayments: 0
                        totalNumberOfProcessedPayments: 0
                        type: CreditCard
                        updatedBy: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2021-11-15 18:59:08'
                        useDefaultRetryRule: true
                    creditcardreferencetransaction:
                      - AA_PICKLIST__c: null
                        accountHolderInfo:
                          accountHolderName: ''
                          addressLine1: ''
                          addressLine2: ''
                          city: ''
                          country: null
                          email: ''
                          phone: null
                          state: ''
                          zipCode: ''
                        accountKey: 4028839f7ca29000017ca29c1ce8003f
                        bankIdentificationNumber: null
                        cardNumber: null
                        createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2021-11-03 22:35:59'
                        creditCardType: Visa
                        deviceSessionId: null
                        existingMandate: null
                        expirationMonth: 11
                        expirationYear: 2021
                        id: 4028839f7ce8c530017ce9725e2c0003
                        ipAddress: null
                        isDefault: false
                        lastFailedSaleTransactionDate: null
                        lastTransaction: Approved
                        lastTransactionDateTime: '2021-11-03 22:35:59'
                        lastTransactionStatus: Approved
                        mandateInfo:
                          mitConsentAgreementRef: null
                          mitConsentAgreementSrc: null
                          mitProfileAction: null
                          mitProfileAgreedOn: null
                          mitProfileType: null
                          mitTransactionId: null
                        maxConsecutivePaymentFailures: null
                        numConsecutiveFailures: 0
                        paymentRetryWindow: null
                        secondTokenId: FGDSDF
                        status: Active
                        tokenId: ABCE
                        totalNumberOfErrorPayments: 0
                        totalNumberOfProcessedPayments: 0
                        type: CreditCardReferenceTransaction
                        updatedBy: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2021-11-03 22:35:59'
                        useDefaultRetryRule: true
                    debitcard:
                      - AA_PICKLIST__c: null
                        accountHolderInfo:
                          accountHolderName: John Smith
                          addressLine1: 1051 E Hillsdale Blvd
                          addressLine2: ''
                          city: Tynan
                          country: United States
                          email: smith@example.com
                          phone: ''
                          state: California
                          zipCode: '45101'
                        accountKey: 4028839f7ca29000017ca29c1ce8003f
                        bankIdentificationNumber: '588888'
                        cardNumber: '************8888'
                        createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2021-11-01 00:01:52'
                        creditCardType: Electron
                        deviceSessionId: null
                        existingMandate: null
                        expirationMonth: 11
                        expirationYear: 2021
                        id: 4028839f7cd92a6b017cda4defd00006
                        ipAddress: null
                        isDefault: false
                        lastFailedSaleTransactionDate: null
                        lastTransaction: Approved
                        lastTransactionDateTime: '2021-11-01 00:01:53'
                        lastTransactionStatus: Approved
                        mandateInfo:
                          mitConsentAgreementRef: null
                          mitConsentAgreementSrc: null
                          mitProfileAction: null
                          mitProfileAgreedOn: null
                          mitProfileType: null
                          mitTransactionId: null
                        maxConsecutivePaymentFailures: null
                        numConsecutiveFailures: 0
                        paymentRetryWindow: null
                        status: Active
                        totalNumberOfErrorPayments: 0
                        totalNumberOfProcessedPayments: 0
                        type: CreditCard
                        updatedBy: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2021-11-01 00:01:52'
                        useDefaultRetryRule: true
                    defaultPaymentMethodId: 4028839f7d26a155017d26af16ef0001
                    paymentGateway: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETAccountPaymentMethodType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List payment methods of an account
      tags:
        - Accounts
  /v1/accounts/{account-key}/payment-methods/cascading:
    get:
      summary: Retrieve configuration of cascading payment methods for an account
      description: >
        Zuora provides the Cascading Payment Method feature to dynamically retry
        the failed payment with alternative payment methods according to a
        predefined priority list. Use this API operation to retrieve the
        configuration information for Cascading Payment Method of a specified
        account, including the cascading consent value and the priority list of
        payment methods.


        Before you use this API operation, ensure that the Cascading Payment
        Method feature is enabled. For more information about the Cascading
        Payment Method feature, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B2_Cascade_payment_methods"
        target="_blank">Cascade payment methods</a>.
      operationId: GetAccountPaymentMethodCascading
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    consent: true
                    priorities:
                      - paymentMethodId: 2c92c0f95be68649015bf14e001f2760
                        order: 1
                      - paymentMethodId: 2c92c0f95be68649015bf14e001f2761
                        order: 2
                      - paymentMethodId: 2c92c0f95be68649015bf14e001f2762
                        order: 3
                    success: true
              schema:
                $ref: >-
                  #/components/schemas/GetCascadingPaymentMethodsConfigurationResponse
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Accounts
    put:
      summary: Configure cascading payment methods for an account
      description: >
        Zuora provides the Cascading Payment Method feature to dynamically retry
        the failed payment with alternative payment methods according to a
        predefined priority list. Use this API operation to configure the
        cascading consent for a specified account and set up the priority list
        of payment methods to be used in Cascading Payment Method.


        Before you use this API operation, ensure that the Cascading Payment
        Method feature is enabled. For more information about the Cascading
        Payment Method feature, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B2_Cascade_payment_methods"
        target="_blank">Cascade payment methods</a>.
      operationId: PutAccountPaymentMethodCascading
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PutCascadingPaymentMethodsConfigurationRequest
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Accounts
  /v1/accounts/{account-key}/payment-methods/default:
    get:
      description: >-
        Retrieves the default payment method of the specified customer account.


        **Notes:** <ul><li>This operation also supports retrieving the custom
        payment method created through the [Open Payment
        Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
        service. </li></ul> <ul><li>This operation only works with an electronic
        payment method and does not work with non-electronic payment
        methods.</li></ul> 
      operationId: GET_AcountDefaultPaymentMethod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account number or account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    AA_PICKLIST__c: null
                    accountHolderInfo:
                      accountHolderName: John Smith
                      addressLine1: ABC
                      addressLine2: EFT
                      city: Example City
                      country: United States
                      email: example@google.com
                      phone: '86123456789'
                      state: Example State
                      zipCode: '844000'
                    accountKey: 4028839f7ca29000017ca29c1ce8003f
                    bankIdentificationNumber: '411111'
                    cardNumber: '************1111'
                    createdBy: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2021-11-15 18:59:08'
                    creditCardType: Visa
                    deviceSessionId: null
                    existingMandate: null
                    expirationMonth: 11
                    expirationYear: 2027
                    id: 4028839f7d26a155017d26af16ef0001
                    identityNumber: '97370192024'
                    ipAddress: null
                    isDefault: true
                    lastFailedSaleTransactionDate: null
                    lastTransaction: Approved
                    lastTransactionDateTime: '2021-11-15 18:59:08'
                    lastTransactionStatus: Approved
                    mandateInfo:
                      mitConsentAgreementRef: null
                      mitConsentAgreementSrc: null
                      mitProfileAction: null
                      mitProfileAgreedOn: null
                      mitProfileType: null
                      mitTransactionId: null
                    maxConsecutivePaymentFailures: null
                    numConsecutiveFailures: 0
                    paymentRetryWindow: null
                    status: Active
                    success: true
                    totalNumberOfErrorPayments: 0
                    totalNumberOfProcessedPayments: 0
                    type: CreditCard
                    updatedBy: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2021-11-15 18:59:08'
                    useDefaultRetryRule: true
              schema:
                $ref: '#/components/schemas/GETPaymentMethodResponseForAccount'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve the default payment method of an account
      tags:
        - Accounts
  /v1/accounts/{account-key}/summary:
    get:
      description: >
        Retrieves detailed information about the specified customer account.


        The response includes the account information and a summary of the
        account’s subscriptions, invoices, payments, and usages.


        ### Notes

        Returns only the six most recent subscriptions based on the subscription
        updatedDate. Within those subscriptions, there may be many rate plans
        and many rate plan charges. These items are subject to the maximum limit
        on the array size. 
      operationId: GET_AccountSummary
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Account number or account ID.
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - description: >-
            Indicate whether to exclude usage information in the response. The
            default value is `false`.
          in: query
          name: excludeUsage
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    basicInfo:
                      accountNumber: A00001115
                      additionalEmailAddresses:
                        - contact1@example.com
                        - contact2@example.com
                      autoPay: true
                      balance: 0
                      billCycleDay: 1
                      currency: USD
                      defaultPaymentMethod:
                        creditCardExpirationMonth: 10
                        creditCardExpirationYear: 2020
                        creditCardNumber: '************1111'
                        creditCardType: Visa
                        id: 2c92c8f83dabf9cf013daef12dd303b0
                        paymentMethodType: CreditCard
                      id: 2c92a0f9391832b10139183e277a0042
                      invoiceDeliveryPrefsEmail: true
                      invoiceDeliveryPrefsPrint: false
                      lastInvoiceDate: '2013-02-11'
                      lastPaymentAmount: 150248.1
                      lastPaymentDate: '2013-03-27'
                      name: subscribeCallYan_1
                      partnerAccount: false
                      paymentMethodCascadingConsent: false
                      status: Active
                    billToContact:
                      address1: 1400 Bridge Pkwy
                      address2: ''
                      city: San Jose
                      country: United States
                      county: ''
                      fax: ''
                      firstName: Cheng
                      id: 2c92a0f9391832b10139183e27940043
                      lastName: Zou
                      state: California
                      taxRegion: ''
                      workEmail: contact@example.com
                      workPhone: '5555551212'
                      zipCode: '95135'
                    invoices:
                      - amount: 139722.1
                        balance: 0
                        dueDate: '2013-02-11'
                        id: 2c92a0953a3fa95d013a407c10a60100
                        invoiceDate: '2013-02-11'
                        invoiceNumber: INV00000323
                        status: Posted
                      - amount: 10521
                        balance: 0
                        dueDate: '2012-08-11'
                        id: 2c92a09739190dc60139194bcf1b0098
                        invoiceDate: '2012-08-11'
                        invoiceNumber: INV00000160
                        status: Posted
                      - amount: 10
                        balance: 0
                        dueDate: '2012-08-11'
                        id: 2c92a09539190dbe0139190f42780012
                        invoiceDate: '2012-08-11'
                        invoiceNumber: INV00000159
                        status: Posted
                    payments:
                      - effectiveDate: '2013-03-27'
                        id: 2c92c8f83dabf9cf013daf3bfa0305a6
                        paidInvoices:
                          - appliedPaymentAmount: 5
                            invoiceId: 2c92a09539190dbe0139190f42780012
                            invoiceNumber: INV00000159
                          - appliedPaymentAmount: 139722.1
                            invoiceId: 2c92a0953a3fa95d013a407c10a60100
                            invoiceNumber: INV00000323
                          - appliedPaymentAmount: 10521
                            invoiceId: 2c92a09739190dc60139194bcf1b0098
                            invoiceNumber: INV00000160
                        paymentNumber: P-00000075
                        paymentType: Electronic
                        status: Processed
                      - effectiveDate: '2012-08-11'
                        id: 2c92a0f9391832b101391922ad5f049d
                        paidInvoices:
                          - appliedPaymentAmount: 5
                            invoiceId: 2c92a09539190dbe0139190f42780012
                            invoiceNumber: INV00000159
                        paymentNumber: P-00000056
                        paymentType: Electronic
                        status: Processed
                    soldToContact:
                      address1: 278 Bridgeton Circle
                      address2: ''
                      city: San Jose
                      country: United States
                      county: ''
                      fax: ''
                      firstName: Bill
                      id: 2c92a0f9391832b10139183e27940043
                      lastName: Cho
                      state: California
                      taxRegion: ''
                      workEmail: contact@example.com
                      workPhone: '5555551212'
                      zipCode: '95135'
                    subscriptions:
                      - autoRenew: true
                        id: 2c92c8f83dc4f752013dc72c24ee016d
                        initialTerm: 12
                        ratePlans:
                          - productName: Recurring Charge
                            ratePlanName: QSF_Tier
                        renewalTerm: 3
                        status: Active
                        subscriptionNumber: A-S00001081
                        subscriptionStartDate: '2013-02-01'
                        termEndDate: '2014-02-01'
                        termStartDate: '2013-02-01'
                        termType: TERMED
                      - autoRenew: true
                        id: 2c92c8f83dc4f752013dc72bb85c0127
                        initialTerm: 12
                        ratePlans:
                          - productName: Recurring Charge
                            ratePlanName: QSF_Tier
                        renewalTerm: 3
                        status: Active
                        subscriptionNumber: A-S00001080
                        subscriptionStartDate: '2013-02-01'
                        termEndDate: '2014-02-01'
                        termStartDate: '2013-02-01'
                        termType: TERMED
                      - autoRenew: false
                        id: 2c92c8f83dc4f752013dc723fdab00d4
                        initialTerm: 10
                        ratePlans:
                          - productName: Recurring Charge
                            ratePlanName: QSF_Tier
                        renewalTerm: 4
                        status: Cancelled
                        subscriptionNumber: A-S00001079
                        subscriptionStartDate: '2013-02-01'
                        termEndDate: '2014-04-01'
                        termStartDate: '2013-12-01'
                        termType: TERMED
                      - autoRenew: false
                        id: 2c92c8f83db0b4b4013db4717ad000ec
                        initialTerm: 12
                        ratePlans:
                          - productName: Recurring Charge
                            ratePlanName: Month_PerUnit
                          - productName: Recurring Charge
                            ratePlanName: Month_PerUnit
                        renewalTerm: 3
                        status: Active
                        subscriptionNumber: A-S00001076
                        subscriptionStartDate: '2011-02-11'
                        termEndDate: '2012-02-11'
                        termStartDate: '2011-02-11'
                        termType: TERMED
                      - autoRenew: false
                        id: 2c92c8f83db0b4b4013db3ab6a4d00bc
                        initialTerm: 12
                        ratePlans:
                          - productName: Recurring Charge
                            ratePlanName: Month_PerUnit
                          - productName: Recurring Charge
                            ratePlanName: Month_PerUnit
                        renewalTerm: 3
                        status: Active
                        subscriptionNumber: A-S00001075
                        subscriptionStartDate: '2011-02-11'
                        termEndDate: '2012-02-11'
                        termStartDate: '2011-02-11'
                        termType: TERMED
                      - autoRenew: false
                        id: 2c92c8f83db0b4b4013db3aa9fbd0090
                        initialTerm: 12
                        ratePlans:
                          - productName: Recurring Charge
                            ratePlanName: Month_PerUnit
                        renewalTerm: 3
                        status: Active
                        subscriptionNumber: A-S00001074
                        subscriptionStartDate: '2011-02-11'
                        termEndDate: '2012-02-11'
                        termStartDate: '2011-02-11'
                        termType: TERMED
                    success: true
                    usage:
                      - quantity: 10
                        startDate: 2012-02
                        unitOfMeasure: UOM
                      - quantity: 10
                        startDate: 2012-01
                        unitOfMeasure: UOM
              schema:
                $ref: '#/components/schemas/GETAccountSummaryType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an account summary
      tags:
        - Accounts
  /v1/contacts:
    post:
      description: >
        Creates a contact for a specified account. Each account must have at
        least one contact before it can be saved. You can add a maximum of 2000
        contacts to an account.
      operationId: POST_CreateContact
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTContactType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 6e767220676e6e61206776652075207570
                    accountNumber: A00000001
                    address1: 314, Bongora
                    address2: near Tech City
                    city: GHY
                    contactDescription: This is a description for the contact
                    country: India
                    county: null
                    fax: '6174'
                    firstName: Kuhi
                    homePhone: '1234123'
                    id: 6b65657020726f6c6c696e672021
                    lastName: Das
                    mobilePhone: '123213'
                    nickname: Dorimi
                    otherPhone: '2314213'
                    otherPhoneType: Work
                    personalEmail: kuhiroll@example.com
                    state: Assam
                    success: true
                    taxRegion: California
                    workEmail: amy.lawrence@zuora.com
                    workPhone: (888) 976-9056
                    zipCode: '123456'
              schema:
                $ref: '#/components/schemas/ContactResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a contact
      tags:
        - Contacts
  /v1/contacts/{contactId}:
    delete:
      description: |
        Deletes a contact.
      operationId: DELETE_Contact
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID of the contact that you want to delete.
          in: path
          name: contactId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a contact
      tags:
        - Contacts
    get:
      description: |
        Retrieves detailed information about a specific contact.
      operationId: GET_Contact
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID of the contact that you want to retrieve.
          in: path
          name: contactId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 72756e2061726e642026206465736572742075
                    accountNumber: A00000001
                    address1: 567, Rose Apartment
                    address2: Gate no. 2
                    city: Seattle
                    contactDescription: This is a description
                    country: United States
                    county: King County
                    fax: '123456'
                    firstName: peter
                    homePhone: '86123456789'
                    id: 402881a2889f2e4301889f30e64e0019
                    lastName: parker
                    mobilePhone: '1234567890'
                    nickname: peet
                    otherPhone: '11111111111111111'
                    otherPhoneType: Work
                    personalEmail: peet@example.com
                    state: Washington
                    success: true
                    taxRegion: CA
                    workEmail: work.mail@example.com
                    workPhone: '3432'
                    zipCode: '123134'
              schema:
                $ref: '#/components/schemas/ContactResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a contact
      tags:
        - Contacts
    put:
      description: |
        Updates a contact for a specified account.

        You can update contacts for cancelled accounts.
      operationId: PUT_Contact
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID of the contact that you want to update.
          in: path
          name: contactId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTContactType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 6e767220676e6e61206d616b65207520637279
                    accountNumber: A00000001
                    address1: new Address
                    address2: near Tech City
                    city: Mumbai
                    contactDescription: This is the new Description
                    country: India
                    county: null
                    fax: '6174'
                    firstName: Kuhi
                    homePhone: '1234123'
                    id: 8a90f50888a3036e0188ab7b3ffe7b8a
                    lastName: Das
                    mobilePhone: '123213'
                    nickname: Dorimi
                    otherPhone: '2314213'
                    otherPhoneType: Work
                    personalEmail: kuhiroll@example.com
                    state: Assam
                    success: true
                    taxRegion: California
                    workEmail: amy.lawrence@zuora.com
                    workPhone: (888)976-9056
                    zipCode: '123134'
              schema:
                $ref: '#/components/schemas/ContactResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a contact
      tags:
        - Contacts
  /v1/contacts/{contactId}/transfer:
    put:
      description: >
        This operation transfers contacts of the accounts within the Customer
        Hierarchy when removing the account.
      operationId: transferContent
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: |
            The ID of the contact that you want to scrub sensitive data from.
          in: path
          name: contactId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTTransferContact'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Transfer a contact
      tags:
        - Contacts
  /v1/contacts/{contactId}/scrub:
    put:
      description: >

        Scrubs the sensitive data of a specific contact. 


        You can use this operation to replace all sensitive data in a contact
        and its related contact snapshot with dummy values that will be stored
        in Zuora databases. 


        After scrubbing a contact, it is good practice to delete it. Otherwise,
        it might cause errors in subsequent operations.


        **Note**: To use this operation, you must ensure that the "Scrub
        Sensitive Data of Contact" billing permission is enabled in your user
        role. Contact your tenant administrator if you want to enable this
        permission. See [Scrub
        Contacts](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/A_How_to_Manage_Customer_Accounts/B_Key_Contacts/Scrub_Contacts)
        for more information.
      operationId: PUT_ScrubContact
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID of the contact that you want to scrub sensitive data from.
          in: path
          name: contactId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Scrub a contact
      tags:
        - Contacts
  /v1/contact-snapshots/{contact-snapshot-id}:
    get:
      description: >
        Retrieves detailed information about the snapshot of a contact, either a
        bill-to contact or sold-to contact.
      operationId: GET_ContactSnapshot
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID of the contact snapshot to be retrieved. For example,
            2c92c8955bd63cc1015bd7c151af02ab.
          in: path
          name: contact-snapshot-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    address1: 4th street Custom colony
                    address2: Thoraipakkam
                    city: Chennai
                    contactId: 4028c7628741ebe3018745f2c4123514
                    country: India
                    county: null
                    description: null
                    fax: 43212
                    firstName: Pat
                    homePhone: 9877
                    id: 4028c7628741ebe3018745f2c4133515
                    lastName: Parker
                    mobilePhone: '1234567890'
                    nickname: this is a nick name
                    otherPhone: '9876543210'
                    otherPhoneType: Work
                    personalEmail: test123@gmail.com
                    postalCode: 123456
                    state: TN
                    success: true
                    taxRegion: California
                    workEmail: amy.lawrence@zuora.com
                    workPhone: (888)976-9056
              schema:
                $ref: '#/components/schemas/GETContactSnapshotResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a contact snapshot
      tags:
        - Contact Snapshots
  /v1/sign-up:
    post:
      description: >
        This call performs many actions. You can use this operation to implement
         the standard requirements for signing up a customer, such as validating the
         uniqueness of an account and limiting the number of subscriptions per account.
         Also, you can use this operation to create a subscription, generate an invoice,
         and collect payment for a new or existing customer. 
         
         **Note:** You need to
         have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders)
         or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization)
         feature enabled to use this API. For a new customer, you can perform the
         following tasks in one call. Note that you can skip creating a payment meethod
         and still get the subscription and invoice successfully created.
         * Create an account
         * Create a payment method
         * Subscribe to a product in the product catalog and create a subscription
         * Generate an invoice
         * Collect payment

        For an existing customer, you can use an account identification field of
        an

        external system to specify the account. You can make [make asynchronous
        requests](https://developer.zuora.com/rest-api/general-concepts/async-requests/)

        when using the "Sign up" operation.


        This call supports a subset of the functionality of our [Create an
        order](https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/)
        call. 

        We generally recommend using "Create an order" instead of this call
        because the Orders call has the following advantages: 

        - Provides options for managing the entire subscription lifecycle from
        creation through to cancellation using different order actions. 

        - Allows the creation or modifying of multiple subscriptions in a single
        order. 

        - Allows a single order to combine both recurring subscription digital
        goods or services with order line items for physical goods.

        - Orders are treated as atomic transactions. If any part fails, the
        entire order, subscription, and billing account creation are rolled
        back.


        This call does have some unique abilities not supported by "Create an
        order". You should consider using this call when you need to:


        - Use Account UPSERT functionality by specifying a custom external
        identifier.

        - Limit the number of subscriptions on an account


        There are no deprecation plans for this call and we will continue to
        support this call. 
      operationId: POST_SignUp
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Charge_Metrics_Accept'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignUpRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028818284f5f8130184f5fe1e9011e8
                    accountNumber: A00000001
                    invoiceId: 4028818284f5f8130184f5fe23b8120c
                    invoiceNumber: INV00000001
                    orderNumber: O-00000001
                    paidAmount: 300
                    paymentId: 4028818284f5f8130184f5fe24b71218
                    paymentNumber: P-00000001
                    status: Completed
                    subscriptionId: 4028818284f5f8130184f5fe214611f3
                    subscriptionNumber: A-S00000001
                    success: true
              schema:
                $ref: '#/components/schemas/SignUpResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Sign up
      tags:
        - Sign Up
  /v1/orders/preview:
    post:
      description: >
        **Notes**:  
         - This operation is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders" target="_blank">Orders</a> feature enabled. If you are an existing Zuora <a href= "https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend"
         target= "_blank">Subscribe and Amend</a> customer, we recommend you enable
         <a href= "https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization"
         target= "_blank">Orders Harmonization</a> to access the <a href= "https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"
         target=  "_blank">Orders</a> feature. With Orders, you can access both existing
         functions for subscription and billing management and the new features on Zuora Billing.  
         - The [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
         feature is now generally available to all Zuora customers. You need to enable
         the [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
         feature to access the [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
         feature. As of Zuora Billing Release 313 (November 2021), new customers who
         onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
         will have the [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
         feature enabled by default. 
         - You cannot preview enhanced discounts and usage charges.
         - You can skip the accounting period validation to avoid backdated subscription cancellation caused order preview failure. To skip the accounting period validation, submit a request at <a href="https://support.zuora.com" target="_blank">Zuora Global Support</a>. 

        Retrieves the preview of the charge metrics and invoice items of a
        specified order. Preview for subscriptions and order line items are both
        supported. This operation is only an order preview and no order is
        created.


        You can also use this operation to preview billing for a standalone
        order. For more information, see <a href=
        "https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders/create-a-subscription-using-a-standalone-order"
        target="_blank">Preview billing for a standalone order</a>.


        #### Billing preview behavior regarding draft invoices 

        By default, the billing preview behavior regarding draft invoices is as
        below:

        - When you preview billing for your order and the order contains
        subscriptions only, the draft invoices are excluded.

        - When you preview billing for your order and the order contains order
        line items only, the draft invoices are included.

        - When you preview billing for an order that contains both
        subscriptions  order line items, the draft invoices are included for
        both subscriptions and order line items.
          
        However, if you want to always exclude the draft invoices in billing
        preview, submit a request at <a href="https://support.zuora.com"
        target="_blank">Zuora Global Support</a>. 


        #### Limits on Orders API

        The limit of orders allowed on a subscription is 1000.


        The limit of order line items allowed in an order is 100.


        Zuora has the following limits on the Orders synchronous API to prevent
        performance degradation: 

        - Up to 50 subscriptions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        - Up to 50 order actions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        - Up to 50 order actions are allowed on a single subscription in a
        [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.


        If you have an Order that exceeds any limits of the above, Zuora
        recommends you use the following asynchronous API operations: 

        - [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)

        - [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)

        - [Retrieve the status and response of a
        job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse)
         for checking the status of the asynchronous API operations 

        Zuora has the following limits on the Orders asynchronous API operations
        to prevent performance degradation:

        - Up to 300 subscriptions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
         or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
         operation call.
        - Up to 300 order actions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.

        - Up to 300 order actions are allowed on a single subscription\
         in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
         operation call.
      operationId: POST_PreviewOrder
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Indicates whether to return aggregated invoice item summaries for
            each invoice.


            With this parameter set to `true`, the `invoices` >
            `invoiceItemSummary` field is returned in the preview result. 

            The aggregated `invoiceItemSummary` field provides a forecast of the
            number of future invoices (`previewInvoiceSequence`), and the
            following information for each invoice:
              - `subTotal`
              - `total`
              - `taxAmount`
              - `discountAmount`
              - `servicePeriodStartDate`
              - `servicePeriodEndDate`
          name: summarizeInvoiceItem
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderPreviewRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    previewResult:
                      invoices:
                        - amount: 14.99
                          amountWithoutTax: 14.99
                          taxAmount: 0
                          targetDate: '2024-07-31'
                          invoiceItems:
                            - serviceStartDate: '2024-07-01'
                              serviceEndDate: '2024-07-31'
                              amountWithoutTax: 14.99
                              taxAmount: 0
                              chargeDescription: ''
                              chargeName: Monthly Fee
                              chargeNumber: null
                              processingType: Charge
                              productName: Music Service
                              productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
                              unitPrice: 14.99
                              subscriptionNumber: null
                              orderLineItemNumber: null
                              additionalInfo:
                                quantity: 1
                                unitOfMeasure: ''
                                numberOfDeliveries: 0
              schema:
                $ref: '#/components/schemas/PostOrderPreviewResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Preview an order
      tags:
        - Orders
  /v1/async/orders/preview:
    post:
      description: >
        **Notes:** 

        - This operation is only available if you have the
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature enabled. Orders is now generally available as of Zuora Billing
        Release 284 (August 2020). If you are an existing Zuora <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the new
        features on Zuora Billing.  

        - The [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature to access the [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature enabled by default.        

        - You cannot preview enhanced discounts and usage charges.


        In the case where a normal "Preview an order" operation call will time
        out, use this operation instead to preview an order asynchronously. A
        job will be previewing the order in the back end; the job ID will be
        returned for tracking the job status and result.


        #### Billing preview behavior regarding draft invoices

        By default, the billing preview behavior regarding draft invoices is as
        below:

        * When you preview billing for your order and the order contains
        subscriptions only, the draft invoices are excluded.

        * When you preview billing for your order and the order contains order
        line items only, the draft invoices are included.

        * When you preview billing for an order that contains both
        subscriptions  order line items, the draft invoices are included for
        both subscriptions and order line items.


        However, if you want to always exclude the draft invoices in billing
        preview, submit a request at [Zuora Global
        Support](https://support.zuora.com).


        #### Limits on Orders API


        The limit of orders allowed on a subscription is 1000.


        The limit of order line items allowed in an order is 100.


        Zuora has the following limits on the Orders synchronous API to prevent
        performance degradation: 

        * Up to 50 subscriptions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        * Up to 50 order actions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        * Up to 50 order actions are allowed on a single subscription in a
        [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.


        If you have an Order that exceeds any limits of the above, Zuora
        recommends you use the following asynchronous API operations:

        * [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)

        * [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)

        * [Retrieve the status and response of a
        job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse)
        for checking the status of the asynchronous API operations


        Zuora has the following limits on the Orders asynchronous API operations
        to prevent performance degradation:

        * Up to 300 subscriptions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.

        * Up to 300 order actions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.

        * Up to 300 order actions are allowed on a single subscription in a
        [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.
      operationId: POST_PreviewOrderAsynchronously
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Indicates whether to return aggregated invoice item summaries for
            each invoice.


            With this parameter set to `true`, the `invoices` >
            `invoiceItemSummary` field is returned in the preview result. 

            The aggregated `invoiceItemSummary` field provides a forecast of the
            number of future invoices (`previewInvoiceSequence`), and the
            following information for each invoice:
              - `subTotal`
              - `total`
              - `taxAmount`
              - `discountAmount`
              - `servicePeriodStartDate`
              - `servicePeriodEndDate`
          name: summarizeInvoiceItem
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderPreviewAsyncRequestType'
        required: true
      responses:
        '202':
          content:
            application/json:
              examples:
                response:
                  value:
                    jobId: 2c90a02d676688200167770ce20601b6
              schema:
                properties:
                  jobId:
                    description: >-
                      The ID of an asynchronous job that will be returned for
                      tracking the status and result of the job.
                    format: UUID
                    type: string
                type: object
          description: Accepted
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            Location:
              description: >-
                URL for accessing the job result, in the format of
                `/async-jobs/{jobId}`. For example,
                `/async-jobs/2c90a02d676688200167770ce20601b6`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Preview an order asynchronously
      tags:
        - Orders
  /v1/orders:
    get:
      description: >
        **Note:** This feature is only available if you have the [Order
        Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-delta-metrics-and-order-metrics)
        feature enabled. As of Zuora Billing Release 284, Orders is generally
        available and the Order Metrics feature is no longer available as a
        standalone feature. If you are an existing Subscribe and Amend customer
        and want Order Metrics only, you must turn on [Orders
        Harmonization](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization).
        You can still keep the existing Subscribe and Amend API integrations to
        create and manage subscriptions.


        **Note:** The [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature to access the [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature enabled by default.        


        Retrieves information about all orders in your tenant. You can set the
        `status` query parameter to an order status to retrieve orders in that
        order status. If you do not set a value for this query parameter, the
        query parameter has a default value `all`, and orders of all statuses
        are returned. 

        By default, it returns the first page of the orders. 
      operationId: GET_AllOrders
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The date type to filter on. This field value can be orderDate or
            updatedDate. Default is orderDate.
          in: query
          name: dateFilterOption
          required: false
          schema:
            type: string
        - description: >
            The result will only contain the orders with the date of
            dateFilterOption later than or equal to this date.
          in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - description: >
            The result will only contains orders with the date of
            dateFilterOption earlier than or equal to this date.
          in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - description: The status of orders.
          in: query
          name: status
          required: false
          schema:
            enum:
              - all
              - cancelled
              - completed
              - draft
              - executing
              - failed
              - pending
              - scheduled
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    orders:
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:58'
                        currency: USD
                        customFields:
                          order_cf_date__c: '2017-01-01'
                        description: This is a description for the Order.
                        existingAccountNumber: accountA_Num
                        orderDate: '2017-03-01'
                        orderLineItems:
                          - UOM: null
                            accountingCode: null
                            amount: 10000
                            amountPerUnit: 5000
                            amountWithoutTax: 10000
                            billTargetDate: null
                            billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
                            billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
                            customFields:
                              orderLineItemCF__c: olinumber-023
                            description: >-
                              With Dual Stereo Microphones, HD 1080p, Black,USB
                              connectivity for ease of use.
                            id: 4028fc827a0e48c1017a0e4dccc60002
                            invoiceGroupNumber: N-0001
                            invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
                            invoiceOwnerAccountName: AC_AC_16836148090011683614809001
                            invoiceOwnerAccountNumber: AN_1683614809001
                            itemName: webcam
                            itemNumber: '1'
                            itemState: Executing
                            itemType: Product
                            listPrice: 118
                            listPricePerUnit: 59
                            orderId: 4028fc827a0e48c1017a0e58b9330014
                            ownerAccountId: ff80808187ff38570187ff433f974203
                            ownerAccountName: AC_AC_16836148099861683614809986
                            ownerAccountNumber: AN_1683614809986
                            productCode: C9201
                            productRatePlanChargeId: null
                            purchaseOrderNumber: 960-000764
                            quantity: 2
                            soldTo: 4028fc828244a0ac018244dfc9a90bee
                            soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
                            transactionEndDate: '2021-02-01'
                            transactionStartDate: '2021-02-01'
                        orderNumber: O-00000002
                        status: Completed
                        subscriptions:
                          - baseVersion: 1
                            customFields:
                              sub_cf_picklist__c: null
                            newVersion: 2
                            orderActions:
                              - customFields:
                                  oa_cf_text__c: null
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-03-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-03-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-03-01'
                                type: UpdateProduct
                                updateProduct:
                                  chargeUpdates:
                                    - billing:
                                        billingPeriodAlignment: null
                                      chargeNumber: C-00000001
                                      customFields:
                                        srpc_cf_picklist__c: null
                                      description: null
                                      effectiveDate:
                                        specificTriggerDate: null
                                      newRatePlanChargeId: 2c989028622282520162235adabc0651
                                      pricing:
                                        recurringVolume:
                                          priceChangeOption: null
                                          priceIncreasePercentage: null
                                          quantity: 7
                                          tiers: []
                                      uniqueToken: null
                                  customFields: {}
                                  newRatePlanId: 2c989028622282520162235ada870649
                                  ratePlanId: 2c989028622282520162235acd1b05d2
                                  specificUpdateDate: null
                                  uniqueToken: null
                            subscriptionNumber: A-S00000001
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:58'
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:55'
                        currency: USD
                        existingAccountNumber: accountA_Num
                        orderDate: '2017-01-01'
                        orderNumber: O-00000001
                        status: Completed
                        subscriptions:
                          - baseVersion: null
                            customFields:
                              sub_cf_picklist__c: sub123
                            newVersion: 1
                            orderActions:
                              - createSubscription:
                                  invoiceSeparately: null
                                  invoiceGroupNumber: N-0001
                                  notes: null
                                  subscribeToRatePlans:
                                    - chargeOverrides:
                                        - billing:
                                            billCycleDay: 1
                                            billCycleType: null
                                            billingPeriod: null
                                            billingPeriodAlignment: null
                                            billingTiming: null
                                            specificBillingPeriod: null
                                            weeklyBillCycleDay: null
                                          chargeNumber: C-00000001
                                          customFields:
                                            srpc_cf_picklist__c: null
                                          description: null
                                          endDate:
                                            endDateCondition: null
                                            specificEndDate: null
                                            upToPeriods: null
                                            upToPeriodsType: null
                                          pricing:
                                            recurringVolume:
                                              listPriceBase: Per_Billing_Period
                                              priceChangeOption: null
                                              priceIncreasePercentage: null
                                              quantity: 12
                                              tiers: []
                                          productRateplanChargeId: 2c989028622282520162235aca7a05b9
                                          startDate:
                                            specificTriggerDate: null
                                          uniqueToken: null
                                      customFields: {}
                                      newRatePlanId: 2c989028622282520162235acd1b05d2
                                      productRatePlanId: 2c989028622282520162235ac91605b3
                                      uniqueToken: null
                                  subscriptionOwnerAccountNumber: accountA_Num
                                  terms:
                                    autoRenew: false
                                    initialTerm:
                                      period: 12
                                      periodType: Month
                                      startDate: '2017-01-01'
                                      termType: TERMED
                                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                                    renewalTerms:
                                      - period: 0
                                        periodType: Month
                                customFields:
                                  order_cf_date__c: '2017-01-01'
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-01-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-01-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-01-01'
                                type: CreateSubscription
                            subscriptionNumber: A-S00000001
                        success: true
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:55'
              schema:
                $ref: '#/components/schemas/GetAllOrdersResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List orders
      tags:
        - Orders
    post:
      description: >-
        **Note:** This operation is only available if you have the
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature enabled. If you are an existing Zuora <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the   new
        features on Zuora Billing.


        **Note:** The [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature to access the [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature enabled by default.       


        You can use this operation to create subscriptions and make changes to
        subscriptions by creating orders. You can also use this operation to
        create order line items by creating orders. The following tutorials
        demonstrate how to use this operation:

         * [Create a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/create-subscriptions/creating-a-subscription)
         * [Add a Product to a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/add-products-to-subscriptions)
         * [Create a Ramp Deal](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/product-mid-interval-updates-on-ramp-deals-addition)
         * [Add a Product Mid-Interval Update on a Ramp Deal](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/product-mid-interval-updates-on-ramp-deals-addition)
         * [Add a Product in a Ramp Deal](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/products-addition-in-ramp-deals)
         * [Change the Terms and Conditions of a Ramp Deal](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/ramps-and-ramp-metrics/terms-and-conditions-of-ramp-deals-changes)
         * [Change the Owner of a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/owners-of-subscriptions-changes)
         * [Change the Terms and Conditions of a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/amend-subscriptions/terms-and-conditions-of-subscriptions/change-the-terms-and-conditions-of-a-subscription)
         * [Renew a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/amend-subscriptions/subscriptions-renewal)
         * [Renew a Subscription and Upgrade a Product](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/subscriptions-and-upgrade-products-renewal)
         * [Replace a Product in a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/replace-products-in-subscriptions)
         * [Update a Product in a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend/amend-subscriptions/products-updation-to-an-amendment/update-a-product-in-an-existing-subscription)
         * [Cancel a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/subscriptions-cancelation)
         * [Remove a Product from a Subscription](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/order-actions-tutorials/remove-products-from-subscriptions)
         * [Create sales order line items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items/sales-order-line-items-creation)
         * [Associate order line items with new subscriptions](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items/associate-order-line-items-with-subscriptions)
         * [Return order line items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items/order-line-items-return)

        You can also use this operation to create orders and save the orders as
        <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/scheduled-orders"
        target="_blank">Scheduled Orders</a>.


        In addition, you can use this operation to place a standalone order to
        subscribe without pre-defining a product catalog in Zuora Billing. For
        more information, see <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders/create-a-subscription-using-a-standalone-order"
        target="_blank">Create a subscription using a standalone order</a>. 


        **Note:** If you received a timeout error message when creating an
        order, the call is still running in the backend and the order will be
        created.


        The limit of orders allowed on a subscription is 1000.


        The limit of order line items allowed in an order is 100.


        Zuora has the following limits on the Orders synchronous API to prevent
        performance degradation: 

        * Up to 50 subscriptions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        * Up to 50 order actions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        * Up to 50 order actions are allowed on a single subscription in a
        [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.


        If you have an Order that exceeds any limits of the above, Zuora
        recommends you use the following asynchronous API operations:

        * [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)

        * [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)

        * [Retrieve the status and response of a
        job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse)
        for checking the status of the asynchronous API operations


        Zuora has the following limits on the Orders asynchronous API operations
        to prevent performance degradation:

        * Up to 300 subscriptions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.

        * Up to 300 order actions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.

        * Up to 300 order actions are allowed on a single subscription in a
        [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.



        **Note:** When you are to suspend a subcription (via the `suspend` order
        action), if in the same "Create an order" call you are to perform other
        subsequent order actions on the supscription to suspend, you must first
        resume the subscription (via a `resume` order action). 


        **Note:** When using this operation to create an account, create a
        subscription, run billing, and collect payment in a single call, if any
        error occurs during the call, such as a payment processing failure and a
        tax engine failure, then all the other steps will be rolled back. This
        means that the invoice will not be generated, the subscription will not
        be created, and the account will not be created.

          **Note:** The characters `#`, `?`, and `/` are not allowed in the Orders operations.
      operationId: POST_Order
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Specify whether to return IDs associated with the numbers returned
            in the "Create an order" operation.
          in: query
          name: returnIds
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    orderNumber: O-00000354
                    accountNumber: A00000097
                    status: Completed
                    subscriptions:
                      - subscriptionNumber: A-S00000129
                        subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
                        subscriptionOwnerNumber: A00000001
                        status: Active
              schema:
                $ref: '#/components/schemas/PostOrderResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an order
      tags:
        - Orders
  /v1/async/orders:
    post:
      description: >
        **Note:** This operation is only available if you have the
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature enabled. If you are an existing Zuora <a
        href="ttps://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/subscribe-and-amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders-harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the new
        features on Zuora Billing.


        **Note:** The [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature to access the [Order Line
        Items](ttps://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items)
        feature enabled by default.      


        In the case where a normal "Create an order" operation call will time
        out, use this operation instead to create an order asynchronously. A job
        will be creating the order in the back end; the job ID will be returned
        for tracking the job status and result. 


        Note that this operation doesn't support auto-refund and invoice
        write-off during subscription cancellation. Use the "Create an order"
        operation instead.


        The limit of orders allowed on a subscription is 1000.


        The limit of order line items allowed in an order is 100.


        Zuora has the following limits on the Orders synchronous API to prevent
        performance degradation: 

        * Up to 50 subscriptions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        * Up to 50 order actions are allowed in a single [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.

        * Up to 50 order actions are allowed on a single subscription in a
        [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order)
        or [Preview an
        order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder)
        operation call.


        If you have an Order that exceeds any limits of the above, Zuora
        recommends you use the following asynchronous API operations:

        * [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)

        * [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)

        * [Retrieve the status and response of a
        job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse)
        for checking the status of the asynchronous API operations


        Zuora has the following limits on the Orders asynchronous API operations
        to prevent performance degradation:

        * Up to 300 subscriptions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.

        * Up to 300 order actions are allowed in a single [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.

        * Up to 300 order actions are allowed on a single subscription in a
        [Create an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously)
        or [Preview an order
        asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously)
        operation call.
      operationId: POST_CreateOrderAsynchronously
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Specify whether to return IDs for the [Get job status and
            response](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse)
            operation. If you set this query parameter to `true`, the
            corresponding IDs, which are associated with the numbers returned in
            this operation, can be returned in the "Get job status and response"
            response body.
          in: query
          name: returnIds
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTOrderAsyncRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    jobId: 1bc24f315d7b48d3a20245bfe73bdceb
                    success: true
              schema:
                properties:
                  jobId:
                    description: >-
                      The ID of an asynchronous job that will be returned for
                      tracking the status and result of the job.
                    format: UUID
                    type: string
                  success:
                    description: Indicates whether the operation call succeeded.
                    type: boolean
                type: object
          description: Accepted
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            Location:
              description: >-
                URL for accessing the job result, in the format of
                `/async-jobs/{jobId}`. For example,
                `/async-jobs/1bc24f315d7b48d3a20245bfe73bdceb`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Create an order asynchronously
      tags:
        - Orders
  /v1/orders/{orderNumber}:
    delete:
      description: >
        **Note:** This operation is only available if you have the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature enabled. If you are an existing Zuora <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"
        target="_blank">new features</a> on Zuora Billing.


        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default.        


        Deletes a specified order. 


        * All the subscriptions changed by this order are deleted. After the
        deletion, the subscriptions are rolled back to the previous version. 


        * All the order line items created in this order are deleted.


        You are not allowed to delete an order in the following situations:
         - The charges that are affected by this order are invoiced.
         - The order is reverted and in the `Reverted` status.
      operationId: DELETE_Order
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The number of the order to be deleted.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an order
      tags:
        - Orders
    get:
      description: >
        **Note:** This feature is only available if you have the [Order
        Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
        feature enabled. As of Zuora Billing Release 284, Orders is generally
        available and the Order Metrics feature is no longer available as a
        standalone feature. If you are an existing Subscribe and Amend customer
        and want Order Metrics only, you must turn on [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization).
        You can still keep the existing Subscribe and Amend API integrations to
        create and manage subscriptions.


        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default.       


        Retrieves the detailed information about a specified order.
      operationId: GET_Order
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The order number to be retrieved.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - description: >-
            Retrieves the invoice owner account details and subscription owner
            account details in the Order.
          in: query
          name: getAccountDetails
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    order:
                      createdBy: 402881e522cf4f9b0122cf5d82860002
                      createdDate: '2018-12-13 17:21:43'
                      currency: USD
                      customFields: {}
                      description: This is a description for the Order.
                      existingAccountNumber: A00000101
                      existingAccountDetails:
                        basicInfo:
                          accountNumber: A00000001
                          batch: Batch1
                          communicationProfileId: 303d186840e611df817c002185d714e1
                          crmId: ''
                          id: 402892c74c9193cd014c91d35b0a0132
                          invoiceTemplateId: null
                          name: Test
                          notes: ''
                          partnerAccount: false
                          profileNumber: CP-00000012
                          salesRep: ''
                          sequenceSetId: null
                          status: Active
                          summaryStatementTemplateId: null
                          purchaseOrderNumber: ''
                        billToContact:
                          address1: ''
                          address2: ''
                          city: ''
                          country: null
                          county: null
                          fax: ''
                          firstName: Test
                          homePhone: ''
                          id: 2c9081a03c6d7b51013c6d7e46c80a17
                          lastName: Test
                          mobilePhone: ''
                          nickname: ''
                          otherPhone: ''
                          otherPhoneType: null
                          personalEmail: ''
                          state: ''
                          taxRegion: null
                          workEmail: contact@example.com
                          workPhone: ''
                          zipCode: ''
                      invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                      orderDate: '2018-10-01'
                      orderLineItems:
                        - UOM: Unit
                          accountingCode: Revenue
                          amount: 10000
                          amountPerUnit: 5000
                          amountWithoutTax: 10000
                          billTargetDate: '2025-12-01'
                          billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
                          billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
                          customFields:
                            orderLineItemCF__c: olinumber-023
                          description: >-
                            With Dual Stereo Microphones, HD 1080p, Black,USB
                            connectivity for ease of use.
                          id: 4028fc827a0e48c1017a0e4dccc60002
                          invoiceGroupNumber: N-0001
                          invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
                          invoiceOwnerAccountName: AC_AC_16836148090011683614809001
                          invoiceOwnerAccountNumber: AN_1683614809001
                          itemName: webcam
                          itemNumber: '1'
                          itemState: Executing
                          itemType: Product
                          listPrice: 118
                          listPricePerUnit: 59
                          orderId: 4028fc827a0e48c1017a0e58b9330014
                          ownerAccountId: ff80808187ff38570187ff433f974203
                          ownerAccountName: AC_AC_16836148099861683614809986
                          ownerAccountNumber: AN_1683614809986
                          productCode: C9201
                          productRatePlanChargeId: null
                          purchaseOrderNumber: 960-000764
                          quantity: 2
                          soldTo: 4028fc828244a0ac018244dfc9a90bee
                          soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
                          transactionEndDate: '2021-02-01'
                          transactionStartDate: '2021-02-01'
                      orderNumber: O-00000282
                      status: Completed
                      subscriptions:
                        - baseVersion: 1
                          customFields: {}
                          externallyManagedBy: null
                          newVersion: 2
                          orderActions:
                            - customFields: {}
                              sequence: 0
                              triggerDates:
                                - name: ContractEffective
                                  triggerDate: '2018-12-01'
                                - name: ServiceActivation
                                  triggerDate: '2018-12-01'
                                - name: CustomerAcceptance
                                  triggerDate: '2018-12-01'
                              type: UpdateProduct
                              updateProduct:
                                chargeUpdates:
                                  - billing:
                                      billingPeriodAlignment: AlignToCharge
                                    chargeNumber: C-00000210
                                    customFields: {}
                                    description: New description
                                    effectiveDate:
                                      specificTriggerDate: '2025-12-01'
                                    newRatePlanChargeId: 2c98919c67a5ae9d0167a6df304b0372
                                    pricing:
                                      recurringPerUnit:
                                        listPrice: 20
                                        priceChangeOption: NoChange
                                        priceIncreasePercentage: 0
                                        quantity: 12
                                    uniqueToken: TestUniqueToken1234
                                customFields: {}
                                newRatePlanId: 2c98919c67a5ae9d0167a6df3011036e
                                ratePlanId: 2c98919c67a5ae9d0167a68f8eb20262
                                specificUpdateDate: '2025-11-07'
                                uniqueToken: TestUniqueToken1234
                          subscriptionNumber: A-S00000100
                          subscriptionOwnerAccountNumber: A00000001
                          subscriptionOwnerAccountDetails:
                            accountNumber: A00000001
                            batch: Batch1
                            communicationProfileId: 303d186840e611df817c002185d714e1
                            crmId: ''
                            id: 402892c74c9193cd014c91d35b0a0132
                            invoiceTemplateId: null
                            name: Test
                            notes: ''
                            partnerAccount: false
                            profileNumber: CP-00000012
                            salesRep: ''
                            sequenceSetId: null
                            status: Active
                            summaryStatementTemplateId: null
                            purchaseOrderNumber: ''
                            billToContact:
                              address1: ''
                              address2: ''
                              city: ''
                              country: null
                              county: null
                              fax: ''
                              firstName: Test
                              homePhone: ''
                              id: 2c9081a03c6d7b51013c6d7e46c80a17
                              lastName: Test
                              mobilePhone: ''
                              nickname: ''
                              otherPhone: ''
                              otherPhoneType: null
                              personalEmail: ''
                              state: ''
                              taxRegion: null
                              workEmail: contact@example.com
                              workPhone: ''
                              zipCode: ''
                        - baseVersion: 2
                          customFields: {}
                          externallyManagedBy: Google
                          newVersion: 3
                          orderActions:
                            - customFields: {}
                              resume:
                                extendsTerm: true
                                resumeDate: '2018-12-23'
                                resumePeriods: 10
                                resumePeriodsType: Day
                                resumePolicy: FixedPeriodsFromSuspendDate
                                resumeSpecificDate: null
                              sequence: 0
                              triggerDates:
                                - name: ContractEffective
                                  triggerDate: '2018-12-12'
                                - name: ServiceActivation
                                  triggerDate: '2018-12-12'
                                - name: CustomerAcceptance
                                  triggerDate: '2018-12-12'
                              type: Resume
                            - customFields: {}
                              sequence: 1
                              termsAndConditions:
                                autoRenew: true
                                invoiceGroupNumber: N-0001
                                clearingExistingInvoiceGroupNumber: false
                                initialTerm:
                                  period: 375
                                  periodType: Day
                                  startDate: '2025-12-01'
                                  termType: TERMED
                                renewalSetting: RENEW_WITH_SPECIFIC_TERM
                                renewalTerms:
                                  - period: 3
                                    periodType: Month
                              triggerDates:
                                - name: ContractEffective
                                  triggerDate: '2018-12-12'
                                - name: ServiceActivation
                                  triggerDate: '2018-12-12'
                                - name: CustomerAcceptance
                                  triggerDate: '2018-12-12'
                              type: TermsAndConditions
                          subscriptionNumber: A-S00000102
                          subscriptionOwnerAccountNumber: A00000001
                      updatedBy: 402881e522cf4f9b0122cf5d82860002
                      updatedDate: '2018-12-13 17:21:45'
                    success: true
              schema:
                $ref: '#/components/schemas/GetOrderResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an order
      tags:
        - Orders
    put:
      description: >
        **Notes:** 

        - This operation is only available if you have the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature enabled. If you are an existing Zuora <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"
        target="_blank">new features</a> on Zuora Billing.

        - Update an order is only valid for draft or scheduled orders.

        - This operation doesn't support auto-refund and invoice write-off
        during subscription cancellation. Use the "Create an order" operation
        instead.

        - You must provide full payload when using the "Update an order"
        operation. That is, if you want to edit one order action, you need to
        provide all other order actions in the payload. Otherwise, the other
        order actions will be removed.
      operationId: PUT_Order
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Order number of a order in which you are to update.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    orderNumber: O-00000758
                    accountNumber: A00000097
                    status: Draft
              schema:
                $ref: '#/components/schemas/PutOrderResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an order
      tags:
        - Orders
  /v1/async/orders/{orderNumber}:
    delete:
      description: >
        **Note:** This operation is only available if you have the <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"

        target= "_blank">Orders</a> feature enabled. If you are an existing
        Zuora <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target= "_blank">Subscribe and Amend</a> customer, we recommend you
        enable 

        <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"

        target= "_blank">Orders Harmonization</a> to access the <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"

        target= "_blank">Orders</a> feature. With Orders, you can access both
        existing\

        functions for subscription and billing management and the <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"

        target= "_blank">new features</a> on Zuora Billing.

        **Note:** The <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"

        target= "_blank">Order Line Items</a>

        feature is now generally available to all Zuora customers. You need to
        enable

        the <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"

        target= "_blank">Orders</a>

        feature to access the <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"

        target= "_blank">Order Line Items</a>

        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who\

        onboard on <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"

        target= "_blank">Orders</a>

        will have the <a href=
        "https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"

        target= "_blank">Order Line Items</a> feature enabled by default. 

        Deletes a specified order. 

        All the subscriptions changed by this order are deleted. After the
        deletion, the subscriptions are rolled back to the previous version. 

        All the order line items created in this order are deleted.

        You are not allowed to delete an order in the following situations:
          - The charges that are affected by this order are invoiced.
          - The order is reverted and in the `Reverted` status.
      operationId: deleteOrderAsynchronously
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: The number of the order to be deleted.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                jobId: 2c90a02d676688200167770ce20601b6
                success: true
              schema:
                $ref: '#/components/schemas/DeleteOrderAsyncResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              example:
                processId: 30591668A6FFCE5C
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Delete an order asynchronously
      tags:
        - Orders
  /v1/async-jobs/{jobId}:
    get:
      description: >
        **Note:** This operation is only available if you have the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature enabled. If you are an existing Zuora <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"
        target="_blank">new features</a> on Zuora Billing.


        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default.       


        Get the status and response of an asynchronous job. Currently, an
        asynchronous job created by "Create an order asynchronously" or "Preview
        an order asynchronously" is supported.
      operationId: GET_JobStatusAndResponse
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >-
            UUID of the asynchronous job created by an asynchronous API
            operation.
          in: path
          name: jobId
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors: null
                    result:
                      jobType: AsyncCreateOrder
                      accountNumber: A00000001
                      invoiceNumbers:
                        - INV00000001
                      orderLineItems:
                        - id: bd78c0522adf42c2aa0fccacc997fa20
                          itemNumber: '116'
                      orderNumber: OM-00002
                      paidAmount: '300'
                      paymentNumber: P-00000002
                      status: Pending
                      subscriptions:
                        - status: Pending Activation
                          subscriptionNumber: SM-00001
                        - status: Pending Acceptance
                          subscriptionNumber: SM-00002
                        - status: Active
                          subscriptionNumber: SM-00003
                        - status: Pending Acceptance
                          subscriptionNumber: SM-00004
                      success: true
                    status: Completed
                    success: true
              schema:
                $ref: '#/components/schemas/GetAsyncOrderJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve the status and response of a job
      tags:
        - Orders
  /v1/orders/subscriptionOwner/{accountNumber}:
    get:
      description: >
        **Note:** This feature is only available if you have the [Order
        Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
        feature enabled. As of Zuora Billing Release 284, Orders is generally
        available and the Order Metrics feature is no longer available as a
        standalone feature. If you are an existing Subscribe and Amend customer
        and want Order Metrics only, you must turn on [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization).
        You can still keep the existing Subscribe and Amend API integrations to
        create and manage subscriptions.


        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default.        


        Retrieves the detailed information about all orders for a specified
        subscription owner. Any orders containing the changes on the
        subscriptions owned by this account are returned.


        **Note**: You cannot retrieve detailed information about draft orders or
        scheduled orders through this operation.
      operationId: GET_OrdersBySubscriptionOwner
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The subscription owner account number.
          in: path
          name: accountNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The date type to filter on.

            This field value can be 'orderDate' or 'updatedDate'. Default is
            orderDate.
          in: query
          name: dateFilterOption
          required: false
          schema:
            type: string
        - description: >
            The result will only contain the orders with the date of
            'dateFilterOption' later than or equal to this date.
          in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - description: >
            The result will only contain the orders with the date of
            'dateFilterOption' earlier than or equal to this date.
          in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    orders:
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:58'
                        currency: USD
                        customFields:
                          order_cf_date__c: '2017-01-01'
                        description: This is a description for the Order.
                        existingAccountNumber: accountA_Num
                        invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                        orderDate: '2017-03-01'
                        orderNumber: O-00000002
                        status: Completed
                        subscriptions:
                          - baseVersion: 1
                            customFields:
                              sub_cf_picklist__c: null
                            newVersion: 2
                            orderActions:
                              - customFields:
                                  oa_cf_text__c: null
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-03-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-03-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-03-01'
                                type: UpdateProduct
                                updateProduct:
                                  chargeUpdates:
                                    - billing:
                                        billingPeriodAlignment: null
                                      chargeNumber: C-00000001
                                      customFields:
                                        srpc_cf_picklist__c: null
                                      description: null
                                      effectiveDate:
                                        specificTriggerDate: null
                                      newRatePlanChargeId: 2c989028622282520162235adabc0651
                                      pricing:
                                        recurringVolume:
                                          priceChangeOption: null
                                          priceIncreasePercentage: null
                                          quantity: 7
                                          tiers: []
                                      uniqueToken: null
                                  customFields: {}
                                  newRatePlanId: 2c989028622282520162235ada870649
                                  ratePlanId: 2c989028622282520162235acd1b05d2
                                  specificUpdateDate: null
                                  uniqueToken: null
                            subscriptionNumber: A-S00000001
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:58'
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:55'
                        currency: USD
                        customFields:
                          order_cf_date__c: '2017-01-01'
                        existingAccountNumber: accountA_Num
                        orderDate: '2017-01-01'
                        orderNumber: O-00000001
                        status: Completed
                        subscriptions:
                          - baseVersion: null
                            customFields:
                              sub_cf_picklist__c: sub123
                            newVersion: 1
                            orderActions:
                              - createSubscription:
                                  invoiceSeparately: null
                                  notes: null
                                  subscribeToRatePlans:
                                    - chargeOverrides:
                                        - billing:
                                            billCycleDay: 1
                                            billCycleType: null
                                            billingPeriod: null
                                            billingPeriodAlignment: null
                                            billingTiming: null
                                            specificBillingPeriod: null
                                            weeklyBillCycleDay: null
                                          chargeNumber: C-00000001
                                          customFields:
                                            srpc_cf_picklist__c: null
                                          description: null
                                          endDate:
                                            endDateCondition: null
                                            specificEndDate: null
                                            upToPeriods: null
                                            upToPeriodsType: null
                                          pricing:
                                            recurringVolume:
                                              listPriceBase: Per_Billing_Period
                                              priceChangeOption: null
                                              priceIncreasePercentage: null
                                              quantity: 12
                                              tiers: []
                                          productRateplanChargeId: 2c989028622282520162235aca7a05b9
                                          startDate:
                                            specificTriggerDate: null
                                          uniqueToken: null
                                      customFields: {}
                                      newRatePlanId: 2c989028622282520162235acd1b05d2
                                      productRatePlanId: 2c989028622282520162235ac91605b3
                                      uniqueToken: null
                                  subscriptionOwnerAccountNumber: accountA_Num
                                  terms:
                                    autoRenew: false
                                    initialTerm:
                                      period: 12
                                      periodType: Month
                                      startDate: '2017-01-01'
                                      termType: TERMED
                                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                                    renewalTerms:
                                      - period: 0
                                        periodType: Month
                                customFields:
                                  oa_cf_text__c: oa cf test
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-01-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-01-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-01-01'
                                type: CreateSubscription
                            subscriptionNumber: A-S00000001
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:55'
                    success: true
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List orders of a subscription owner
      tags:
        - Orders
  /v1/orders/subscription/{subscriptionNumber}:
    get:
      description: >
        **Note:** This feature is only available if you have the [Order
        Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
        feature enabled. As of Zuora Billing Release 284, Orders is generally
        available and the Order Metrics feature is no longer available as a
        standalone feature. If you are an existing Subscribe and Amend customer
        and want Order Metrics only, you must turn on [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization).
        You can still keep the existing Subscribe and Amend API integrations to
        create and manage subscriptions.


        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default. 


        Retrieves the detailed information about all orders for a specified
        subscription. You can set the `status` query parameter to an order
        status to retrieve orders in that order status. If you do not set a
        value for this query parameter, the query parameter has a default value
        `all`, and orders of all statuses are returned.
      operationId: GET_OrdersBySubscriptionNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The subscription number.
          in: path
          name: subscriptionNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The date type to filter on. This field value can be 'orderDate' or
            'updatedDate'. Default is orderDate.
          in: query
          name: dateFilterOption
          required: false
          schema:
            type: string
        - description: >
            The result will only contain the orders with the date of
            'dateFilterOption' later than or equal to this date.
          in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - description: >
            The result will only contain the orders with the date of
            'dateFilterOption' earlier than or equal to this date.
          in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - description: The status of orders.
          in: query
          name: status
          required: false
          schema:
            enum:
              - all
              - cancelled
              - completed
              - draft
              - executing
              - failed
              - pending
              - scheduled
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    orders:
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:58'
                        currency: USD
                        customFields:
                          order_cf_date__c: '2017-01-01'
                        description: This is a description for the Order.
                        existingAccountNumber: accountA_Num
                        invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                        orderDate: '2017-03-01'
                        orderNumber: O-00000002
                        status: Completed
                        subscriptions:
                          - baseVersion: 1
                            customFields:
                              sub_cf_picklist__c: null
                            newVersion: 2
                            orderActions:
                              - customFields:
                                  oa_cf_text__c: null
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-03-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-03-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-03-01'
                                type: UpdateProduct
                                updateProduct:
                                  chargeUpdates:
                                    - billing:
                                        billingPeriodAlignment: null
                                      chargeNumber: C-00000001
                                      customFields:
                                        srpc_cf_picklist__c: null
                                      description: null
                                      effectiveDate:
                                        specificTriggerDate: null
                                      newRatePlanChargeId: 2c989028622282520162235adabc0651
                                      pricing:
                                        recurringVolume:
                                          priceChangeOption: null
                                          priceIncreasePercentage: null
                                          quantity: 7
                                          tiers: []
                                      uniqueToken: null
                                  customFields: {}
                                  newRatePlanId: 2c989028622282520162235ada870649
                                  ratePlanId: 2c989028622282520162235acd1b05d2
                                  specificUpdateDate: null
                                  uniqueToken: null
                            subscriptionNumber: A-S00000001
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:58'
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:55'
                        currency: USD
                        customFields:
                          order_cf_date__c: '2017-01-01'
                        existingAccountNumber: accountA_Num
                        orderDate: '2017-01-01'
                        orderNumber: O-00000001
                        status: Completed
                        subscriptions:
                          - baseVersion: null
                            customFields:
                              sub_cf_picklist__c: sub123
                            newVersion: 1
                            orderActions:
                              - createSubscription:
                                  invoiceSeparately: null
                                  notes: null
                                  subscribeToRatePlans:
                                    - chargeOverrides:
                                        - billing:
                                            billCycleDay: 1
                                            billCycleType: null
                                            billingPeriod: null
                                            billingPeriodAlignment: null
                                            billingTiming: null
                                            specificBillingPeriod: null
                                            weeklyBillCycleDay: null
                                          chargeNumber: C-00000001
                                          customFields:
                                            srpc_cf_picklist__c: null
                                          description: null
                                          endDate:
                                            endDateCondition: null
                                            specificEndDate: null
                                            upToPeriods: null
                                            upToPeriodsType: null
                                          pricing:
                                            recurringVolume:
                                              listPriceBase: Per_Billing_Period
                                              priceChangeOption: null
                                              priceIncreasePercentage: null
                                              quantity: 12
                                              tiers: []
                                          productRateplanChargeId: 2c989028622282520162235aca7a05b9
                                          startDate:
                                            specificTriggerDate: null
                                          uniqueToken: null
                                      customFields: {}
                                      newRatePlanId: 2c989028622282520162235acd1b05d2
                                      productRatePlanId: 2c989028622282520162235ac91605b3
                                      uniqueToken: null
                                  subscriptionOwnerAccountNumber: accountA_Num
                                  terms:
                                    autoRenew: false
                                    initialTerm:
                                      period: 12
                                      periodType: Month
                                      startDate: '2017-01-01'
                                      termType: TERMED
                                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                                    renewalTerms:
                                      - period: 0
                                        periodType: Month
                                customFields:
                                  oa_cf_text__c: oa cf test
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-01-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-01-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-01-01'
                                type: CreateSubscription
                            subscriptionNumber: A-S00000001
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:55'
                    success: true
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List orders by subscription number
      tags:
        - Orders
  /v1/orders/invoiceOwner/{accountNumber}:
    get:
      description: >
        **Note:** This feature is only available if you have the [Order
        Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
        feature enabled. As of Zuora Billing Release 284, Orders is generally
        available and the Order Metrics feature is no longer available as a
        standalone feature. If you are an existing Subscribe and Amend customer
        and want Order Metrics only, you must turn on [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization).
        You can still keep the existing Subscribe and Amend API integrations to
        create and manage subscriptions.


        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default.        


        Retrieves the detailed information about all orders for a specified
        invoice owner. You can set the `status` query parameter to an order
        status to retrieve orders in that order status. If you do not set a
        value for this query parameter, the query parameter has a default value
        `all`, and orders of all statuses are returned.
      operationId: GET_OrdersByInvoiceOwner
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The invoice owner account number.
          in: path
          name: accountNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The date type to filter on. This field value can be orderDate or
            updatedDate. Default is orderDate.
          in: query
          name: dateFilterOption
          required: false
          schema:
            type: string
        - description: >
            The result will only contain the orders with the date of
            dateFilterOption later than or equal to this date.
          in: query
          name: startDate
          required: false
          schema:
            format: date
            type: string
        - description: >
            The result will only contain the orders with the date of
            dateFilterOption earlier than or equal to this date.
          in: query
          name: endDate
          required: false
          schema:
            format: date
            type: string
        - description: The status of orders.
          in: query
          name: status
          required: false
          schema:
            enum:
              - all
              - cancelled
              - completed
              - draft
              - executing
              - failed
              - pending
              - scheduled
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    orders:
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:58'
                        currency: USD
                        customFields:
                          order_cf_date__c: '2017-01-01'
                        description: This is a description for the Order.
                        existingAccountNumber: accountA_Num
                        invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                        orderDate: '2017-03-01'
                        orderNumber: O-00000002
                        status: Completed
                        subscriptions:
                          - baseVersion: 1
                            customFields:
                              sub_cf_picklist__c: null
                            newVersion: 2
                            orderActions:
                              - customFields:
                                  oa_cf_text__c: null
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-03-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-03-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-03-01'
                                type: UpdateProduct
                                updateProduct:
                                  chargeUpdates:
                                    - billing:
                                        billingPeriodAlignment: null
                                      chargeNumber: C-00000001
                                      customFields:
                                        srpc_cf_picklist__c: null
                                      description: null
                                      effectiveDate:
                                        specificTriggerDate: null
                                      newRatePlanChargeId: 2c989028622282520162235adabc0651
                                      pricing:
                                        recurringVolume:
                                          priceChangeOption: null
                                          priceIncreasePercentage: null
                                          quantity: 7
                                          tiers: []
                                      uniqueToken: null
                                  customFields: {}
                                  newRatePlanId: 2c989028622282520162235ada870649
                                  ratePlanId: 2c989028622282520162235acd1b05d2
                                  specificUpdateDate: null
                                  uniqueToken: null
                            subscriptionNumber: A-S00000001
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:58'
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:55'
                        currency: USD
                        customFields:
                          order_cf_date__c: '2017-01-01'
                        existingAccountNumber: accountA_Num
                        orderDate: '2017-01-01'
                        orderNumber: O-00000001
                        status: Completed
                        subscriptions:
                          - baseVersion: null
                            customFields:
                              sub_cf_picklist__c: sub123
                            newVersion: 1
                            orderActions:
                              - createSubscription:
                                  invoiceSeparately: null
                                  notes: null
                                  subscribeToRatePlans:
                                    - chargeOverrides:
                                        - billing:
                                            billCycleDay: 1
                                            billCycleType: null
                                            billingPeriod: null
                                            billingPeriodAlignment: null
                                            billingTiming: null
                                            specificBillingPeriod: null
                                            weeklyBillCycleDay: null
                                          chargeNumber: C-00000001
                                          customFields:
                                            srpc_cf_picklist__c: null
                                          description: null
                                          endDate:
                                            endDateCondition: null
                                            specificEndDate: null
                                            upToPeriods: null
                                            upToPeriodsType: null
                                          pricing:
                                            recurringVolume:
                                              listPriceBase: Per_Billing_Period
                                              priceChangeOption: null
                                              priceIncreasePercentage: null
                                              quantity: 12
                                              tiers: []
                                          productRateplanChargeId: 2c989028622282520162235aca7a05b9
                                          startDate:
                                            specificTriggerDate: null
                                          uniqueToken: null
                                      customFields: {}
                                      newRatePlanId: 2c989028622282520162235acd1b05d2
                                      productRatePlanId: 2c989028622282520162235ac91605b3
                                      uniqueToken: null
                                  subscriptionOwnerAccountNumber: accountA_Num
                                  terms:
                                    autoRenew: false
                                    initialTerm:
                                      period: 12
                                      periodType: Month
                                      startDate: '2017-01-01'
                                      termType: TERMED
                                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                                    renewalTerms:
                                      - period: 0
                                        periodType: Month
                                customFields:
                                  oa_cf_text__c: oa cf test
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-01-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-01-01'
                                  - name: CustomerAcceptance
                                    triggerDate: '2017-01-01'
                                type: CreateSubscription
                            subscriptionNumber: A-S00000001
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:55'
                    success: true
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List orders of an invoice owner
      tags:
        - Orders
  /v1/orders/{orderNumber}/customFields:
    put:
      description: >
        **Note:** This feature is only available if you have the [Order
        Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
        feature enabled. As of Zuora Billing Release 284, Orders is generally
        available and the Order Metrics feature is no longer available as a
        standalone feature. If you are an existing Subscribe and Amend customer
        and want Order Metrics only, you must turn on [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization).
        You can still keep the existing Subscribe and Amend API integrations to
        create and manage subscriptions.


        **Note:** To update the custom fields of an order line item, you must
        use the "Update an order line item" or "Update order line items"
        operation.


        Updates the custom fields of a specified order.
      operationId: PUT_UpdateOrderCustomFields
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The order number.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderPatchRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update order custom fields
      tags:
        - Orders
  /v1/subscriptions/{subscriptionNumber}/customFields:
    put:
      description: >
        **Note:** This operation is only available if you have the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature enabled. If you are an existing Zuora <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"
        target="_blank">new features</a> on Zuora Billing.


        Updates the custom fields of a specified subscription.
      operationId: PUT_UpdateSubscriptionCustomFields
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The subscription number to be updated.
          in: path
          name: subscriptionNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTSubscriptionPatchRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update subscription custom fields
      tags:
        - Orders
  /v1/orders/{orderNumber}/triggerDates:
    put:
      description: >
        **Note:** This operation is only available if you have the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature enabled. If you are an existing Zuora <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"
        target="_blank">new features</a> on Zuora Billing.


        Updates the triggering dates for either of the following order actions:
         * CreateSubscription
         * AddProduct
         * UpdateProduct
         * RemoveProduct
         * RenewSubscription
         * TermsAndConditions
      operationId: PUT_OrderTriggerDates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            Order number of a pending order in which you are to update an order
            action's triggering dates.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderActionTriggerDatesRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    orderNumber: O-00000408
                    status: Completed
                    accountNumber: A00000097
                    subscriptions:
                      - subscriptionNumber: A-S00000143
                        status: Active
              schema:
                $ref: '#/components/schemas/PUTOrderTriggerDatesResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update order action trigger dates
      tags:
        - Orders
  /v1/orders/{orderNumber}/activate:
    put:
      description: >
        **Note:** This operation is only available if you have the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature enabled. If you are an existing Zuora <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"
        target="_blank">new features</a> on Zuora Billing.


        Activate order is only available for draft orders.
      operationId: PUT_OrderActivate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Order number of a order in which you are to activate.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountNumber: A00000001
                    invoiceNumbers:
                      - INV00000001
                    orderLineItems:
                      - id: bd78c0522adf42c2aa0fccacc997fa20
                        itemNumber: '116'
                    orderNumber: OM-00002
                    paidAmount: 300
                    paymentNumber: P-00000002
                    status: Pending
                    subscriptions:
                      - status: Pending Activation
                        subscriptionNumber: SM-00001
                      - status: Pending Acceptance
                        subscriptionNumber: SM-00002
                      - status: Active
                        subscriptionNumber: SM-00003
                      - status: Pending Acceptance
                        subscriptionNumber: SM-00004
                      - status: Suspended
                        subscriptionNumber: SM-00005
                      - status: Active
                        subscriptionNumber: SM-00006
                    success: true
              schema:
                $ref: '#/components/schemas/PostOrderResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Activate an order
      tags:
        - Orders
  /v1/orders/{orderNumber}/cancel:
    put:
      description: >-
        **Note:** This operation is only available if you have the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature enabled. If you are an existing Zuora <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend"
        target="_blank">Subscribe and Amend</a> customer, we recommend you
        enable <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">Orders Harmonization</a> to access the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders"
        target="_blank">Orders</a> feature. With Orders, you can access both
        existing functions for subscription and billing management and the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders"
        target="_blank">new features</a> on Zuora Billing.


        **Note:** Cancellation is only valid for draft or scheduled orders. If
        the order is not in draft or scheduled status, the API returns an
        error. 
      operationId: PUT_OrderCancel
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The order number of the draft order you wish to cancel.
          in: path
          name: orderNumber
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                cancelReason:
                  description: The reason for cancelling the order.
                  example: Customer cancelled the order.
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    CancelReason: Customer cancelled the order.
                    accountNumber: A00000001
                    orderNumber: OM-00002
                    status: Cancelled
                    success: true
              schema:
                $ref: '#/components/schemas/PutOrderCancelResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel an order
      tags:
        - Orders
  /v1/orders/{orderNumber}/revert:
    post:
      description: >
        Reverts an order though this operation.


        **Note**: This operation is only available if you have the following
        features turned on:

          - <a href="https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders" target="_blank">Orders</a>
          
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Single_Version_Subscription" target="_blank">Single Version Subscription</a>

        For information on what orders can be reverted, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Single_Version_Subscription/Revert_orders"
        target="_blank">Revert orders</a>. 
      operationId: revertOrder
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The order number of the order you wish to revert.
          in: path
          name: orderNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevertOrderRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                accountNumber: A00000001
                orderNumber: O-00000020
                status: Completed
                success: true
                subscriptionNumbers:
                  - A-S00000001
              schema:
                $ref: '#/components/schemas/RevertOrderResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Revert an order
      tags:
        - Orders
  /v1/orders/subscription/{subscription-key}/pending:
    get:
      description: >
        **Note:** This feature is only available if you have the [Order
        Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
        feature enabled. As of Zuora Billing Release 284, Orders is generally
        available and the Order Metrics feature is no longer available as a
        standalone feature. If you are an existing Subscribe and Amend customer
        and want Order Metrics only, you must turn on [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization).
        You can still keep the existing Subscribe and Amend API integrations to
        create and manage subscriptions.


        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default. 


        Retrieves the detailed information about all pending orders for a
        specified subscription.
      operationId: GET_PendingOrdersBySubscriptionNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            Subscription number. For example, A-S00000135.
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    orders:
                      - createdBy: 2c989028622282520162235ab0f603ba
                        createdDate: '2018-03-14 15:12:55'
                        currency: USD
                        existingAccountNumber: accountA_Num
                        invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                        orderDate: '2017-01-01'
                        orderNumber: O-00000001
                        status: Pending
                        subscriptions:
                          - baseVersion: null
                            customFields:
                              sub_cf_picklist__c: sub123
                            newVersion: 1
                            orderActions:
                              - createSubscription:
                                  subscribeToRatePlans:
                                    - chargeOverrides:
                                        - chargeNumber: C-00000001
                                          pricing:
                                            recurringVolume:
                                              listPriceBase: Per_Billing_Period
                                              quantity: 12
                                              tiers: []
                                          productRateplanChargeId: 2c989028622282520162235aca7a05b9
                                      customFields: {}
                                      newRatePlanId: 2c989028622282520162235acd1b05d2
                                      productRatePlanId: 2c989028622282520162235ac91605b3
                                  subscriptionOwnerAccountNumber: accountA_Num
                                  terms:
                                    autoRenew: false
                                    initialTerm:
                                      period: 12
                                      periodType: Month
                                      startDate: '2017-01-01'
                                      termType: TERMED
                                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                                    renewalTerms:
                                      - period: 0
                                        periodType: Month
                                customFields:
                                  order_cf_date__c: '2017-01-01'
                                sequence: 0
                                triggerDates:
                                  - name: ContractEffective
                                    triggerDate: '2017-01-01'
                                  - name: ServiceActivation
                                    triggerDate: '2017-01-01'
                                type: CreateSubscription
                            subscriptionNumber: A-S00000001
                        success: true
                        updatedBy: 2c989028622282520162235ab0f603ba
                        updatedDate: '2018-03-14 15:12:55'
              schema:
                $ref: '#/components/schemas/GetAllOrdersResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List pending orders by subscription number
      tags:
        - Orders
  /v1/orderActions/{id}:
    put:
      description: Updates the change reason and custom fields for an order action.
      operationId: PUT_OrderActions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id of the Order Action to update.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderActionsRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an order action
      tags:
        - Order Actions
  /v1/order-line-items/{itemId}:
    get:
      description: >
        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default. If you are a new customer who onboard on
        [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
        and want to enable the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature, submit a request at [Zuora Global
        Support](https://support.zuora.com/). If you are an existing
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        or [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
        customer and want to enable the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature, submit a request at [Zuora Global
        Support](https://support.zuora.com/).


        Retrieves the detailed information about a specified order line item.
        The following tutorial demonstrates how to use this operation:

        * [View details of an order line
        item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GJ_View_details_of_an_order_line_item)
      operationId: GET_OrderLineItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id of the Order Line Item to retrieve.
          in: path
          name: itemId
          required: true
          schema:
            format: UUID
            type: string
        - description: |
            Return the related fulfillments or not.
          in: query
          name: fulfillment
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    orderLineItem:
                      UOM: null
                      accountingCode: null
                      amount: 10000
                      amountPerUnit: 5000
                      amountWithoutTax: 10000
                      billTargetDate: null
                      billTo: 2c9081a03c6d7b51013c6d7e2dfc09fa
                      billToSnapshotId: 4028fc8487c0a43c0187c12a91500060
                      customFields:
                        externalNumber5__c: olinumber-023
                      description: >-
                        With Dual Stereo Microphones, HD 1080p, Black,USB
                        connectivity for ease of use.
                      id: 4028fc827a0e48c1017a0e4dccc60002
                      invoiceGroupNumber: N-0001
                      invoiceOwnerAccountId: ff80808187ff38570187ff433cbd38ef
                      invoiceOwnerAccountName: AC_AC_16836148090011683614809001
                      invoiceOwnerAccountNumber: AN_1683614809001
                      itemName: webcam
                      itemNumber: '1'
                      itemState: Executing
                      itemType: Product
                      listPrice: 118
                      listPricePerUnit: 59
                      orderId: 4028fc827a0e48c1017a0e58b9330014
                      ownerAccountId: ff80808187ff38570187ff433f974203
                      ownerAccountName: AC_AC_16836148099861683614809986
                      ownerAccountNumber: AN_1683614809986
                      productCode: C9201
                      productRatePlanChargeId: null
                      purchaseOrderNumber: 960-000764
                      quantity: 2
                      relatedSubscriptionNumber: Warranty-00002
                      soldTo: 4028fc828244a0ac018244dfc9a90bee
                      soldToSnapshotId: 4028fc828244a0ac018244dfc9b00bf0
                      transactionDate: '2021-02-01'
                    success: true
              schema:
                $ref: '#/components/schemas/GetOrderLineItemResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an order line item
      tags:
        - Order Line Items
    put:
      description: >
        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default. If you are a new customer who onboard on
        [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
        and want to enable the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature, submit a request at [Zuora Global
        Support](https://support.zuora.com/). If you are an existing
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        or [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
        customer and want to enable the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature, submit a request at [Zuora Global
        Support](https://support.zuora.com/).

        Updates a specified order line item. The following tutorials demonstrate
        how to use this operation:

        * [Update an order line
        item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GH_Update_an_order_line_item)

        * [Cancel an order line
        item](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/GZ_Cancel_an_order_line_item)
      operationId: PUT_OrderLineItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id of the Order Line Item to update.
          in: path
          name: itemId
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTOrderLineItemRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/PutOrderLineItemResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an order line item
      tags:
        - Order Line Items
  /v1/order-line-items/bulk:
    post:
      description: >
        **Note:** The [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature is now generally available to all Zuora customers. You need to
        enable the
        [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
        feature to access the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
        feature. As of Zuora Billing Release 313 (November 2021), new customers
        who onboard on
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        will have the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature enabled by default. If you are a new customer who onboard on
        [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
        and want to enable the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature, submit a request at [Zuora Global
        Support](https://support.zuora.com/). If you are an existing
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        or [Orders
        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
        customer and want to enable the [Order Line
        Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
        feature, submit a request at [Zuora Global
        Support](https://support.zuora.com/).


        Bulk-updates multiple order line items. You can also choose to generate
        an invoice for these updated order line items.


        The maximum number of order line items allowable to update in a call is
        100. 
      operationId: Post_OrderLineItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostOrderLineItemsRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderLineItemResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update order line items
      tags:
        - Order Line Items
  /v1/fulfillments:
    post:
      description: >

        Creates one or multiple Fulfillment objects. You can also generate
        invoices or memos for these Fulfillment objects in this API call. The
        following tutorials demonstrate how to use this operation:

        * [Create a sales order line item with
        fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AD_Create_a_sales_order_line_item_with_fulfillments)

        * [Create a return order line item with
        fulfillments](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/Create_a_return_order_line_item_with_fulfillments)
      operationId: Create_Fulfillment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostFulfillmentsRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    creditMemoNumbers: null
                    fulfillments:
                      - fulfillmentNumber: F-00000001
                        id: 4028828c82819b740182821bb3b415c6
                      - fulfillmentNumber: F-00000002
                        id: 4028828c82819b740182821bb3bc15c7
                    invoiceNumbers:
                      - INV00000001
                    paidAmount: 100
                    paymentNumber: P-00000001
                    success: true
              schema:
                $ref: '#/components/schemas/PostFulfillmentsResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create fulfillments
      tags:
        - Fulfillments
  /v1/fulfillments/{key}:
    delete:
      description: >
        Deletes a specified fulfillment. A fulfillment can only be deleted when
        it is in the `Executing` state.
      operationId: Delete_Fulfillment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id or fulfillment number of the Fulfillment to delete.
          in: path
          name: key
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a fulfillment
      tags:
        - Fulfillments
    get:
      description: >
        Retrieves the detailed information about a specified fulfillment. The
        following tutorial demonstrates how to use this operation:

        * [View details of a
        fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_View_details_of_a_fulfillment)
      operationId: GET_Fulfillment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id or fulfillment number of the Fulfillment to retrieve.
          in: path
          name: key
          required: true
          schema:
            format: UUID
            type: string
        - description: Return the related fulfillment items or not.
          in: query
          name: fulfillment-items
          required: false
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fulfillment:
                      billTargetDate: '2022-01-01'
                      carrier: carrier
                      customFields:
                        priority__c: Hight
                      description: description
                      externalId: 9dc1a064-b5d1-4d7b-bd0b-ca26a1be8e01
                      fulfillmentDate: '2022-01-01'
                      fulfillmentItems:
                        - customFields:
                            category__c: Old
                          description: description
                          fulfillmentId: 4028828c82819b74018281a69d3f0d93
                          id: 4028828c82819b74018281a69d680d98
                          itemIdentifier: 87309cf0-10c7-4130-8da2-439c96daa1ff
                      fulfillmentLocation: location
                      fulfillmentNumber: F-00000001
                      fulfillmentSystem: fulfillment system
                      fulfillmentType: Delivery
                      id: 4028828c82819b74018281a69d3f0d93
                      orderLineItemId: 4028828c82819b74018281a69adf0d4e
                      quantity: 1
                      state: SentToBilling
                      trackingNumber: T-00091912
                    success: true
              schema:
                $ref: '#/components/schemas/GetFulfillmentResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a fulfillment
      tags:
        - Fulfillments
    put:
      description: >


        Updates a specified fulfillment. The `state` field of a fulfillment can
        only be updated when it is in a different state, to trigger the state
        transition. The other fields of a fulfillment can only be updated when
        the fulfillment is in the `Executing` state, or when the fulfillment is
        in the `Booked` state and the user has the "Allow Edit Of Booked Order
        Line Items" permission.

        The following tutorial demonstrates how to use this operation:

        * [Update or cancel a
        fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/H_Update_a_fulfillment)
      operationId: PUT_Fulfillment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id or fulfillment number of the Fulfillment to update.
          in: path
          name: key
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFulfillmentRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a fulfillment
      tags:
        - Fulfillments
  /v1/fulfillment-items:
    post:
      description: |
        Creates one or multiple fulfillment items.
      operationId: Create_FulfillmentItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostFulfillmentItemsRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fulfillmentItems:
                      - id: 4028828c82819b74018282544fea17c6
                      - id: 4028828c82819b7401828254507a17c7
                    success: true
              schema:
                $ref: '#/components/schemas/PostFulfillmentItemsResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create fulfillment items
      tags:
        - Fulfillments
  /v1/fulfillment-items/{id}:
    delete:
      description: |
        Deletes a specified fulfillment item.
      operationId: Delete_FulfillmentItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id of the Fulfillment Item to delete.
          in: path
          name: id
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a fulfillment item
      tags:
        - Fulfillments
    get:
      description: |
        Retrieves the detailed information about a specified fulfillment item. 
      operationId: GET_FulfillmentItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id of the Fulfillment Item to retrieve.
          in: path
          name: id
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fulfillmentItem:
                      customFields:
                        PICKLIST_CF__c: option_2
                      description: item description
                      fulfillmentId: 4028828c82819b74018282572f6719b4
                      id: 4028828c82819b7401828257303a19b6
                      itemIdentifier: 5da7a054-24c6-4f29-866b-2c570d844fd0
                    success: true
              schema:
                $ref: '#/components/schemas/GetFulfillmentItemResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a fulfillment item
      tags:
        - Fulfillments
    put:
      description: |
        Updates a specified fulfillment item. 
      operationId: PUT_FulfillmentItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The id of the Fulfillment Item to update.
          in: path
          name: id
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutFulfillmentItemRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a fulfillment item
      tags:
        - Fulfillments
  /v1/ramps/{rampNumber}:
    get:
      description: >
        **Note**: This operation is only available if you have the Ramps feature
        enabled. The
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature must be enabled before you can access the
        [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)
        feature. The Ramps feature is available for customers with Enterprise
        and Nine editions by default. If you are a Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information coming October 2020.


        Retrieves the latest definition of a specified ramp.
      operationId: GET_RampByRampNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The automatically generated number of a ramp. For example,
            R-00000268.
          in: path
          name: rampNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    ramp:
                      charges:
                        - chargeNumber: C-00000202
                      description: ''
                      id: 40289f7b7321f5ce0173229d798300cf
                      intervals:
                        - description: ''
                          endDate: '2020-12-31'
                          name: Year 1
                          startDate: '2020-01-01'
                        - description: ''
                          endDate: '2021-12-31'
                          name: Year 2
                          startDate: '2021-01-01'
                      name: Two Years Ramp
                      number: R-00000268
                      subscriptionNumber: A-S00000287
                    success: true
              schema:
                $ref: '#/components/schemas/GETRampByRampNumberResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a ramp
      tags:
        - Ramps
  /v1/ramps/{rampNumber}/ramp-metrics:
    get:
      description: >
        **Note**: This operation is only available if you have the Ramps feature
        enabled. The
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature must be enabled before you can access the
        [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)
        feature. The Ramps feature is available for customers with Enterprise
        and Nine editions by default. If you are a Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information coming October 2020.


        Retrieves key metrics about a specified ramp, including the following
        metrics:


        * TCB, TCV in the Ramp level

        * TCB, TCV in the Interval level

        * TCB, TCV, Quantity, and MRR in Interval Metrics

        * Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta
        Metrics


        See [Key metrics for
        Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps)
        for more information.
      operationId: GET_RampMetricsByRampNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The automatically generated number of a ramp. For example,
            R-00000268.
          in: path
          name: rampNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    rampMetrics:
                      description: ''
                      discountTcb: 0
                      discountTcv: 0
                      grossTcb: 240
                      grossTcv: 240
                      intervals:
                        - description: ''
                          discountTcb: 0
                          discountTcv: 0
                          endDate: '2020-12-31'
                          grossTcb: 120
                          grossTcv: 120
                          intervalMetrics:
                            - chargeNumber: C-00000202
                              discountTcb: 0
                              discountTcv: 0
                              endDate: '2020-12-31'
                              grossTcb: 120
                              grossTcv: 120
                              mrr:
                                - discount: 0
                                  endDate: '2020-12-31'
                                  gross: 10
                                  net: 10
                                  startDate: '2020-01-01'
                              netTcb: 120
                              netTcv: 120
                              productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                              quantity: 1
                              ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
                              startDate: '2020-01-01'
                              subscriptionNumber: A-S00000287
                          name: Year 1
                          netTcb: 120
                          netTcv: 120
                          startDate: '2020-01-01'
                        - description: ''
                          discountTcb: 0
                          discountTcv: 0
                          endDate: '2021-12-31'
                          grossTcb: 120
                          grossTcv: 120
                          intervalMetrics:
                            - chargeNumber: C-00000202
                              discountTcb: 0
                              discountTcv: 0
                              endDate: '2021-12-31'
                              grossTcb: 120
                              grossTcv: 120
                              mrr:
                                - discount: 0
                                  endDate: '2021-12-31'
                                  gross: 10
                                  net: 10
                                  startDate: '2021-01-01'
                              netTcb: 120
                              netTcv: 120
                              productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                              quantity: 1
                              ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
                              startDate: '2021-01-01'
                              subscriptionNumber: A-S00000287
                          name: Year 2
                          netTcb: 120
                          netTcv: 120
                          startDate: '2021-01-01'
                      name: Two Years Ramp
                      netTcb: 240
                      netTcv: 240
                      number: R-00000268
                    success: true
              schema:
                $ref: '#/components/schemas/GETRampMetricsByRampNumberResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all ramp metrics of a ramp
      tags:
        - Ramps
  /v1/subscriptions/{subscriptionKey}/ramps:
    get:
      description: >
        **Note**: This operation is only available if you have the Ramps feature
        enabled. The
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature must be enabled before you can access the
        [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)
        feature. The Ramps feature is available for customers with Enterprise
        and Nine editions by default. If you are a Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information coming October 2020.

         Retrieves the definition of the ramp associated with a specified subscription.
      operationId: GET_RampsBySubscriptionKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The ID or number of an existing subscription.
          in: path
          name: subscriptionKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    ramps:
                      - charges:
                          - chargeNumber: C-00000202
                        description: ''
                        id: 40289f7b7321f5ce0173229d798300cf
                        intervals:
                          - description: ''
                            endDate: '2020-12-31'
                            name: Year 1
                            startDate: '2020-01-01'
                          - description: ''
                            endDate: '2021-12-31'
                            name: Year 2
                            startDate: '2021-01-01'
                        name: Two Years Ramp
                        number: R-00000268
                        subscriptionNumber: A-S00000287
                    success: true
              schema:
                $ref: '#/components/schemas/GETRampsBySubscriptionKeyResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a ramp by subscription key
      tags:
        - Ramps
  /v1/subscriptions/{subscriptionKey}/ramp-metrics:
    get:
      description: >
        **Note**: This operation is only available if you have the Ramps feature
        enabled. The
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature must be enabled before you can access the
        [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)
        feature. The Ramps feature is available for customers with Enterprise
        and Nine editions by default. If you are a Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information coming October 2020.


        Retrieves key ramp metrics about a specified subscription, including the
        following metrics:


        * TCB, TCV in the Ramp level

        * TCB, TCV in the Interval level

        * TCB, TCV, Quantity, and MRR in Interval Metrics

        * Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta
        Metrics


        See [Key metrics for
        Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps)
        for more information.
      operationId: GET_RampMetricsBySubscriptionKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The ID or number of an existing subscription.
          in: path
          name: subscriptionKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    rampMetrics:
                      description: ''
                      discountTcb: 0
                      discountTcv: 0
                      grossTcb: 240
                      grossTcv: 240
                      intervals:
                        - description: ''
                          discountTcb: 0
                          discountTcv: 0
                          endDate: '2020-12-31'
                          grossTcb: 120
                          grossTcv: 120
                          intervalMetrics:
                            - chargeNumber: C-00000202
                              discountTcb: 0
                              discountTcv: 0
                              endDate: '2020-12-31'
                              grossTcb: 120
                              grossTcv: 120
                              mrr:
                                - discount: 0
                                  endDate: '2020-12-31'
                                  gross: 10
                                  net: 10
                                  startDate: '2020-01-01'
                              netTcb: 120
                              netTcv: 120
                              productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                              quantity: 1
                              ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
                              startDate: '2020-01-01'
                              subscriptionNumber: A-S00000287
                          name: Year 1
                          netTcb: 120
                          netTcv: 120
                          startDate: '2020-01-01'
                        - description: ''
                          discountTcb: 0
                          discountTcv: 0
                          endDate: '2021-12-31'
                          grossTcb: 120
                          grossTcv: 120
                          intervalMetrics:
                            - chargeNumber: C-00000202
                              discountTcb: 0
                              discountTcv: 0
                              endDate: '2021-12-31'
                              grossTcb: 120
                              grossTcv: 120
                              mrr:
                                - discount: 0
                                  endDate: '2021-12-31'
                                  gross: 10
                                  net: 10
                                  startDate: '2021-01-01'
                              netTcb: 120
                              netTcv: 120
                              productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                              quantity: 1
                              ratePlanChargeId: 40289f7b7321f5ce0173229d792c00c8
                              startDate: '2021-01-01'
                              subscriptionNumber: A-S00000287
                          name: Year 2
                          netTcb: 120
                          netTcv: 120
                          startDate: '2021-01-01'
                      name: Two Years Ramp
                      netTcb: 240
                      netTcv: 240
                      number: R-00000268
                    success: true
              schema:
                $ref: >-
                  #/components/schemas/GETRampMetricsBySubscriptionKeyResponseType
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List ramp metrics by subscription key
      tags:
        - Ramps
  /v1/orders/{orderNumber}/ramp-metrics:
    get:
      description: >
        **Note**: This operation is only available if you have the Ramps feature
        enabled. The
        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
        feature must be enabled before you can access the
        [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)
        feature. The Ramps feature is available for customers with Enterprise
        and Nine editions by default. If you are a Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information coming October 2020.


        Retrieves key ramp metrics about a specified order, including the
        following metrics:


        * TCB, TCV in the Ramp level

        * TCB, TCV in the Interval level

        * TCB, TCV, Quantity, and MRR in Interval Metrics

        * Delta TCB, Delta TCV, Delta Quantity, and Delta MRR in Interval Delta
        Metrics


        See [Key metrics for
        Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/F_Key_metrics_for_Ramps)
        for more information.
      operationId: GET_RampMetricsByOrderNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The number of the existing order.
          in: path
          name: orderNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    rampMetrics:
                      - description: ''
                        discountTcb: 0
                        discountTcv: 0
                        grossTcb: 240
                        grossTcv: 240
                        intervals:
                          - description: ''
                            discountTcb: 0
                            discountTcv: 0
                            endDate: '2020-12-31'
                            grossTcb: 120
                            grossTcv: 120
                            intervalDeltaMetrics:
                              - chargeNumber: C-00000204
                                deltaDiscountTcb: 0
                                deltaDiscountTcv: 0
                                deltaGrossTcb: 120
                                deltaGrossTcv: 120
                                deltaMrr:
                                  - discount: 0
                                    endDate: '2020-12-31'
                                    gross: 10
                                    net: 10
                                    startDate: '2020-01-01'
                                deltaNetTcb: 120
                                deltaNetTcv: 120
                                deltaQuantity:
                                  - amount: 1
                                    endDate: '2020-12-31'
                                    startDate: '2020-01-01'
                                productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                                subscriptionNumber: A-S00000289
                            intervalMetrics:
                              - chargeNumber: C-00000204
                                discountTcb: 0
                                discountTcv: 0
                                endDate: '2020-12-31'
                                grossTcb: 120
                                grossTcv: 120
                                mrr:
                                  - discount: 0
                                    endDate: '2020-12-31'
                                    gross: 10
                                    net: 10
                                    startDate: '2020-01-01'
                                netTcb: 120
                                netTcv: 120
                                productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                                quantity: 1
                                ratePlanChargeId: 40289f7b7322a15901732392a904000a
                                startDate: '2020-01-01'
                                subscriptionNumber: A-S00000289
                            name: Year 1
                            netTcb: 120
                            netTcv: 120
                            startDate: '2020-01-01'
                          - description: ''
                            discountTcb: 0
                            discountTcv: 0
                            endDate: '2021-12-31'
                            grossTcb: 120
                            grossTcv: 120
                            intervalDeltaMetrics:
                              - chargeNumber: C-00000204
                                deltaDiscountTcb: 0
                                deltaDiscountTcv: 0
                                deltaGrossTcb: 120
                                deltaGrossTcv: 120
                                deltaMrr:
                                  - discount: 0
                                    endDate: '2021-12-31'
                                    gross: 10
                                    net: 10
                                    startDate: '2021-01-01'
                                deltaNetTcb: 120
                                deltaNetTcv: 120
                                deltaQuantity:
                                  - amount: 1
                                    endDate: '2021-12-31'
                                    startDate: '2021-01-01'
                                productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                                subscriptionNumber: A-S00000289
                            intervalMetrics:
                              - chargeNumber: C-00000204
                                discountTcb: 0
                                discountTcv: 0
                                endDate: '2021-12-31'
                                grossTcb: 120
                                grossTcv: 120
                                mrr:
                                  - discount: 0
                                    endDate: '2021-12-31'
                                    gross: 10
                                    net: 10
                                    startDate: '2021-01-01'
                                netTcb: 120
                                netTcv: 120
                                productRatePlanChargeId: 40289f7b7115832f0171158e6dd906cd
                                quantity: 1
                                ratePlanChargeId: 40289f7b7322a15901732392a904000a
                                startDate: '2021-01-01'
                                subscriptionNumber: A-S00000289
                            name: Year 2
                            netTcb: 120
                            netTcv: 120
                            startDate: '2021-01-01'
                        name: Two Years Ramp
                        netTcb: 240
                        netTcv: 240
                        number: R-00000270
                    success: true
              schema:
                $ref: '#/components/schemas/GETRampMetricsByOrderNumberResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List ramp metrics by order number
      tags:
        - Ramps
  /v1/subscriptions/preview:
    post:
      description: >
        The REST API reference describes how to create a new subscription in
        preview mode. This call does not require a valid customer account. It
        can be used to show potential new customers a preview of a subscription
        with complete details and charges before creating an account, or to let
        existing customers preview a subscription with all charges before
        committing.



        **Notes**: 


        - The response of the Preview Subscription call is based on the REST API
        minor version you set in the request header. The response structure
        might be different if you use different minor version numbers. 



        - If you have the Invoice Settlement feature enabled, we recommend that
        you set the `Zuora-Version` parameter to `207.0` or later [available
        versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
        Otherwise, an error is returned.



        - Default values for **customerAcceptanceDate** and
        **serviceActivationDate** are set as follows.



        |         | serviceActivationDate(SA) specified          |
        serviceActivationDate (SA) NOT specified  |

        | ------------- |:-------------| :-----|

        | customerAcceptanceDate (CA) specified | SA uses value in the request
        call; CA uses value in the request call| CA uses value in the request
        call;SA uses CE as default |

        | customerAcceptanceDate (CA) NOT specified | SA uses value in the
        request call; CA uses SA as default  |   SA and CA use CE as default |
      operationId: POST_PreviewSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTSubscriptionPreviewType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    contractedMrr: 14.99
                    totalContractedValue: 179.88
                    amount: 14.99
                    amountWithoutTax: 14.99
                    taxAmount: 0
                    invoiceTargetDate: '2024-07-11'
                    documentDate: '2024-07-11'
                    invoiceItems:
                      - serviceStartDate: '2024-07-01'
                        serviceEndDate: '2024-07-31'
                        chargeAmount: 14.99
                        taxAmount: 0
                        chargeDescription: ''
                        chargeName: Monthly Fee
                        productName: Music Service
                        productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
                        quantity: 1
                        unitOfMeasure: ''
              schema:
                $ref: '#/components/schemas/POSTSubscriptionPreviewResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Preview a subscription
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}/preview:
    post:
      description: >

        Describes how to preview an existing subscription to view information
        about existing and future invoices or credit memos. 
             
        **Note**: The `Zuora-Version` parameter must be `207.0` or later.
      operationId: PreviewExistingSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >

            The minor version of the Zuora REST API. 


            You need to set this parameter if you use the following fields:

            * targetDate

            * includeExistingDraftDocItems

            * previewType

            * taxationItems



            If you have the Invoice Settlement feature enabled, you need to
            specify this parameter. Otherwise, an error is returned.
          in: header
          name: Zuora-Version
          required: false
          schema:
            type: string
        - description: Subscription number or ID
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewExistingSubscriptionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                invoices:
                  - invoiceNumber: Preview Invoice
                    amount: 10
                    amountWithoutTax: 10
                    taxAmount: 0
                    targetDate: '2024-02-01'
                    status: null
                    isFromExistingInvoice: false
                    invoiceItems:
                      - serviceStartDate: '2024-01-01'
                        serviceEndDate: '2024-01-31'
                        amountWithoutTax: 10
                        taxAmount: 0
                        chargeDescription: Recurring Flat Fee Pricing
                        chargeName: Recurring_Flat Fee Pricing1628472350306
                        chargeNumber: C-0000001
                        productName: P_1628472348863
                        productRatePlanChargeId: 402881547b216168017b2884182f12e7
                        processingType: Charge
                        unitPrice: 10
                        quantity: 1
                        unitOfMeasure: null
                creditMemos:
                  - creditMemoNumber: Preview Credit Memo
                    amount: 10
                    amountWithoutTax: 10
                    taxAmount: 0
                    targetDate: '2024-02-01'
                    status: null
                    isFromExistingCreditMemo: false
                    creditMemoItems:
                      - serviceStartDate: '2024-01-01'
                        serviceEndDate: '2024-01-31'
                        amountWithoutTax: 10
                        taxAmount: 0
                        chargeDescription: Recurring Flat Fee Pricing
                        chargeName: Recurring_Flat Fee Pricing1628472350306
                        chargeNumber: C-0000001
                        productName: P_1628472348863
                        productRatePlanChargeId: 402881547b216168017b2884182f12e7
                        processingType: Charge
                        unitPrice: 10
                        quantity: 1
                        unitOfMeasure: null
                success: true
              schema:
                $ref: '#/components/schemas/PreviewExistingSubscriptionResponse'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Preview a subscription by subscription key
      tags:
        - Subscriptions
      x-accepts: application/json
      x-codegen-request-body-name: Request
      x-content-type: application/json
  /v1/subscriptions:
    post:
      description: >
        This operation describes how to create a new subscription for an
        existing customer account.


        ### Notes


        If you have the Invoice Settlement feature enabled, it is best practice
        to set


        the `Zuora-Version` parameter to `211.0` or later [available
        versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).


        Otherwise, an error occurs.



        Default values for **customerAcceptanceDate** and
        **serviceActivationDate** are


        set as follows. This API operation does not support creating a pending
        subscription.


        |        | serviceActivationDate(SA) specified          |
        serviceActivationDate (SA) NOT specified  |

        | ------------- |:------------- | :-----|

        | customerAcceptanceDate (CA) specified| SA uses value in the request
        call; CA uses value in the request call| CA uses value in the request
        call;SA uses CE as default |

        | customerAcceptanceDate (CA) NOT specified      | SA uses value in the
        request call; CA uses SA as default |   SA and CA use CE as default |



        This call supports a subset of the functionality of our [Create an
        order](https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/)
        call. 

        We recommend using "Create an order" instead of this call because the
        Orders call has the following advantages: 

        - Provides options for managing the entire subscription lifecycle from
        creation through to cancellation using different order actions. 

        - Allows the creation or modifying of multiple subscriptions in a single
        order. 

        - Allows a single order to combine both recurring subscription digital
        goods or services with order line items for physical goods.

        - Orders are treated as atomic transactions. If any part fails, the
        entire order and subscription changes are rolled back.


        This call can be used to create a single subscription and there are no
        deprecation plans for this call. We will continue to support this call.
      operationId: POST_Subscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTSubscriptionType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    subscriptionId: 8ad087d290a5e7330190b98577936eaf
                    subscriptionNumber: A-S00000141
                    contractedMrr: 14.99
                    totalContractedValue: 179.88
              schema:
                $ref: '#/components/schemas/POSTSubscriptionResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a subscription
      tags:
        - Subscriptions
  /v1/subscriptions/accounts/{account-key}:
    get:
      description: >
        Retrieves all subscriptions associated with the specified account. Zuora
        only returns the latest version of the subscriptions.


        Subscription data is returned in reverse chronological order based on
        `updatedDate`. Note that the rate plans inside the subscriptions are not
        sorted specifically and are returned in a random order.
      operationId: GET_SubscriptionsByAccount
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: |

            Possible values are:
            * an account number
            * an account ID
          in: path
          name: account-key
          required: true
          schema:
            type: string
        - description: >
            The segmented rate plan charges.


            When an amendment results in a change to a charge, Zuora creates a
            segmented rate plan charge. Use this field to track segment charges.


            Possible values are:


            * __last-segment__: (Default) The last rate plan charge on the
            subscription, that is, the last segmented rate plan charge with the
            maximum start and end dates.
             * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate).
             
             * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.

             * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.
          in: query
          name: charge-detail
          required: false
          schema:
            type: string
        - description: >
            The date for `charge-detail`. It is only available when
            `charge-detail` is `specific-segment`.


            The date should be in the format `YYYY-MM-DD`.
          in: query
          name: as-of-date
          schema:
            type: string
        - description: >
            When a rate plan charge has multiple segments, the last segment is
            returned by default. 


            If this charge has been removed before the start date of the last
            segment (the latest one), with this parameter set to `true`, this
            charge is excluded from the response; 

            If all the charges under a rate plan are excluded, the rate plan is
            not returned in the response.


            The default value is `false`.
          in: query
          name: exclude-rate-plans-with-no-charges
          required: false
          schema:
            type: boolean
        - description: |2-
             If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response.
            The default value is `false`. 
          in: query
          name: getDetailedMetrics
          schema:
            type: boolean
            default: false
        - description: >-

            The date for detailed metrics. Only available when
            `getDetailedMetrics` is `true`. The date should be in the format
            `YYYY-MM-DD`.

            The default value is the current date. 
          in: query
          name: asOfDay
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    subscriptions:
                      - accountId: 8a8082c45aa81b51015ad64396090f5c
                        accountName: ABCD
                        accountNumber: A00002641
                        autoRenew: true
                        billToContact:
                          address1: ''
                          address2: ''
                          city: ''
                          country: null
                          county: null
                          fax: ''
                          firstName: Test
                          homePhone: ''
                          id: 2c9081a03c6d7b51013c6d7e46c80a17
                          lastName: Test
                          mobilePhone: ''
                          nickname: ''
                          otherPhone: ''
                          otherPhoneType: null
                          personalEmail: ''
                          state: ''
                          taxRegion: null
                          workEmail: contact@example.com
                          workPhone: ''
                          zipCode: ''
                        contractEffectiveDate: '2017-01-01'
                        contractedMrr: 8.33
                        contractedNetMrr: 8.33
                        asOfDayGrossMrr: 8.33
                        asOfDayNetMrr: 8.33
                        netTotalContractedValue: 8.33
                        currency: USD
                        currentTerm: 12
                        currentTermPeriodType: Month
                        customerAcceptanceDate: '2017-01-01'
                        id: 8a8082c45aa81b51015ad68743ec0fdb
                        initialTerm: 12
                        initialTermPeriodType: Month
                        invoiceGroupNumber: N-0001
                        invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c
                        invoiceOwnerAccountName: ABCD
                        invoiceOwnerAccountNumber: A00002641
                        invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                        invoiceSeparately: false
                        invoiceTemplateId: 2c9081a03c638994013c63978baf002b
                        invoiceTemplateName: InvoiceTemplateName
                        notes: ''
                        paymentTerm: Net 30
                        ratePlans:
                          - id: 8a8082c45aa81b51015ad68744030fe3
                            productId: 8a8082c45aa81b51015ad5a2d07d0e89
                            productName: ABC
                            productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
                            productSku: SKU-00000987
                            contractedNetMrr: 8.33
                            contractedMrr: 8.33
                            asOfDayGrossMrr: 8.33
                            asOfDayNetMrr: 8.33
                            netTotalContractedValue: 8.33
                            ratePlanCharges:
                              - applyDiscountTo: null
                                billingDay: DefaultFromCustomer
                                billingPeriod: Annual
                                billingPeriodAlignment: AlignToCharge
                                billingTiming: IN_ADVANCE
                                chargedThroughDate: null
                                currency: USD
                                description: ''
                                discountAmount: null
                                discountApplyDetails: null
                                discountClass: null
                                discountLevel: null
                                discountPercentage: null
                                dmrc: 8.333333
                                done: false
                                dtcv: 100
                                effectiveEndDate: '2018-01-01'
                                effectiveStartDate: '2017-01-01'
                                endDateCondition: Subscription_End
                                id: 8a8082c45aa81b51015ad68744160fe4
                                includedUnits: null
                                invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
                                listPriceBase: Per_Billing_Period
                                model: FlatFee
                                mrr: 8.333333
                                name: Annual Charge
                                number: C-00032238
                                numberOfPeriods: null
                                originalChargeId: 8a8082c45aa81b51015ad68744160fe4
                                overageCalculationOption: null
                                overagePrice: null
                                overageUnusedUnitsCreditOption: null
                                price: 100
                                priceChangeOption: NoChange
                                priceIncreasePercentage: null
                                pricingSummary: USD100
                                processedThroughDate: null
                                productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
                                quantity: 1
                                segment: 1
                                smoothingModel: null
                                specificBillingPeriod: null
                                specificEndDate: null
                                tcv: 100
                                tiers: null
                                triggerDate: null
                                triggerEvent: ContractEffective
                                type: Recurring
                                unusedUnitsCreditRates: null
                                uom: null
                                upToPeriods: null
                                upToPeriodsType: null
                                usageRecordRatingOption: null
                                version: 1
                              - applyDiscountTo: ONETIMERECURRINGUSAGE
                                billingDay: DefaultFromCustomer
                                billingPeriod: Month
                                billingPeriodAlignment: AlignToCharge
                                billingTiming: null
                                chargedThroughDate: null
                                currency: USD
                                description: ''
                                discountAmount: 10
                                discountApplyDetails:
                                  - appliedProductName: ABC
                                    appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
                                    appliedProductRatePlanChargeName: Annual Charge
                                    appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
                                    appliedProductRatePlanName: RatePlan 1
                                  - appliedProductName: ABC
                                    appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
                                    appliedProductRatePlanChargeName: Annual Charge
                                    appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
                                    appliedProductRatePlanName: RatePlan 1
                                discountClass: VIP Discount
                                discountLevel: subscription
                                discountPercentage: null
                                dmrc: 0
                                done: false
                                dtcv: 0
                                effectiveEndDate: '2018-01-01'
                                effectiveStartDate: '2017-01-01'
                                endDateCondition: Subscription_End
                                id: 8a8082c45aa81b51015ad68744240fe5
                                includedUnits: null
                                invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
                                listPriceBase: null
                                model: DiscountFixedAmount
                                mrr: 0
                                name: Discount-Fixed 10
                                number: C-00032239
                                numberOfPeriods: null
                                originalChargeId: 8a8082c45aa81b51015ad68744240fe5
                                overageCalculationOption: null
                                overagePrice: null
                                overageUnusedUnitsCreditOption: null
                                price: null
                                priceChangeOption: null
                                priceIncreasePercentage: null
                                pricingSummary: USD10 fixed amount discount
                                processedThroughDate: null
                                productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8
                                quantity: null
                                segment: 1
                                smoothingModel: null
                                specificBillingPeriod: null
                                specificEndDate: null
                                tcv: 0
                                tiers: null
                                triggerDate: null
                                triggerEvent: ContractEffective
                                type: Recurring
                                unusedUnitsCreditRates: null
                                uom: null
                                upToPeriods: null
                                upToPeriodsType: null
                                usageRecordRatingOption: null
                                version: 1
                              - amendedByOrderOn: null
                                applyDiscountTo: null
                                billingDay: DefaultFromCustomer
                                billingPeriod: Month
                                billingPeriodAlignment: AlignToCharge
                                billingTiming: IN_ADVANCE
                                chargeModelConfiguration: null
                                chargedThroughDate: null
                                currency: USD
                                description: ''
                                discountAmount: null
                                discountApplyDetails: null
                                discountClass: null
                                discountLevel: null
                                discountPercentage: null
                                dmrc: 38.571428571
                                done: false
                                dtcv: 468
                                effectiveEndDate: '2026-01-01'
                                effectiveStartDate: '2024-12-31'
                                endDateCondition: Subscription_End
                                id: 4028818386ba85070186bab54f99573d
                                includedUnits: null
                                inputArgumentId: null
                                invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
                                listPriceBase: Per_Billing_Period
                                model: Delivery
                                mrr: 38.571428571
                                name: Delivery Charge
                                number: C-00032240
                                numberOfDeliveries: 52
                                numberOfPeriods: null
                                originalChargeId: 4028818386ba85070186bab54f065731
                                originalOrderDate: '2023-01-01'
                                overageCalculationOption: null
                                overagePrice: null
                                overageUnusedUnitsCreditOption: null
                                price: 9
                                priceChangeOption: null
                                priceIncreasePercentage: null
                                pricingSummary: ''
                                processedThroughDate: null
                                productRatePlanChargeId: 4028818386b61be50186b6293eb30017
                                quantity: 1
                                ratingGroup: null
                                segment: 3
                                smoothingModel: null
                                specificBillingPeriod: null
                                specificEndDate: null
                                subscriptionChargeDeliverySchedule:
                                  dayOfMonth: null
                                  frequency: Weekly
                                  friday: false
                                  monday: false
                                  monthOfYear: null
                                  saturday: false
                                  sunday: true
                                  thursday: false
                                  tuesday: false
                                  wednesday: false
                                subscriptionChargeIntervalPricing:
                                  - duration: 365
                                    price: 5
                                    sequence: 1
                                    subscriptionChargeIntervalPriceTiers: []
                                    type: Day
                                  - duration: 365
                                    price: 7
                                    sequence: 2
                                    subscriptionChargeIntervalPriceTiers: []
                                    type: Day
                                  - duration: null
                                    price: 9
                                    sequence: 3
                                    subscriptionChargeIntervalPriceTiers: []
                                    type: Infinity
                                tcv: 468
                                tiers: null
                                triggerDate: null
                                triggerEvent: ContractEffective
                                type: Recurring
                                unusedUnitsCreditRates: null
                                uom: null
                                upToPeriods: null
                                upToPeriodsType: null
                                usageRecordRatingOption: null
                                version: 1
                            ratePlanName: RatePlan 1
                        renewalSetting: RENEW_WITH_SPECIFIC_TERM
                        renewalTerm: 12
                        renewalTermPeriodType: Month
                        revision: '1.0'
                        sequenceSetId: 6abcc30846de11e990900242ac1f0003
                        sequenceSetName: DEFAULT
                        serviceActivationDate: '2017-01-01'
                        soldToContact:
                          address1: ''
                          address2: ''
                          city: ''
                          country: null
                          county: null
                          fax: ''
                          firstName: Test
                          homePhone: ''
                          id: 2c9081a03c6d7b51013c6d7e46c80a17
                          lastName: Test
                          mobilePhone: ''
                          nickname: ''
                          otherPhone: ''
                          otherPhoneType: null
                          personalEmail: ''
                          state: ''
                          taxRegion: null
                          workEmail: contact@example.com
                          workPhone: ''
                          zipCode: ''
                        status: Active
                        subscriptionNumber: A-S00007412
                        subscriptionStartDate: '2017-01-01'
                        termEndDate: '2018-01-01'
                        termStartDate: '2017-01-01'
                        termType: TERMED
                        totalContractedValue: 100
                        version: 1
                    success: true
              schema:
                $ref: '#/components/schemas/GETSubscriptionWrapper'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List subscriptions by account key
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}:
    get:
      description: |
        This REST API reference describes how to retrieve detailed information
        about a specified subscription in the latest version.
      operationId: GET_SubscriptionsByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            Possible values are:
              * a subscription number
              * a subscription ID
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
        - description: >

            The segmented rate plan charges. When an amendment results in a
            change to a charge, Zuora creates a segmented rate plan charge. Use
            this field to track segment charges.


            Possible values are:

             * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates.
             * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate).
             
             * __all-segments__: All the segmented charges. The `ratePlans` > `ratePlanCharges` >`chargeSegments` nested field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.

             * __specific-segment__: Use this value together with `as-of-date={specificDate}`. The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)) is returned. The format of the date is `yyyy-mm-dd`.
          in: query
          name: charge-detail
          required: false
          schema:
            type: string
        - description: >
            The date for `charge-detail`. It is only available when
            `charge-detail` is `specific-segment`.


            The date should be in the format `YYYY-MM-DD`.
          in: query
          name: as-of-date
          schema:
            type: string
        - description: >
            When a rate plan charge has multiple segments, the last segment is
            returned by default. 


            If this charge has been removed before the start date of the last
            segment (the latest one), with this parameter set to `true`, this
            charge is excluded from the response; 

            If all the charges under a rate plan are excluded, the rate plan is
            not returned in the response.



            The default value is `false`.
          in: query
          name: exclude-rate-plans-with-no-charges
          required: false
          schema:
            type: boolean
        - description: |2-
             If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response.
            The default value is `false`. 
          in: query
          name: getDetailedMetrics
          schema:
            type: boolean
            default: false
        - name: asOfDay
          description: >
            The date for detailed metrics. Only available when
            `getDetailedMetrics` is `true`.

            The date should be in the format `YYYY-MM-DD`.


            The default value is the current date. 
          in: query
          schema:
            type: string
        - description: >-
            Retrieves the invoice owner of a subscription. If this parameter is
            set to `true`, the invoice owner account details
            `invoiceOwnerAccountDetails` will be in the response. 
          in: query
          name: getInvoiceOwnerDetails
          schema:
            type: boolean
        - description: >-
            Retrieves the owner of a subscription. If this parameter is set to
            `true`, the subscription owner account details `accountOwnerDetails`
            will be in the response. 
          in: query
          name: getSubscriptionOwnerDetails
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 8a8082c45aa81b51015ad64396090f5c
                    accountName: ABCD
                    accountNumber: A00002641
                    accountOwnerDetails:
                      accountNumber: A00000001
                      batch: Batch1
                      communicationProfileId: 303d186840e611df817c002185d714e1
                      crmId: ''
                      id: 402892c74c9193cd014c91d35b0a0132
                      invoiceTemplateId: null
                      name: Test
                      notes: ''
                      partnerAccount: false
                      profileNumber: CP-00000012
                      salesRep: ''
                      sequenceSetId: null
                      status: Active
                      summaryStatementTemplateId: null
                      purchaseOrderNumber: ''
                    invoiceOwnerAccountDetails:
                      accountNumber: A00000001
                      batch: Batch1
                      communicationProfileId: 303d186840e611df817c002185d714e1
                      crmId: ''
                      id: 402892c74c9193cd014c91d35b0a0132
                      invoiceTemplateId: null
                      name: Test
                      notes: ''
                      partnerAccount: false
                      profileNumber: CP-00000012
                      salesRep: ''
                      sequenceSetId: null
                      status: Active
                    autoRenew: true
                    contractEffectiveDate: '2017-01-01'
                    contractedMrr: 8.33
                    contractedNetMrr: 8.33
                    asOfDayGrossMrr: 8.33
                    asOfDayNetMrr: 8.33
                    netTotalContractedValue: 8.33
                    currency: USD
                    currentTerm: 12
                    currentTermPeriodType: Month
                    customerAcceptanceDate: '2017-01-01'
                    id: 8a8082c45aa81b51015ad68743ec0fdb
                    initialTerm: 12
                    initialTermPeriodType: Month
                    invoiceGroupNumber: N-0001
                    invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c
                    invoiceOwnerAccountName: ABCD
                    invoiceOwnerAccountNumber: A00002641
                    invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                    invoiceSeparately: false
                    invoiceTemplateId: 2c9081a03c638994013c63978baf002b
                    invoiceTemplateName: InvoiceTemplateName
                    notes: ''
                    paymentTerm: Net 30
                    ratePlans:
                      - id: 8a8082c45aa81b51015ad68744030fe3
                        productId: 8a8082c45aa81b51015ad5a2d07d0e89
                        productName: ABC
                        productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
                        productSku: SKU-00000987
                        contractedNetMrr: 8.33
                        contractedMrr: 8.33
                        asOfDayGrossMrr: 8.33
                        asOfDayNetMrr: 8.33
                        netTotalContractedValue: 8.33
                        ratePlanCharges:
                          - applyDiscountTo: null
                            billingDay: DefaultFromCustomer
                            billingPeriod: Annual
                            billingPeriodAlignment: AlignToCharge
                            billingTiming: IN_ADVANCE
                            chargedThroughDate: null
                            currency: USD
                            description: ''
                            discountAmount: null
                            discountApplyDetails: null
                            discountClass: null
                            discountLevel: null
                            discountPercentage: null
                            dmrc: 8.333333
                            done: false
                            dtcv: 100
                            effectiveEndDate: '2018-01-01'
                            effectiveStartDate: '2017-01-01'
                            endDateCondition: Subscription_End
                            id: 8a8082c45aa81b51015ad68744160fe4
                            includedUnits: null
                            invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
                            listPriceBase: Per_Billing_Period
                            model: FlatFee
                            mrr: 8.333333
                            name: Annual Charge
                            number: C-00032238
                            numberOfPeriods: null
                            originalChargeId: 8a8082c45aa81b51015ad68744160fe4
                            overageCalculationOption: null
                            overagePrice: null
                            overageUnusedUnitsCreditOption: null
                            price: 100
                            priceChangeOption: NoChange
                            priceIncreasePercentage: null
                            pricingSummary: USD100
                            processedThroughDate: null
                            productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
                            quantity: 1
                            segment: 1
                            smoothingModel: null
                            specificBillingPeriod: null
                            specificEndDate: null
                            tcv: 100
                            tiers: null
                            triggerDate: null
                            triggerEvent: ContractEffective
                            type: Recurring
                            unusedUnitsCreditRates: null
                            uom: null
                            upToPeriods: null
                            upToPeriodsType: null
                            usageRecordRatingOption: null
                            version: 1
                          - applyDiscountTo: ONETIMERECURRINGUSAGE
                            billingDay: DefaultFromCustomer
                            billingPeriod: Month
                            billingPeriodAlignment: AlignToCharge
                            billingTiming: null
                            chargedThroughDate: null
                            currency: USD
                            description: ''
                            discountAmount: 10
                            discountApplyDetails:
                              - appliedProductName: ABC
                                appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f
                                appliedProductRatePlanChargeName: Annual Charge
                                appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d
                                appliedProductRatePlanName: RatePlan 1
                            discountClass: VIP Discount
                            discountLevel: subscription
                            discountPercentage: null
                            dmrc: 0
                            done: false
                            dtcv: 0
                            effectiveEndDate: '2018-01-01'
                            effectiveStartDate: '2017-01-01'
                            endDateCondition: Subscription_End
                            id: 8a8082c45aa81b51015ad68744240fe5
                            includedUnits: null
                            invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
                            listPriceBase: null
                            model: DiscountFixedAmount
                            mrr: 0
                            name: Discount-Fixed 10
                            number: C-00032239
                            numberOfPeriods: null
                            originalChargeId: 8a8082c45aa81b51015ad68744240fe5
                            overageCalculationOption: null
                            overagePrice: null
                            overageUnusedUnitsCreditOption: null
                            price: null
                            priceChangeOption: null
                            priceIncreasePercentage: null
                            pricingSummary: USD10 fixed amount discount
                            processedThroughDate: null
                            productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8
                            quantity: null
                            segment: 1
                            smoothingModel: null
                            specificBillingPeriod: null
                            specificEndDate: null
                            tcv: 0
                            tiers: null
                            triggerDate: null
                            triggerEvent: ContractEffective
                            type: Recurring
                            unusedUnitsCreditRates: null
                            uom: null
                            upToPeriods: null
                            upToPeriodsType: null
                            usageRecordRatingOption: null
                            version: 1
                          - amendedByOrderOn: null
                            applyDiscountTo: null
                            billingDay: DefaultFromCustomer
                            billingPeriod: Month
                            billingPeriodAlignment: AlignToCharge
                            billingTiming: IN_ADVANCE
                            chargeModelConfiguration: null
                            chargedThroughDate: null
                            currency: USD
                            description: ''
                            discountAmount: null
                            discountApplyDetails: null
                            discountClass: null
                            discountLevel: null
                            discountPercentage: null
                            dmrc: 38.571428571
                            done: false
                            dtcv: 468
                            effectiveEndDate: '2026-01-01'
                            effectiveStartDate: '2024-12-31'
                            endDateCondition: Subscription_End
                            id: 4028818386ba85070186bab54f99573d
                            includedUnits: null
                            inputArgumentId: null
                            invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
                            listPriceBase: Per_Billing_Period
                            model: Delivery
                            mrr: 38.571428571
                            name: Delivery Charge
                            number: C-00032240
                            numberOfDeliveries: 52
                            numberOfPeriods: null
                            originalChargeId: 4028818386ba85070186bab54f065731
                            originalOrderDate: '2023-01-01'
                            overageCalculationOption: null
                            overagePrice: null
                            overageUnusedUnitsCreditOption: null
                            price: 9
                            priceChangeOption: null
                            priceIncreasePercentage: null
                            pricingSummary: ''
                            processedThroughDate: null
                            productRatePlanChargeId: 4028818386b61be50186b6293eb30017
                            quantity: 1
                            ratingGroup: null
                            segment: 3
                            smoothingModel: null
                            specificBillingPeriod: null
                            specificEndDate: null
                            subscriptionChargeDeliverySchedule:
                              dayOfMonth: null
                              frequency: Weekly
                              friday: false
                              monday: false
                              monthOfYear: null
                              saturday: false
                              sunday: true
                              thursday: false
                              tuesday: false
                              wednesday: false
                            subscriptionChargeIntervalPricing:
                              - duration: 365
                                price: 5
                                sequence: 1
                                subscriptionChargeIntervalPriceTiers: []
                                type: Day
                              - duration: 365
                                price: 7
                                sequence: 2
                                subscriptionChargeIntervalPriceTiers: []
                                type: Day
                              - duration: null
                                price: 9
                                sequence: 3
                                subscriptionChargeIntervalPriceTiers: []
                                type: Infinity
                            tcv: 468
                            tiers: null
                            triggerDate: null
                            triggerEvent: ContractEffective
                            type: Recurring
                            unusedUnitsCreditRates: null
                            uom: null
                            upToPeriods: null
                            upToPeriodsType: null
                            usageRecordRatingOption: null
                            version: 1
                        ratePlanName: RatePlan 1
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerm: 12
                    renewalTermPeriodType: Month
                    revision: '1.0'
                    sequenceSetId: 6abcc30846de11e990900242ac1f0003
                    sequenceSetName: DEFAULT
                    serviceActivationDate: '2017-01-01'
                    billToContact:
                      address1: ''
                      address2: ''
                      city: ''
                      country: null
                      county: null
                      fax: ''
                      firstName: Test
                      homePhone: ''
                      id: 2c9081a03c6d7b51013c6d7e46c80a17
                      lastName: Test
                      mobilePhone: ''
                      nickname: ''
                      otherPhone: ''
                      otherPhoneType: null
                      personalEmail: ''
                      state: ''
                      taxRegion: null
                      workEmail: contact@example.com
                      workPhone: ''
                      zipCode: ''
                    soldToContact:
                      address1: ''
                      address2: ''
                      city: ''
                      country: null
                      county: null
                      fax: ''
                      firstName: Test
                      homePhone: ''
                      id: 2c9081a03c6d7b51013c6d7e46c80a17
                      lastName: Test
                      mobilePhone: ''
                      nickname: ''
                      otherPhone: ''
                      otherPhoneType: null
                      personalEmail: ''
                      state: ''
                      taxRegion: null
                      workEmail: contact@example.com
                      workPhone: ''
                      zipCode: ''
                    status: Active
                    subscriptionNumber: A-S00007412
                    subscriptionStartDate: '2017-01-01'
                    success: true
                    termEndDate: '2018-01-01'
                    termStartDate: '2017-01-01'
                    termType: TERMED
                    totalContractedValue: 100
                    version: 1
              schema:
                $ref: '#/components/schemas/GETSubscriptionByKeyWithSuccess'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a subscription by key
      tags:
        - Subscriptions
    put:
      description: >
        Use this call to make the following kinds of changes to a subscription:
          - Add a note
          - Change the renewal term or auto-renewal flag
          - Change the term length or change between evergreen and termed
          - Add a new product rate plan
          - Remove an existing subscription rate plan
          - Change the quantity or price of an existing subscription rate plan
          - Change rate plans - to replace the existing rate plans in a subscription with other rate plans. Changing rate plans is currently not supported for the <a href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration" target="_blank">Billing - Revenue Integration</a> feature. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing.

        ### Notes:


        - The "Update a subscription" call creates a new subscription object
        that has a new version number and to which the subscription changes are
        applied. The new subscription object has the same subscription name but
        a new, different, subscription ID. The `Status` field of the new
        subscription object will be set to `Active` unless the change applied
        was a cancelation or suspension in which case the status reflects that.
        The `Status` field of the originating subscription object changes from
        `Active` to `Expired`. A status of `Expired` does not imply that the
        subscription itself has expired or ended, merely that this subscription
        object is no longer the most recent. 

        - In one request, this call can make:  
          - Up to 9 combined add, update, and remove changes 
          - No more than 1 change to terms & conditions

        - Updates are performed in the following sequence:
          1. First change the notes on the existing subscription, if requested.
          2. Then change the terms and conditions, if requested.
          3. Then perform the remaining amendments based upon the effective dates specified. If multiple amendments have the same contract-effective dates, then execute adds before updates, and updates before removes.
          
        - The update operation is atomic. If any of the updates fails, the
        entire operation is rolled back.

        - The response of the Update Subscription call is based on the REST API
        minor version you set in the request header. The response structure
        might be different if you use different minor version numbers.

        - If you have the Invoice Settlement feature enabled, it is best
        practice to set the `Zuora-Version` parameter to `211.0` or later
        [available
        versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
        Otherwise, an error occurs.


        ### Override a Tiered Price


        There are two ways you override a tiered price:

        - Override a specific tier number. For example:
        `tiers[{tier:1,price:8},{tier:2,price:6}]`

        - Override the entire tier structure. For example: 
        `tiers[{tier:1,price:8,startingUnit:1,endingUnit:100,priceFormat:"FlatFee"},
        {tier:2,price:6,startingUnit:101,priceFormat:"FlatFee"}]`


        If you just override a specific tier, do not include the `startingUnit`
        field in the request.
      operationId: PUT_Subscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >

            Subscription number or ID. 

            ID can be the latest version or any history version of ID. 

            * To make sure you update the last version of the subscription, use
            one of the following operations to retrieve the last version of ID:
              * [List subscriptions by account key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByAccount)
              * [Retrieve a subscription by key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKey) by using the subscription number as the subscription-key
            * If you want to use any history version of ID, the
            `STABLE_ID_PUBLIC_API` permission must be enabled. Submit a request
            at [Zuora Global Support](http://support.zuora.com/) to enable the
            permission. To retrieve a history version of ID, use the [Retrieve a
            subscription by key and
            version](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKeyAndVersion)
            operation.
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTSubscriptionType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    subscriptionId: 4028bb83510f8ed7015114a503cf0373
                    success: true
                    totalDeltaMrr: 100
                    totalDeltaTcv: 4867.7419355
              schema:
                $ref: '#/components/schemas/PUTSubscriptionResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a subscription
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}/versions/{version}:
    get:
      description: >
        This REST API reference describes how to retrieve detailed information
        about a specified subscription in a specified version. When you create a
        subscription amendment, you create a new version of the subscription.
        You can use this method to retrieve information about a subscription in
        any version.
      operationId: GET_SubscriptionsByKeyAndVersion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            Subscription number. For example, A-S00000135.
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
        - description: |
            Subscription version. For example, 1.
          in: path
          name: version
          required: true
          schema:
            type: string
        - description: >

            The segmented rate plan charges. When an amendment results in a
            change to a charge, Zuora creates a segmented rate plan charge. Use
            this field to track segment charges.


            Possible values are:

             * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates.
             * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate).
             
             * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments.

             * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.
          in: query
          name: charge-detail
          required: false
          schema:
            type: string
        - description: >
            The date for `charge-detail`. It is only available when
            `charge-detail` is `specific-segment`.


            The date should be in the format `YYYY-MM-DD`.
          in: query
          name: as-of-date
          schema:
            type: string
        - description: >
            When a rate plan charge has multiple segments, the last segment is
            returned by default. 


            If this charge has been removed before the start date of the last
            segment (the latest one), with this parameter set to `true`, this
            charge is excluded from the response; 

            If all the charges under a rate plan are excluded, the rate plan is
            not returned in the response.



            The default value is `false`.
          in: query
          name: exclude-rate-plans-with-no-charges
          required: false
          schema:
            type: boolean
        - description: |2-
             If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response.
            The default value is `false`. 
          in: query
          name: getDetailedMetrics
          schema:
            type: boolean
            default: false
        - description: >-

            The date for detailed metrics. Only available when
            `getDetailedMetrics` is `true`. The date should be in the format
            `YYYY-MM-DD`.

            The default value is the current date. 
          in: query
          name: asOfDay
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 2c9081a03c63c94c013c66688a2c00bf
                    accountName: RestAPI
                    accountNumber: RestAPI
                    autoRenew: false
                    contractEffectiveDate: '2012-02-01'
                    contractedMrr: 26.67
                    contractedNetMrr: 26.67
                    asOfDayGrossMrr: 26.67
                    asOfDayNetMrr: 26.67
                    netTotalContractedValue: 26.67
                    currency: USD
                    currentTerm: 12
                    currentTermPeriodType: Week
                    customerAcceptanceDate: '2012-02-01'
                    id: 2c9081a03c63c94c013c687b864e0195
                    initialTermPeriodType: Week
                    invoiceGroupNumber: N-0001
                    invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a
                    notes: ''
                    ratePlans:
                      - id: 2c9081a03c63c94c013c687b868901a4
                        productId: 2c9081a03c63c94c013c66499ef0001b
                        productName: OneTime
                        productRatePlanId: 2c9081a03c63c94c013c665102e5003a
                        productSku: SKU-00000022
                        contractedNetMrr: 26.67
                        contractedMrr: 26.67
                        asOfDayGrossMrr: 26.67
                        asOfDayNetMrr: 26.67
                        netTotalContractedValue: 26.67
                        ratePlanCharges:
                          - applyDiscountTo: null
                            billingDay: null
                            billingPeriod: null
                            billingPeriodAlignment: null
                            billingTiming: null
                            chargedThroughDate: '2012-02-02'
                            currency: USD
                            description: ''
                            discountAmount: null
                            discountLevel: null
                            discountPercentage: null
                            dmrc: null
                            done: true
                            dtcv: 24
                            effectiveEndDate: '2012-02-02'
                            effectiveStartDate: '2012-02-01'
                            endDateCondition: One_Time
                            id: 2c9081a03c63c94c013c687b868901a5
                            includedUnits: null
                            invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5
                            listPriceBase: null
                            model: Tiered
                            mrr: null
                            name: OT_Tiered
                            number: C-00000010
                            numberOfPeriods: null
                            originalChargeId: 2c9081a03c63c94c013c687a92d70175
                            overageCalculationOption: null
                            overagePrice: null
                            overageUnusedUnitsCreditOption: null
                            price: null
                            priceChangeOption: null
                            priceIncreasePercentage: null
                            pricingSummary: >-
                              0 to 10 Each: USD20 flat fee;  11 Each or more:
                              USD4/Each
                            processedThroughDate: '2012-02-02'
                            productRatePlanChargeId: 2c9081a03c63c94c013c6651d677003c
                            quantity: 11
                            segment: 1
                            smoothingModel: null
                            specificBillingPeriod: null
                            specificEndDate: null
                            tcv: 24
                            tiers:
                              - endingUnit: 10
                                price: 20
                                priceFormat: FlatFee
                                startingUnit: 0
                                tier: 1
                              - endingUnit: null
                                price: 4
                                priceFormat: PerUnit
                                startingUnit: 11
                                tier: 2
                            triggerDate: null
                            triggerEvent: ContractEffective
                            type: OneTime
                            unusedUnitsCreditRates: null
                            uom: Each
                            upToPeriods: null
                            upToPeriodsType: null
                            usageRecordRatingOption: null
                            version: 1
                        ratePlanName: OT_Tiered
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerm: 0
                    renewalTermPeriodType: Week
                    revision: '1.0'
                    serviceActivationDate: '2012-02-01'
                    status: Active
                    subscriptionNumber: A-S00000004
                    subscriptionStartDate: '2012-02-01'
                    success: true
                    termEndDate: '2013-02-01'
                    termStartDate: '2012-02-01'
                    termType: TERMED
                    totalContractedValue: 404
                    version: 1
              schema:
                $ref: '#/components/schemas/GETSubscriptionTypeWithSuccess'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a subscription by key and version
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}/renew:
    put:
      description: >
        Renews a termed subscription using existing renewal terms. When you
        renew a subscription, the current subscription term is extended by
        creating a new term.  If any charge in your subscription has the billing
        period set as `SubscriptionTerm`, a new charge segment is generated for
        the new term.


        **Note**: If you have the Invoice Settlement feature enabled, it is best
        practice to set the `Zuora-Version` parameter to `211.0` or later
        [available
        versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
        Otherwise, an error occurs.
      operationId: PUT_RenewSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Subscription number or ID
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTRenewSubscriptionType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    subscriptionId: 2c92c8f83dcbd8b1013dcce0f09100a5
                    success: true
                    termEndDate: '2014-05-01'
                    termStartDate: '2014-02-01'
              schema:
                $ref: '#/components/schemas/PUTRenewSubscriptionResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Renew a subscription
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}/cancel:
    put:
      description: >
        This REST API reference describes how to cancel an active subscription.


        **Note**: If you have the Invoice Settlement feature enabled, it is best
        practice to set the `Zuora-Version` parameter to `211.0` or later
        [available
        versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
        Otherwise, an error occurs.
      operationId: PUT_CancelSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Subscription number or ID. Subscription status must be `Active`.
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTSubscriptionCancellationType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    cancelledDate: '2019-05-31'
                    invoiceId: 8a8082c453cd2a620153e426c7eb78b3
                    subscriptionId: 8a8082c453cd2a620154efc7bba0350e
                    success: true
                    totalDeltaMrr: 0
                    totalDeltaTcv: -703.2258065
              schema:
                $ref: '#/components/schemas/POSTSubscriptionCancellationResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a subscription
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}/resume:
    put:
      description: >
        This REST API reference describes how to resume a suspended
        subscription.


        **Note**: If you have the Invoice Settlement feature enabled, it is best
        practice to set the `Zuora-Version` parameter to `211.0` or later
        [available
        versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
        Otherwise, an error occurs.
      operationId: PUT_ResumeSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Subscription number or ID. Subscription status must be Suspended.
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTSubscriptionResumeType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    subscriptionId: 6429c37b5a392e093172e68779c24021
                    resumeDate: '2024-11-01'
                    termEndDate: '2025-01-13'
                    totalDeltaTcv: 167.070913965
              schema:
                $ref: '#/components/schemas/PUTSubscriptionResumeResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Resume a subscription
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}/suspend:
    put:
      description: >
        This REST API reference describes how to suspend an active subscription.


        **Note**: If you have the Invoice Settlement feature enabled, it is best
        practice to set the `Zuora-Version` parameter to `211.0` or later
        [available
        versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
        Otherwise, an error occurs.
      operationId: PUT_SuspendSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Subscription number or ID. Subscription status must be Active.
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTSubscriptionSuspendType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    subscriptionId: 8ad0937890e7fca00190fd3ff7ca7f08
                    suspendDate: '2024-07-28'
                    resumeDate: null
                    termEndDate: '2025-07-22'
                    totalDeltaTcv: -176.978709679
              schema:
                $ref: '#/components/schemas/PUTSubscriptionSuspendResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Suspend a subscription
      tags:
        - Subscriptions
  /v1/subscriptions/{subscription-key}/delete:
    put:
      description: >
        This REST API reference describes how to delete a subscription of the
        specified subscription number.
      operationId: PUT_DeleteSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Subscription number
          in: path
          name: subscription-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/PUTDeleteSubscriptionResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a subscription by number
      tags:
        - Subscriptions
  /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields:
    put:
      description: |
        Updates the custom fields of a specified subscription version.
      operationId: PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The subscription number to be updated.
          in: path
          name: subscriptionNumber
          required: true
          schema:
            format: string
            type: string
        - description: The subscription version to be updated.
          in: path
          name: version
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PUTSubscriptionPatchSpecificVersionRequestType
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update subscription custom fields of a subscription version
      tags:
        - Subscriptions
  /v1/subscriptions/subscription-metrics:
    get:
      description: >
        Lists subscription metrics for the subscriptions that you specify by
        subscription numbers.
      operationId: GetMetricsBySubscriptionNumbers
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            The date for the metrics. The date should be in the format
            `YYYY-MM-DD`. The default value is the current date.
          in: query
          name: asOfDay
          schema:
            type: string
        - description: The subscription numbers of existing subscriptions.
          in: query
          name: subscriptionNumbers[]
          required: true
          schema:
            type: array
            items:
              type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                subscriptionMetrics:
                  - subscriptionNumber: A-S00000008
                    contractedMrr: 100
                    contractedNetMrr: 100
                    asOfDayGrossMrr: 100
                    asOfDayNetMrr: 100
                    netTotalContractedValue: 100
                    totalContractedValue: 100
                  - subscriptionNumber: A-S00000009
                    contractedMrr: 100
                    contractedNetMrr: 100
                    asOfDayGrossMrr: 100
                    asOfDayNetMrr: 100
                    netTotalContractedValue: 100
                    totalContractedValue: 100
                success: true
              schema:
                $ref: '#/components/schemas/GETMetricsBySubscriptionNumbersResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List subscription metrics by subscription numbers
      tags:
        - Subscriptions
  /v1/rateplans/{ratePlanId}:
    get:
      description: >

        Retrieves the detailed information about a specific subscription rate
        plan.



        - If you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders"
        target="_blank">Orders</a>

        feature enabled, this operation retrieves information about a
        subscription rate

        plan and the related order that has amended the rate plan.



        - If you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders_Harmonization"
        target="_blank">Orders Harmonization</a>

        feature enabled, this operation retrieves information about a
        subscription rate plan and the related order and amendment that have
        amended the rate plan.

        The returned objects may be different since amendment, order, and order
        action are generated asynchronously.
          - If all are generated, the related amendment and order, including the order action, are returned. 
          - If not, only the related amendment may be returned before generating the order and order action.


        - If you are an existing Zuora Subscribe and Amend customer, this
        operation retrieves

        information about a subscription rate plan and the related amendment
        that has

        amended the rate plan.



        **Note:** Orders is now generally available as of Zuora Billing Release
        284 (August

        2020). If you are an existing Zuora Subscribe and Amend customer and
        want to adopt

        Orders, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders_Harmonization/A_Overview_of_Orders_Harmonization"
        target="_blank">What is Orders Harmonization</a>

        and join the <a
        href="https://community.zuora.com/t5/Orders-Harmonization/gp-p/Orders-Harmonization"
        target="_blank">Orders Harmonization community group</a>

        for more information. If you want to enable Orders, submit a request at
        <a href="https://support.zuora.com/" target="_blank">Zuora

        Global Support</a>.



        **Note:** You can only retrieve information about the following order
        actions:


        - `addProduct`

        - `updateProduct`

        - `removeProduct`

        - `changePlan`
      operationId: GET_RatePlan
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the subscription rate plan to be retrieved.
          in: path
          name: ratePlanId
          required: true
          schema:
            format: string
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amendment:
                      code: A-AM00000047
                      contractEffectiveDate: '2021-12-29'
                      createdBy: 2c9890207c9649c0017c969bc6330002
                      createdDate: '2021-10-29 19:44:16'
                      customerAcceptanceDate: '2021-12-29'
                      description: null
                      effectiveDate: '2021-12-29'
                      id: 402880e47ccbaca1017ccbdd63c818cb
                      name: update
                      serviceActivationDate: '2021-12-29'
                      type: UpdateProduct
                      updatedBy: 2c9890207c9649c0017c969bc6330002
                      updatedDate: '2021-10-29 19:44:16'
                    id: 402880e47ccbaca1017ccbdd63aa18c8
                    lastChangeType: Update
                    order:
                      id: 402880e47ccbaca1017ccbdd7b0e18fd
                      orderActions:
                        - contractEffectiveDate: '2021-12-29'
                          customerAcceptanceDate: '2021-12-29'
                          id: 402880e47ccbaca1017ccbdd7b1418ff
                          serviceActivationDate: '2021-12-29'
                          type: UpdateProduct
                          updateProduct:
                            chargeUpdates: []
                            customFields: {}
                            newRatePlanId: 402880e47ccbaca1017ccbdd63aa18c8
                            productRatePlanId: 2c9890207c9649c0017c96a0f11001a4
                            ratePlanId: 402880e47ccbaca1017ccbdd620818ba
                            specificUpdateDate: null
                            uniqueToken: null
                      orderNumber: O-00000037
                    productId: 2c9890207c9649c0017c96a0588201a2
                    productName: MMORPG game
                    productRatePlanId: 2c9890207c9649c0017c96a0f11001a4
                    productSku: SKU-00000001
                    ratePlanName: Rate Plan 1
                    subscriptionId: 402880e47ccbaca1017ccbdd644d18d0
                    subscriptionVersion: 5
                    success: true
              schema:
                $ref: '#/components/schemas/GetOrderActionRatePlanResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a rate plan
      tags:
        - Rate Plans
  /v1/omni-channel-subscriptions:
    post:
      description: >
        Creates or updates an omnichannel subscription for a customer account.


        You can also create a new customer account and assign it to the new
        omnichannel subscription.
      operationId: postOmnichannelSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOmniChannelSubscriptionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
                subscriptionId: 54be52bbb1b9288bbf82942e00de0000
                subscriptionNumber: A-S00000001
                accountId: 2c98906e9288bc0b0192942dfbdc316d
                accountNumber: AN_1729062894303
              schema:
                $ref: '#/components/schemas/CreateOmniChannelSubscriptionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        4XX:
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Create an omnichannel subscription
      tags:
        - Omnichannel Subscriptions
  /v1/omni-channel-subscriptions/{subscriptionKey}:
    get:
      description: 'Retrieves the information about a specific omnichannel subscription. '
      operationId: getOmnichannelSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_get_account_details'
        - description: >-
            The ID or number of the omnichannel subscription to be retrieved.
            The ID may be a Zuora subscription ID or an external system
            subscription ID.
          in: path
          name: subscriptionKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
                id: 303d186840e611df817c002185d714e1
                subscriptionNumber: A-S00000001
                externalSubscriptionId: 56cc93ed3767476782cf2f150e38249c
                accountId: 2c98906e9288bc0b0192942dfbdc316d
                externalTransactionReason: Purchase
                externalSourceSystem: Apple
                externalState: Grace
                state: Active
                externalProductId: 874d2a0ef3ad43d5b3402771f56aca1d
                externalReplaceByProductId: null
                externalInAppOwnershipType: Purchase
                externalQuantity: 1
                currency: USD
                autoRenew: false
                originalPurchaseDate: '2024-02-01 00:01:15'
                externalPurchaseDate: '2024-03-05 10:42:11'
                externalActivationDate: '2024-03-01 12:12:12'
                externalExpirationDate: '2024-06-01 12:12:12'
                externalApplicationId: external-application-id
                externalBundleId: external-bundle-id
                externalSubscriberId: external-subscriber-id
                externalPrice: 100
                externalPurchaseType: Purchase
                externalLastRenewalDate: '2024-03-01 12:12:12'
                externalNextRenewalDate: '2024-09-01 12:12:12'
              schema:
                $ref: '#/components/schemas/GetOmniChannelSubscriptionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
      summary: Retrieve an omnichannel subscription
      tags:
        - Omnichannel Subscriptions
    delete:
      description: 'Deletes a specified omnichannel subscription. '
      operationId: deleteOmnichannelSubscription
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The key of the omnichannel subscription to be deleted.
          in: path
          name: subscriptionKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        4XX:
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an omnichannel subscription
      tags:
        - Omnichannel Subscriptions
  /v1/subscription-change-logs/{subscriptionNumber}:
    get:
      description: >
        Lists subscription change histories of a single version subscription.
        Each history maps to an order.

        See the `subscriptions` > `fields`, `ratePlans` > `fields`, and
        `ratePlanCharges` > `fields` fields for the changes in the subscription,
        subscription rate plans, and subscription rate plan charges.


        **Note**: This operation is only available if you have the following
        features turned on:

          - <a href="https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders" target="_blank">Orders</a>
          
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Single_Version_Subscription" target="_blank">Single Version Subscription</a>
      operationId: getSubscriptionChangeLogsBySubscriptionNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The subscription number to be retrieved.
          in: path
          name: subscriptionNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
                subscriptions:
                  - subscriptionNumber: A-S00000001
                    version: 2
                    subscriptionStartDate: '2021-01-01'
                    subscriptionEndDate: '2023-02-01'
                    termStartDate: '2021-02-01'
                    termEndDate: '2023-02-01'
                    accountNumber: AN_1723454733315
                    invoiceOwnerAccountNumber: AN_1723454733315
                    currency: USD
                    orderNumber: O-00000002
                    type: Standard
                    externalSubscriptionId: null
                    changedTime: '2024-08-12 02:25:36'
                    ratePlans:
                      - ratePlanNumber: SRP-00000001
                        ratePlanCharges:
                          - chargeNumber: C-00000001
                            ratePlanChargeId: 28b907304229145dff3145e84432000a
                            effectiveStartDate: '2021-01-01'
                            effectiveEndDate: '2023-02-01'
                            fields:
                              - fieldName: effectiveEndDate
                                oldValue: '2022-01-01'
                                newValue: '2023-02-01'
                        fields: []
                    fields:
                      - fieldName: initialTerm
                        oldValue: '12'
                        newValue: '2'
                      - fieldName: initialTermPeriodType
                        oldValue: Month
                        newValue: Year
                  - subscriptionNumber: A-S00000001
                    version: 1
                    subscriptionStartDate: '2021-01-01'
                    subscriptionEndDate: '2022-01-01'
                    termStartDate: '2021-01-01'
                    termEndDate: '2022-01-01'
                    accountNumber: AN_1723454733315
                    invoiceOwnerAccountNumber: AN_1723454733315
                    currency: USD
                    orderNumber: O-00000001
                    type: Standard
                    externalSubscriptionId: null
                    changedTime: '2024-08-12 02:25:35'
                    ratePlans:
                      - ratePlanNumber: SRP-00000001
                        ratePlanCharges:
                          - chargeNumber: C-00000001
                            ratePlanChargeId: 28b907304229145dff3145e84432000a
                            effectiveStartDate: '2021-01-01'
                            effectiveEndDate: '2022-01-01'
                            fields:
                              - fieldName: price
                                oldValue: null
                                newValue: '100'
                              - fieldName: quantity
                                oldValue: null
                                newValue: '1'
                        fields:
                          - fieldName: RP_CF1__c
                            oldValue: null
                            newValue: Init value for rp cf 1
                    fields:
                      - fieldName: accountId
                        oldValue: null
                        newValue: ff8080819145e003019145e83c4657cb
                      - fieldName: autoRenew
                        oldValue: null
                        newValue: 'false'
              schema:
                $ref: '#/components/schemas/GetSubscriptionChangeLogsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List change histories of a subscription
      tags:
        - Subscription Change History
  /v1/subscription-change-logs/orders/{orderNumber}:
    get:
      description: >
        List the change histories of single version subscriptions that are
        included in and processed by an order. Each history maps to a
        subscription associated with this order.

        See the `subscriptions` > `fields`, `ratePlans` > `fields`, and
        `ratePlanCharges` > `fields` fields for the changes in the subscription,
        subscription rate plans, and subscription rate plan charges.


        **Note**: This operation is only available if you have the following
        features turned on:

          - <a href="https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders" target="_blank">Orders</a>
          
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Single_Version_Subscription" target="_blank">Single Version Subscription</a>
      operationId: getSubscriptionChangeLogsByOrderNumber
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The order number associated with the subscription to be retrieved.
          in: path
          name: orderNumber
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
                subscriptions:
                  - subscriptionNumber: A-S00000001
                    version: 1
                    subscriptionStartDate: '2021-01-01'
                    subscriptionEndDate: '2022-01-01'
                    termStartDate: '2021-01-01'
                    termEndDate: '2022-01-01'
                    accountNumber: AN_1723456739867
                    invoiceOwnerAccountNumber: AN_1723456739867
                    currency: USD
                    orderNumber: O-00000001
                    type: Standard
                    externalSubscriptionId: null
                    changedTime: '2024-08-12 02:59:00'
                    ratePlans:
                      - ratePlanNumber: SRP-00000001
                        ratePlanCharges:
                          - chargeNumber: C-00000001
                            ratePlanChargeId: 240207304399145dff314606db890009
                            effectiveStartDate: '2021-01-01'
                            effectiveEndDate: '2022-01-01'
                            fields:
                              - fieldName: price
                                oldValue: null
                                newValue: '100'
                              - fieldName: quantity
                                oldValue: null
                                newValue: '1'
                        fields: []
                    fields:
                      - fieldName: accountId
                        oldValue: null
                        newValue: ff8080819145e00301914606da4c613f
                      - fieldName: autoRenew
                        oldValue: null
                        newValue: 'false'
                  - subscriptionNumber: A-S00000002
                    version: 1
                    subscriptionStartDate: '2021-01-01'
                    subscriptionEndDate: '2023-01-01'
                    termStartDate: '2021-01-01'
                    termEndDate: '2023-01-01'
                    accountNumber: AN_1723456739867
                    invoiceOwnerAccountNumber: AN_1723456739867
                    currency: USD
                    orderNumber: O-00000001
                    type: Standard
                    externalSubscriptionId: null
                    changedTime: '2024-08-12 02:59:00'
                    ratePlans:
                      - ratePlanNumber: SRP-00000002
                        ratePlanCharges:
                          - chargeNumber: C-00000002
                            ratePlanChargeId: 240207304399145dff314606dbe50014
                            effectiveStartDate: '2021-01-01'
                            effectiveEndDate: '2023-01-01'
                            fields:
                              - fieldName: price
                                oldValue: null
                                newValue: '400'
                              - fieldName: quantity
                                oldValue: null
                                newValue: '1'
                        fields: []
                    fields:
                      - fieldName: accountId
                        oldValue: null
                        newValue: ff8080819145e00301914606da4c613f
                      - fieldName: autoRenew
                        oldValue: null
                        newValue: 'false'
              schema:
                $ref: '#/components/schemas/GetSubscriptionChangeLogsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List change histories of subscriptions by order number
      tags:
        - Subscription Change History
  /v1/subscription-change-logs/{subscriptionNumber}/versions/{version}:
    get:
      description: >
        Retrieves the change history of a single version subscription by
        version. This version indicates the creation sequence of the orders
        associated with the subscription and starts from `1`. 

        See the `subscription` > `fields`, `ratePlans` > `fields`, and
        `ratePlanCharges` > `fields` fields for the changes in the subscription,
        subscription rate plans, and subscription rate plan charges.


        **Note**: This operation is only available if you have the following
        features turned on:

          - <a href="https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders" target="_blank">Orders</a>
          
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Single_Version_Subscription" target="_blank">Single Version Subscription</a>
      operationId: getSubscriptionChangelogByVersion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The subscription number to be retrieved.
          in: path
          name: subscriptionNumber
          required: true
          schema:
            type: string
        - description: >
            This version indicates the creation sequence of the orders
            associated with the subscription and starts from `1`.
          in: path
          name: version
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
                subscription:
                  subscriptionNumber: A-S00000001
                  version: 2
                  subscriptionStartDate: '2021-01-01'
                  subscriptionEndDate: '2023-02-01'
                  termStartDate: '2021-02-01'
                  termEndDate: '2023-02-01'
                  accountNumber: AN_1723454733315
                  invoiceOwnerAccountNumber: AN_1723454733315
                  currency: USD
                  orderNumber: O-00000002
                  type: Standard
                  externalSubscriptionId: null
                  changedTime: '2024-08-12 02:25:36'
                  ratePlans:
                    - ratePlanNumber: SRP-00000001
                      ratePlanCharges:
                        - chargeNumber: C-00000001
                          ratePlanChargeId: 28b907304229145dff3145e84432000a
                          effectiveStartDate: '2021-01-01'
                          effectiveEndDate: '2023-02-01'
                          fields:
                            - fieldName: effectiveEndDate
                              oldValue: '2022-01-01'
                              newValue: '2023-02-01'
                      fields: []
                  fields:
                    - fieldName: initialTerm
                      oldValue: '12'
                      newValue: '2'
                    - fieldName: initialTermPeriodType
                      oldValue: Month
                      newValue: Year
              schema:
                $ref: '#/components/schemas/GetSubscriptionChangeLogResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51001122'
                    message: '''billToContact'' may not be null'
                  - code: '51000030'
                    message: >-
                      If 'billingCycleDay' is absent,
                      'subscription.contractEffectiveDate' is necessary
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a change history of a subscription by version
      tags:
        - Subscription Change History
  /v1/ppdd/reverse-rollover:
    post:
      description: >
        This REST API reference describes how to manually reverse fund rollover
        from source validity period to destination validity period. There are no
        path or query parameters.


        **Note**: This API will not work if the associated prepayment charge has
        rollover enabled.
      operationId: POST_ReverseRollover
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTReverseRolloverRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Reverse rollover is done
                    reverseRolloverFundCount: 1
                    success: true
              schema:
                $ref: '#/components/schemas/POSTReverseRolloverResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data. 


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Reverse fund rollover
      tags:
        - Prepaid with Drawdown
  /v1/ppdd/rollover:
    post:
      description: >
        Prepaid with Drawdown Rollover enables you to transfer the accumulative
        carryover of your customers’ prepaid balance funds to the following
        validity period when using Prepaid with Drawdown. This REST API
        reference describes how to manually trigger fund rollover from source
        validity period to destination validity period. There are no path or
        query parameters.


        **Note**: This API will not work if rollover is enabled in the
        associated prepayment charge. If you want to trigger rollover
        automatically, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown/Create_prepayment_charge_with_rollover"
        target="_blank">Create prepayment charge with rollover</a> for more
        information.
      operationId: POST_Rollover
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTTriggerRolloverRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Rollover is done
                    rolloverFundCount: 1
                    success: true
              schema:
                $ref: '#/components/schemas/POSTTriggerRolloverResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Trigger fund rollover
      tags:
        - Prepaid with Drawdown
  /v1/prepaid-balance-funds/deplete:
    post:
      description: >-
        Depleting a prepaid balance fund enables you to expire the remaining
        balance, which can be recognized by revenue. When an expiry request is
        received, the remaining fund balance is reduced to zero, and the related
        objects like PrepaidBalance, ValidityPeriodSummary,
        PrepaidBalanceTransaction, and DailyConsumption will be updated. 
      operationId: DepleteFunds
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTDepleteFundRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fundIds:
                      - fundId: 4028818c8d3ade79018d3ae1048a5e10
                        status: success
                        message: The fund object is depleted.
                      - fundId: 4028818c8d3ade79018d3ae1048a5ef8
                        status: success
                        message: The fund object is depleted.
              schema:
                $ref: '#/components/schemas/POSTDepleteFundResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Deplete funds
      tags:
        - Prepaid with Drawdown
  /v1/usage:
    post:
      description: >
        This REST API reference describes how to post or import usage data for
        one or more accounts in the CSV format. There are no path or query
        parameters. The data is uploaded using the HTTP multipart/form-data POST
        method and applied to the user's tenant. 


        ### How this REST API Call Works

        The content of the uploaded usage file must follow the format used by
        the UI import tool. It must be a comma-separated (CSV) file with a
        corresponding .csv extension. The length of the file name must not
        exceed 50 characters. The file size must not exceed 4MB. See
        [Downloading the Usage
        Template](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/Usage/C_Import_Usage_Data#Downloading_the_Usage_Template)
        to learn about how to download the usage file template.


        At the completion of the upload, before the file contents are actually
        being processed, the API returns a response containing the byte count of
        the received file and a URL for checking the status of the import
        process.  Of the five possible results displayed at that URL (Pending,
        Processing, Completed, Canceled, and Failed) only a Completed status
        indicates that the import was successful.  The operation is atomic; if
        any record fails, the file is rejected. In that case, the entire import
        is rolled back and all stored data is returned to its original state.


        To view the actual import status, enter the resulting status URL from
        the checkImportStatus response using a tool such as POSTMAN. This
        additional step provides more information about why the import has
        failed.


        To manage the information after a successful upload, use the web-based
        UI.


        #### Dynamic pricing usage charges

        When the uploaded   file contains rows that reference a product rate
        plan charge configured for dynamic pricing,   the upload is rejected and
        those rows are not imported. Legacy Billing usage import does not  
        support sending usage to dynamic pricing usage charges.

        To send usage to a dynamic pricing   usage charge, use Mediation to
        ingest and rate the events. Mediation generates usage records   that are
        later consumed by Billing, instead of relying on this bulk upload
        endpoint.


        ### Usage File Format

        The usage file uses the following headings: 


        | Heading         | Description   | Required |

        |-----------------|--------|----------|

        | ACCOUNT_ID      | Enter the account number, e.g., the default account
        number, such as A00000001, or your custom account number. Although this
        field is labeled as Account_Id, it is not the actual Account ID nor
        Account Name.  | Yes      |

        | UOM             | Enter the unit of measure. This must match the UOM
        for the usage. | Yes      |

        | QTY             | Enter the quantity.  | Yes      |

        | STARTDATE       | Enter the start date of the usage. This date
        determines the invoice item service period the associated usage is
        billed to. Date format is based on locale of the current user. Default
        date format: `MM/DD/YYYY`. | Yes |

        | ENDDATE         | Enter the end date of the usage. This is not used in
        calculations for usage billing and is optional. Date format is based on
        locale of the current user. Default date format: `MM/DD/YYYY`.
        <p>**Note:** The value of this column is optional, but the column header
        is required.</p> | No |

        | PRODUCT_RATE_PLAN_CHARGE_ID | Enter a product rate plan charge number
        so that you can charge your customer with a dynamic usage charge for the
        corresponding uploaded usage record. <p>**Note:** The value of this
        column is optional, but the column header is required. To use this
        field, you must set the `X-Zuora-WSDL-Version` request header to `146`
        or higher. Otherwise, an error occurs.</p>  | No   |

        | SUBSCRIPTION_ID | Enter the subscription number or subscription name.
        If you created the subscription in the Zuora application, Zuora created
        a number automatically in a format similar to A-S00000001. If you do not
        provide a value for this field, the associated usage will be added to
        all subscriptions for the specified Account that use this Unit Of
        Measure. If your Accounts can have multiple subscriptions and you do not
        want double or triple counting of usage, you must specify the
        Subscription or Charge ID in each usage record.  <p>**Note:** The value
        of this column is optional, but the column header is required.</p>  |
        No   |

        | CHARGE_ID       | Enter the charge number (not the charge name). You
        can see the charge ID, e.g., C-00000001, when you add your rate plan to
        your subscription and view your individual charges. If your Accounts can
        have multiple subscriptions and you do not want double or triple
        counting of usage, you must specify the specific Subscription or Charge
        ID in each usage record. This field is related to the Charge Number on
        the subscription rate plan.  <p>**Note:** The value of this column is
        optional, but the column header is required.</p>  | No      |

        | DESCRIPTION     | Enter a description for the charge. | No       |

        | UNIQUE_KEY      | Enter a specific identifier for this usage record.
        **Note**: This Heading is supported by the following features: <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_with_Drawdown">Prepaid
        with Drawdown</a>, and <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Unbilled_Usage">Unbilled
        Usage</a>. See <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_with_Drawdown/L_Prepaid_balance_transactions#Upload_usage_record_with_unique_key">Upload
        usage record with unique key</a> for more information.  | No      |
      operationId: POST_Usage
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: >
                    The usage data to import. The supported formats are excel,
                    csv, and zip.
                  format: binary
                  type: string
              required:
                - file
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    checkImportStatus: /v1/usage/2c92c8f83dcbd8b1013dcce1159900cc/status
                    size: 316
                    success: true
              schema:
                $ref: '#/components/schemas/POSTUsageResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Upload a usage file
      tags:
        - Usage
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1" -F "file=@UsageData.csv"
            "https://rest.zuora.com/v1/usage"
  /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail:
    get:
      description: >
        Use this REST API operation to retrieve the usage rate detail for an
        invoice item to understand how the total amount is calculated. The
        information is the same as the Rate Detail presented on [PDF
        invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices).  


        **Notes and limitations:**

        - Do not support the Overage Charge Model, Tiered with Overage Charge
        Model, and Multi-attribute Pricing Charge Model.

        - Do not support invoices in `Cancelled` or `Reversed` status.

        - Do not support Active rating.

        - In terms of rating group options, only the [Usage rating by billing
        period](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/Usage_Rating_by_Group#Usage_rating_by_billing_period)
        is supported.

        - Do not support [On-demand usage
        rating](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/On-demand_Usage_Rating). 

        - Tax calculation is not involved.
      operationId: GET_Usage_Rate_Detail_By_Invoice_Item
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            Invoice item ID. For example, `402880e57f725d85017f7267c4ad002b`.
            Available through Data Source export.
          in: path
          name: invoice-item-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      amountWithoutTax: 58
                      chargeNumber: C-00000001
                      invoiceId: 402880e57f725d85017f7267c44c0028
                      invoiceItemId: 402880e57f725d85017f7267c4ad002b
                      invoiceNumber: INV00000007
                      listPrice: |
                        Tier / From / To / List Price / Price Format
                        1 / 0 / 9 / 0.00 / Per Unit
                        2 / 10 / 20 / 1.00 / Per Unit
                        3 / 21 / 30 / 2.00 / Flat Fee
                        4 / 31 /   / 3.00 / Per Unit
                      quantity: 45
                      rateDetail: |-
                        Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00
                        Tier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00
                        Tier 3: 21-30, $2.00 Flat Fee
                        Tier 4: >=31, 15 Each(s) x $3.00/Each = $45.00
                        Total = $58.00
                      servicePeriod: 03/01/2022-03/31/2022
                      uom: Each
                    success: true
              schema:
                $ref: '#/components/schemas/GETUsageRateDetailWrapper'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve usage rate detail for an invoice item
      tags:
        - Usage
  /v1/object/usage:
    post:
      description: Creates a usage record.
      operationId: Object_POSTUsage
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyCreateUsage'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 8ad08ae29085a77b0190908bfdd67abb
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Create a usage record'
      tags:
        - Usage
  /v1/object/usage/{id}:
    delete:
      description: >-
        Deletes a usage record. Usage records that are associated with a dynamic
        pricing usage charge cannot be deleted with this legacy Billing
        endpoint. When a delete request targets such a record, the operation
        fails and the usage record is not removed. Operations on dynamic pricing
        usage are supported only via Mediation-driven flows.
      operationId: Object_DELETEUsage
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyDeleteResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Delete a usage record'
      tags:
        - Usage
    get:
      description: Retrieve a usage record.
      operationId: Object_GETUsage
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    AccountId: 2c92c0f956bc8fb40156d502fc3718b1
                    AccountNumber: A00000030
                    ChargeId: 2c92c0f956bc8fcb0156d5039e275aa9
                    ChargeNumber: C-00000229
                    CreatedById: 2c92c0f958fffd7d015914aeefc71a5d
                    CreatedDate: '2019-07-18T15:36:43.000+08:00'
                    Description: test
                    Id: 2c92c0f86bf50ca0016c040309316ca4
                    Quantity: 9
                    RbeStatus: Pending
                    SourceType: API
                    StartDateTime: '2017-12-01T23:41:36.000+08:00'
                    SubmissionDateTime: '2019-07-18T15:36:43.000+08:00'
                    SubscriptionId: 2c92c0f956bc8fcb0156d5039e0a5aa0
                    SubscriptionNumber: A-S00000100
                    UOM: Each
                    UpdatedById: 2c92c0f958fffd7d015914aeefc71a5d
                    UpdatedDate: '2019-07-18T15:36:43.000+08:00'
              schema:
                $ref: '#/components/schemas/ProxyGetUsage'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a usage record'
      tags:
        - Usage
    put:
      description: >-
        Updates a usage record. Updating usage records that are associated with
        a dynamic pricing usage charge is not supported through this endpoint.
        The request fails and the record is not updated. Use Mediation-based
        flows to manage such usage.
      operationId: Object_PUTUsage
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyModifyUsage'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 8ad08ae29085a77b0190908bfdd67abb
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Update a usage record'
      tags:
        - Usage
  /meters/run/{meterId}/{version}:
    post:
      tags:
        - Meters
      summary: Run a specific version of a meter
      description: >
        Executes a specific version of a meter in Zuora Mediation. You can
        choose to run it with either a local file or event store source by
        providing optional configurations.
      operationId: runSpecificVersionOfMeter
      parameters:
        - name: meterId
          in: path
          required: true
          description: The ID of the meter to run.
          schema:
            type: string
        - name: version
          in: path
          required: true
          description: The version of the meter to run.
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunMeterVersionRequest'
      responses:
        '200':
          description: Successful meter run
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunMeterVersionResponse'
              examples:
                success:
                  summary: Meter run success example
                  value:
                    success: true
                    data:
                      id: '5468'
                      sessionId: R-00005468
                      jobId: da0b43468d6a41eaad03e559d6aecceb
                      meterId: 2470
                      version: 0.0.1
                      revision: 1
                      runType: 1
                      runTypeDescription: NORMAL
                      startTime: '2025-03-31T09:17:21.192927441Z'
                      status: 10
                      statusDescription: INITIALIZING
                      canExportSummary: false
                      hasLineageEnabled: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/debug/{meterId}/{version}:
    post:
      tags:
        - Meters
      summary: Test a specific version of a meter
      description: >-
        Test a specific version of a meter in Zuora Mediation without executing
        a full run. It supports multiple input methods, including uploaded
        files, sample files, and manual test data. This is useful for validating
        meter logic and transformations before meter run.
      operationId: testSpecificVersionOfMeter
      parameters:
        - name: meterId
          in: path
          description: The ID of the meter to be tested.
          required: true
          schema:
            type: integer
        - name: version
          in: path
          description: The version of the meter to be tested.
          required: true
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestSpecificMeterRequest'
      responses:
        '200':
          description: Successfully tested meter version.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestSpecificMeterResponse'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized - Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal Server Error - Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/{meterId}/summary:
    post:
      tags:
        - Meters
      summary: Retrieve summary data for a meter
      description: >-
        Retrieves summary data for a specific meter in Zuora Mediation,
        providing a rolled-up view of a meter run or time window. The API
        supports grouping by Operator ID, Error Code, or Session ID, and allows
        optional filters such as Query From Time, Query To Time, Operator IDs,
        and Session IDs. The API returns aggregated output and error counts per
        group and includes validation with detailed error responses for invalid
        parameters or formats.
      operationId: retrieveMeterSummaryData
      parameters:
        - name: meterId
          in: path
          description: The ID of the meter.
          required: true
          schema:
            type: integer
            format: int64
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSpecificMeterSummaryRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSpecificMeterSummaryResponse'
              example:
                success: true
                data:
                  requestId: 91d46fea-67de-4abe-9cc3-6ef076bbb7ea
                  requestTime: '2025-11-20T16:41:27.858661268Z'
                  query:
                    runType: NORMAL
                    sessionIds: null
                    operatorIds: null
                    groupBy:
                      - sessionId
                    queryFromTime: null
                    queryToTime: null
                  output:
                    - dimensions:
                        sessionId: R-00002283
                      output: 10000000
                      totalErrorCount: 0
                    - dimensions:
                        sessionId: R-00002340
                      output: 10000000
                      totalErrorCount: 0
                previousPage: null
                nextPage: null
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized - Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal Server Error - Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/{meterId}/{version}/runStatus:
    get:
      tags:
        - Meters
      summary: Retrieve the run status of a specific meter version
      description: >-
        Retrieves the current run status of a specific meter version in Zuora
        Mediation. It returns an integer code indicating the status, such as
        `RUNNING`, `COMPLETED`, or `FAILED`, which helps monitor the meter's
        execution state.
      operationId: getRunStatusOfSpecificMeterVersion
      parameters:
        - name: meterId
          in: path
          required: true
          description: ID of the meter.
          schema:
            type: integer
        - name: version
          in: path
          required: true
          description: Version of the meter.
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: Successful response with run status data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunStatusResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '404':
          description: Meter not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/{meterId}/auditTrail/entries:
    get:
      tags:
        - Meters
      summary: Retrieve the audit trail entries for a meter
      description: >-
        Retrieves the audit trail entries for a specific meter in Zuora
        Mediation. The API provides detailed, record-level information about
        what happened during processing, including Payload and error details,
        operator information, and the trace ID/event ID.
      operationId: getAuditTrailEntriesForMeter
      parameters:
        - name: meterId
          in: path
          required: true
          description: ID of the meter.
          schema:
            type: integer
            format: int64
        - name: exportType
          in: query
          required: true
          description: >-
            Type of the export. `SAMPLE` indicates an export of success records,
            `ERROR` indicates an export of error records.
          schema:
            type: string
            enum:
              - SAMPLE
              - ERROR
        - name: runType
          in: query
          required: true
          description: >-
            Specifies the type of run. `DEBUG` indicates a test run, `NORMAL`
            indicates a live run.
          schema:
            type: string
            enum:
              - DEBUG
              - NORMAL
        - name: sessionId
          in: query
          required: false
          description: |
            A specific session ID.
          example: R-000001
          schema:
            type: string
        - name: queryFromTime
          in: query
          required: true
          description: >
            The minimum timestamp of the audit trail data. The standard used is
            ISO 8601 with timezones.
          schema:
            type: string
          example: 2025-07-18 T00:00:00Z
        - name: queryToTime
          in: query
          required: true
          description: >
            The maximum timestamp of the audit trail data. The standard used is
            ISO 8601 with timezones.
          schema:
            type: string
          example: 2025-07-18 T00:00:00Z
        - name: operatorId
          in: query
          required: false
          description: >
            The ID of the operator. The Operator ID is displayed for each
            operator node, for both current meters and historic runs. On the
            Mediation UI, click on a test ID or session ID to see the details of
            the run.
          schema:
            type: string
        - name: pageSize
          in: query
          required: false
          description: |
            Page size for pagination.
          schema:
            type: integer
            format: int32
            default: 30
            maximum: 500
        - name: cursor
          in: query
          required: false
          description: |
            nextPage token from previous response.
          schema:
            type: string
          example: W3sib3JkZXJ=
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditTrailResponse'
              example:
                success: true
                data:
                  - errorTime: '1753296408775'
                    errorCode: ''
                    errorMessage: ''
                    payload:
                      event time: '2025-07-01'
                      charge number: C-00000017
                      qty: 10
                      ratedAmount: '10.0'
                    eventId: 601f65ca-67f5-11f0-9e3a-5d9d6cbeef3e|0
                    traceId: 601f65ca-67f5-11f0-9e3a-5d9d6cbeef3e|0_a_b_e_d_o7normal
                    operatorType: BILLING-RATING
                    operatorName: Rating
                    operatorId: 15004c16-6242-4f50-9faf-cb1a0fe6e0f5
                previousPage: null
                nextPage: eyJjdXJzb3IiOi4uLn0=
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/{meterId}/auditTrail/export:
    get:
      tags:
        - Meters
      summary: Retrieve the list of export jobs for a meter
      description: >-
        Retrieves the list of previously initiated export jobs for a specific
        meter in Zuora Mediation. The API supports advanced filtering by time
        range, run status, run type, export type, session IDs, and operator IDs.
        Use the returned `status` and `fileList` fields to determine whether a
        job is complete and which files to download. Then use the "Retrieve the
        presigned URL for an export job" API operation with each `fileKey` in
        `fileList` to obtain the download URLs.
      operationId: getAuditTrailExportJobs
      parameters:
        - name: meterId
          in: path
          required: true
          description: ID of the meter.
          schema:
            type: integer
            format: int64
        - name: exportType
          in: query
          required: false
          description: >-
            Type of the export. `SAMPLE` indicates an export of success records,
            `ERROR` indicates an export of error records.
          schema:
            type: string
            enum:
              - SAMPLE
              - ERROR
        - name: sessionIds
          in: query
          required: false
          description: |
            The session IDs of the meter run. For example, `R-000001, R-000002`.
          schema:
            type: array
            items:
              type: string
        - name: pageSize
          in: query
          required: false
          description: |
            Page size for pagination.
          schema:
            type: integer
            format: int32
            default: 30
            maximum: 100
        - name: page
          in: query
          required: false
          description: |
            The page number.
          schema:
            type: integer
            format: int32
            default: 1
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditTrailExportResponse'
              example:
                success: true
                data:
                  page: 1
                  pageSize: 5
                  jobs:
                    - requestId: cd3367fb-019d-4600-863f-07c51b7c9e10
                      meterId: 709
                      query:
                        operatorIds: []
                        exportType: SAMPLE
                        runType: NORMAL
                        queryToTime: '2025-11-20T23:59:59Z'
                        queryFromTime: '2025-11-13T07:02:11Z'
                        format: csv
                        statuses: null
                        sessionIds: []
                      status: FINISHED
                      count: 15001524
                      creationTime: '2025-11-20T16:40:58Z'
                      completionTime: '2025-11-20T16:49:01Z'
                      fileList:
                        - cd3367fb-019d-4600-863f-07c51b7c9e10/audit_trail.csv
                previousPage: null
                nextPage: null
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
        - Meters
      summary: Create a job to export audit trail data for a meter
      description: >-
        Creates a background job to export the audit trail entries for a
        specific meter in Zuora Mediation. This API is for large-scale, offline
        access to audit data. Only one export job is processed per tenant at a
        time, and each export has a record limit, for example, up to 5 million
        rows per report. Use the returned requestId with the "Retrieve the list
        of export jobs for a meter" API operation to track the job status and
        retrieve the generated file names from `fileList`, then download them
        using the "Retrieve the presigned URL for an export job" API operation.
      operationId: createAuditTrailExportJob
      parameters:
        - name: meterId
          in: path
          description: The ID of the meter.
          required: true
          schema:
            type: integer
            format: int64
        - name: exportType
          in: query
          required: true
          description: >-
            Type of the export. `SAMPLE` indicates an export of success records,
            `ERROR` indicates an export of error records.
          schema:
            type: string
            enum:
              - SAMPLE
              - ERROR
        - name: runType
          in: query
          required: true
          description: >-
            Specifies the type of run. `DEBUG` indicates a test run, `NORMAL`
            indicates a live run.
          schema:
            type: string
            enum:
              - DEBUG
              - NORMAL
        - name: sessionIds
          in: query
          required: false
          description: >
            A list of specific run IDs to export. For example, `R-000001,
            R-000002`.
          schema:
            type: array
            items:
              type: string
        - name: runStatuses
          in: query
          required: false
          description: >
            Filters audit entries by their run status. If omitted, all statuses
            are included. Statuses are case-sensitive.

            Possible values:
              - NEVER_RUN
              - TESTING
              - TESTING_FAILED
              - TESTING_PASSED
              - RUNNING
              - PAUSED
              - COMPLETED
              - FAILED
              - CANCELED
              - INITIALIZING
              - USAGE_PUSHING
              - PUSH_COMPLETED
              - CONSUME_COMPLETED        
          schema:
            type: array
            items:
              type: string
        - name: operatorIds
          in: query
          required: false
          description: >
            A list of operator IDs to filter by. The Operator ID is displayed
            for each operator node, for both current meters and historic runs.
            On the Mediation UI, click on a test ID or session ID to see the
            details of the run.
          schema:
            type: array
            items:
              type: string
        - name: queryFromTime
          in: query
          required: true
          description: >
            The minimum timestamp for the data to be exported. The standard used
            is ISO 8601 with timezones.
          example: 2025-07-01T00:00:00+0530
          schema:
            type: string
        - name: queryToTime
          in: query
          required: true
          description: >
            The maximum timestamp for the data to be exported. The standard used
            is ISO 8601 with timezones.
          example: 2025-07-01T00:00:00+0530
          schema:
            type: string
        - name: format
          in: query
          required: false
          description: >
            The required format for the exported data. Only the csv format is
            supported.
          schema:
            type: string
            default: csv
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportAuditTrailResponse'
              example:
                success: true
                data:
                  requestId: cd3367fb-019d-4600-863f-07c51b7c9e10
                previousPage: null
                nextPage: null
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized - Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal Server Error - Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/auditTrail/presignedUrl:
    get:
      tags:
        - Meters
      summary: Retrieve the presigned URL for an export job
      description: >-
        Returns a pre-signed URL that you can use to download a specific export
        file (usually from object storage such as S3). The `fileKey` corresponds
        to one entry from the `fileList` array in the List API. Use the returned
        URL in the data field directly in a browser or via a HTTP client to
        download the export file.
      operationId: getPresignedURLForMeterExport
      parameters:
        - name: fileKey
          in: query
          required: true
          description: The file key of the export file to download.
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPresignedURLResponse'
              example:
                success: true
                data: >-
                  https://s3.us-west-2.amazonaws.com/example-bucket/tenant-exports/12345/audit-trail/export-2025-01-01/errors_SAMPLE.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAEXAMPLE123456789%2F20250101%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20250101T000000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=0000000000000000000000000000000000000000000000000000000000000000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/export/{meterId}:
    get:
      tags:
        - Meters
      summary: Export details of a specific meter
      description: >
        The Export Meter operation exports the full definition of a specific
        meter in Zuora Mediation, including metadata, all versions, event
        schemas, and operator configurations (source, processor, sink). It's
        useful for reviewing, backing up, or replicating meter setups across
        environments.
      operationId: exportSpecificMeter
      parameters:
        - name: meterId
          in: path
          required: true
          description: ID of the meter to export.
          schema:
            type: string
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: Successful response with meter export data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportMeterResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '404':
          description: Meter not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/import:
    post:
      tags:
        - Meters
      summary: Import a meter definition
      description: >
        Import a meter definition into Zuora Mediation using a file exported
        from the Export Meter API.
      operationId: importMeterDefinition
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportMeterRequest'
      parameters:
        - in: header
          name: Content-Type
          required: true
          schema:
            type: string
            example: multipart/form-data
          description: Content type for the request body.
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: Successful import of meter definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportMeterResponse'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/files:
    post:
      tags:
        - Meters
      summary: Upload a file
      description: >
        Uploads and stores a file in Zuora Mediation for use in meter
        processing. Supported formats include CSV, Excel, and JSON. You can
        specify metadata like headers,
         delimiters, sheets, and data ranges.
      operationId: uploadMeteringFile
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - file
              properties:
                file:
                  type: string
                  format: binary
                  description: The file to store
                hasHeader:
                  type: boolean
                  description: Indicates if the file has a header (for CSV/Excel)
                firstRow:
                  type: integer
                  description: Indicates where the first row starts (for CSV format)
                delimiter:
                  type: string
                  description: Delimiter to separate values (for CSV format)
                sheet:
                  type: string
                  description: The sheet where data lives (for Excel)
                dataRange:
                  type: string
                  description: The data range in the sheet (for Excel)
                resolveFileNameConflict:
                  type: boolean
                  description: Whether to generate a UUID file name
                targetFolder:
                  type: string
                  description: The target folder to store the file
                overwriteExistingFile:
                  type: boolean
                  description: Whether to overwrite an existing file
      responses:
        '200':
          description: File successfully uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFileResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /usage/bulk/{meterGlobalId}:
    post:
      summary: Ingest usage events for a meter
      tags:
        - Meters
      description: >
        Ingests usage events directly into Zuora Mediation in real time. You can
        send a single event or batch multiple events in a JSON array to optimize
        throughput. Each event must conform to the meter's event schema. This
        operation is supported only for meters that use the Streaming API as
        their source in Zuora Mediation. You can use this API to bulk-ingest
        events into a meter only when the meter's source is configured as a
        Streaming API operator. For meters that use other sources, use the
        appropriate ingestion mechanism for that source instead.
      operationId: ingestUsageEvents
      parameters:
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - name: meterGlobalId
          in: path
          required: true
          description: The global ID of the meter.
          schema:
            type: string
      requestBody:
        description: >-
          A JSON object or an array of objects representing usage events. Each
          event must conform to the event schema defined in your meter.
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/StreamingEvent'
                - type: array
                  items:
                    $ref: '#/components/schemas/StreamingEvent'
      responses:
        '200':
          description: Usage event(s) ingested successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionSuccessResponse'
        '400':
          description: Bad request due to validation or business logic errors.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '413':
          description: Payload too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StreamingIngestionAuthError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/events/bulkDelete:
    post:
      tags:
        - Meters
      summary: Bulk delete events from an event store
      description: >
        Allows you to delete multiple events from an event store in Zuora
        Mediation using a file that lists the event IDs to be removed. It is
        useful for cleaning up or correcting data in bulk.
      operationId: bulkDeleteEventsFromEventStore
      parameters:
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request. Use multipart/form-data.
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkDeleteEventRequest'
      responses:
        '200':
          description: Successful response with query ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkDeleteEventResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/events/stores/{id}/jobs/latest:
    get:
      tags:
        - Meters
      summary: Retrieve the latest query job of a specific event store
      description: >-
        Retrieves the most recent query job executed on a specific event store
        in Zuora Mediation. It returns metadata such as query type (e.g.,
        DELETE), status, record counts, and timestamps.
      operationId: getLatestQueryJobOfSpecificEventStore
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the event store.
          schema:
            type: integer
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: Successful response with latest event store query job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LatestEventStoreJobResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '404':
          description: Event store not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/event-store-queries:
    post:
      tags:
        - Meters
      summary: Submit an event store query
      description: >-
        Submits a SQL-style asynchronous query to the Event Store to retrieve
        and inspect metering events for validation, troubleshooting, and
        reconciliation. The API returns a `queryId` that can be used to poll and
        fetch paginated results.
      operationId: submitEventStoreQuery
      parameters:
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitEventStoreQueryRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitEventStoreQueryResponse'
              example:
                success: true
                data:
                  queryId: >-
                    b9a5b91ab34c42b1b9399c0e76245e3f7f76610637ec4d17abdcd4214493814e
                previousPage: 'null'
                nextPage: 'null'
        '400':
          description: Bad Request - Invalid or missing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '401':
          description: Unauthorized - Authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediationErrorResponse'
        '500':
          description: Internal Server Error - Unexpected error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /meters/event-store-queries/{queryId}:
    get:
      tags:
        - Meters
      summary: Retrieve the results for an event store query
      description: >-
        Retrieves paginated result rows and column metadata for a previously
        submitted Event Store query using its `queryId`, including total row
        count, row-level field values, and readiness status. Query execution is
        asynchronous.
      operationId: getQueryResultsForEventStore
      parameters:
        - name: queryId
          in: path
          required: true
          description: ID of the query.
          schema:
            type: string
        - name: pageSize
          in: query
          required: false
          description: |
            Page size for pagination.
          schema:
            type: integer
            format: int32
            default: 20
            maximum: 50
        - name: page
          in: query
          required: false
          description: |
            The page number.
          schema:
            type: integer
            format: int32
            default: 1
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request body. Use application/json.
          schema:
            type: string
            default: application/json
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQueryResultsResponse'
              examples:
                Successful query results:
                  value:
                    success: true
                    data:
                      totalCount: 1
                      columns:
                        - name: value 1
                          logicalType:
                            type: VARCHAR
                            nullable: true
                            length: 2147483647
                          comment: null
                        - name: value 2
                          logicalType:
                            type: VARCHAR
                            nullable: true
                            length: 2147483647
                          comment: null
                      rows:
                        - kind: INSERT
                          fields:
                            - 10
                            - 20%
                      ready: true
                Failed query execution:
                  value:
                    success: true
                    data:
                      isFailed: true
                      message: <error message description>
                      ready: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/commitments:
    get:
      tags:
        - Commitments
      summary: List commitments for an account
      description: >-
        Retrieves a paginated list of commitments for a commitment owner
        account.
      operationId: getCommitments
      parameters:
        - name: accountNumber
          in: query
          required: true
          description: Account number to fetch commitments for.
          schema:
            type: string
        - name: type
          in: query
          required: false
          description: Filter commitments by type.
          schema:
            type: string
            format: CommitmentTypeEnum
            enum:
              - MinCommitment
              - MaxCommitment
            example: MinCommitment
        - name: page
          in: query
          required: false
          description: Page number for pagination.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: Page size for pagination.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCommitmentsResponse'
              example:
                total: 1
                page: 1
                page_size: 20
                commitments:
                  - id: 8ad08ca797ef6ca50197f3cce6267991
                    status: Active
                    version: 1
                    currency: USD
                    startDate: '2020-01-01'
                    endDate: '2020-12-31'
                    totalAmount: 100
                    orderNumber: O-0001
                    orderId: 00989e98483e00030a2733ee989e9815
                    accountId: 8a8aa0ac7f3b4c1d017f3b4c1d0a0001
                    accountNumber: ACC-0001
                    commitmentNumber: TW-0001
                    name: Example Commitment
                    type: MinCommitment
                    description: This a example commitment.
                    priority: 1
                    eligibleAccountConditions:
                      field: Account.AccountNumber
                      operator: eq
                      value: ACC-0001
                      conditions:
                        - {}
                      relation: and
                    eligibleChargeConditions:
                      field: RatePlanCharge.ChargeNumber
                      operator: in
                      value: C-0001,C-0002
                      conditions:
                        - {}
                      relation: and
                    periodAlignmentOption: SpecificDate
                    specificPeriodAlignmentDate: '2020-01-15'
                    customFields: {}
                    excludeItemBookingFromRevenueAccounting: true
                    adjustmentLiabilityAccountingCode: Accounts Receivable
                    adjustmentRevenueAccountingCode: Accounts Receivable
                    contractAssetAccountingCode: Accounts Receivable
                    contractLiabilityAccountingCode: Accounts Receivable
                    contractRecognizedRevenueAccountingCode: Accounts Receivable
                    deferredRevenueAccountingCode: Accounts Receivable
                    excludeItemBillingFromRevenueAccounting: false
                    isAllocationEligible: true
                    isUnbilled: false
                    recognizedRevenueAccountingCode: Accounts Receivable
                    revenueRecognitionRule: Recognize upon invoicing
                    unbilledReceivablesAccountingCode: Accounts Receivable
                    revenueRecognitionTiming: Upon Order Activation Date
                    revenueAmortizationMethod: string
                    accountReceivableAccountingCode: Accounts Receivable
                    taxable: true
                    taxCode: SalesTax_US
                    taxMode: TaxInclusive
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /v1/commitments/{commitmentKey}:
    get:
      tags:
        - Commitments
      summary: Retrieve a commitment
      description: Retrieves the details of a specific commitment using its ID or number.
      operationId: getCommitmentByKey
      parameters:
        - name: commitmentKey
          in: path
          required: true
          description: The unique identifier (ID or number) of the commitment.
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCommitmentResponse'
              example:
                id: 8ad08ca797ef6ca50197f3cce6267991
                status: Active
                version: 1
                currency: USD
                startDate: '2020-01-01'
                endDate: '2020-12-31'
                amount: 100
                orderNumber: O-0001
                orderId: 00989e98483e00030a2733ee989e9815
                accountId: 8a8aa0ac7f3b4c1d017f3b4c1d0a0001
                accountNumber: ACC-0001
                commitmentNumber: TW-0001
                name: Example Commitment
                type: MinCommitment
                description: This a example commitment.
                priority: 1
                eligibleAccountConditions:
                  field: Account.AccountNumber
                  operator: eq
                  value: ACC-0001
                  conditions:
                    - {}
                  relation: and
                eligibleChargeConditions:
                  field: RatePlanCharge.ChargeNumber
                  operator: in
                  value: C-0001,C-0002
                  conditions:
                    - {}
                  relation: and
                periodAlignmentOption: SpecificDate
                specificPeriodAlignmentDate: '2020-01-15'
                customFields: {}
                excludeItemBookingFromRevenueAccounting: true
                adjustmentLiabilityAccountingCode: Accounts Receivable
                adjustmentRevenueAccountingCode: Accounts Receivable
                contractAssetAccountingCode: Accounts Receivable
                contractLiabilityAccountingCode: Accounts Receivable
                contractRecognizedRevenueAccountingCode: Accounts Receivable
                deferredRevenueAccountingCode: Accounts Receivable
                excludeItemBillingFromRevenueAccounting: false
                isAllocationEligible: true
                isUnbilled: false
                recognizedRevenueAccountingCode: Accounts Receivable
                revenueRecognitionRule: Recognize upon invoicing
                unbilledReceivablesAccountingCode: Accounts Receivable
                revenueRecognitionTiming: Upon Order Activation Date
                revenueAmortizationMethod: string
                accountReceivableAccountingCode: Accounts Receivable
                taxable: true
                taxCode: SalesTax_US
                taxMode: TaxInclusive
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /v1/commitments/periods:
    get:
      tags:
        - Commitments
      summary: List periods for a commitment
      description: >
        Lists periods of the specified commitment. You can paginate the results
        using `page` and `pageSize` query parameters.
      operationId: getCommitmentPeriods
      parameters:
        - name: commitmentKey
          in: query
          required: false
          description: >-
            The unique identifier or number of the commitment. Required if
            `startDate`, `endDate`, and `accountNumber` are not all provided.
            Either specify `commitmentKey`, or provide `startDate`, `endDate`,
            and `accountNumber` together.
          schema:
            type: string
        - name: startDate
          in: query
          required: false
          description: >-
            Start date of the billing period in `YYYY-MM-DD` format. Date
            filters must be up to 5 years apart. Required if `commitmentKey` is
            not provided. Must be used together with `endDate` and
            `accountNumber`.
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          required: false
          description: >-
            End date of the billing period in `YYYY-MM-DD` format. Date filters
            must be up to 5 years apart. Required if `commitmentKey` is not
            provided. Must be used together with `startDate` and
            `accountNumber`.
          schema:
            type: string
            format: date
        - name: accountNumber
          in: query
          required: false
          description: >
            Account number to which the commitment belongs to. Required if
            `commitmentKey` is not provided. Must be used together with
            `startDate` and `endDate`.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: |
            Page number for pagination.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: |
            Page size for pagination.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCommitmentPeriodsResponse'
              example:
                periods:
                  - id: 0df89cf12e650006ac13624398764f1b
                    commitmentId: 8ad08ca797ef6ca50197f3cce6267991
                    commitmentNumber: TW-0001
                    currency: USD
                    priority: 1
                    version: 1
                    type: MinCommitment
                    startDate: '2024-01-01'
                    endDate: '2024-12-31'
                    isProrated: false
                    amount: 100
                    status: Active
                total: 1
                page: 1
                pageSize: 1
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /v1/commitments/{commitmentId}/balance:
    get:
      tags:
        - Commitments
      summary: Retrieve the balance for a commitment
      description: >
        Retrieves the balance amount for a specific commitment for current and
        past periods. Future periods are not covered.


        **Note**: This API will not work for tenants that are configured to skip
        commitment evaluation in Zuora Billing, and calls to this API are
        rejected. 
      operationId: getCommitmentBalance
      parameters:
        - name: commitmentId
          in: path
          required: true
          description: The unique identifier of the commitment.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: |
            Page number for pagination.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: |
            Page size for pagination.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCommitmentBalanceResponse'
              example:
                total: 1
                page: 1
                pageSize: 1
                periods:
                  - id: 6cf8cc0ddddc0061ac13d7a998bc18bb
                    status: Active
                    startDate: '2024-01-01'
                    endDate: '2024-12-31'
                    balance: 500
                    committedAmount: 1000
                    totalSpend: 500
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /v1/commitments/{commitmentKey}/schedules:
    get:
      tags:
        - Commitments
      summary: List schedules for a commitment
      description: |
        Retrieves all the schedules for a specific commitment.
      operationId: listCommitmentSchedules
      parameters:
        - name: commitmentKey
          in: path
          required: true
          description: The unique identifier (ID or number) of the commitment.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: |
            Page number for pagination.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          required: false
          description: |
            Page size for pagination.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCommitmentScheduleResponse'
              example:
                schedules:
                  - id: 0df89cf12e650006ac13624398764f1b
                    commitmentId: 8ad08ca797ef6ca50197f3cce6267991
                    commitmentNumber: TW-0001
                    version: 1
                    startDate: '2020-01-01'
                    endDate: '2020-12-31'
                    totalAmount: 300
                    amount: 200
                    amountBase: CommitmentPeriod
                    periodType: SpecificMonths
                    specificPeriodLength: 4
                    status: Active
                total: 1
                page: 1
                pageSize: 20
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /v1/adjustments:
    get:
      description: >
        Describes how to retrieve detailed information about delivery
        adjustments of a subscription.


        **Note**: The Delivery Adjustments 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 [Enable
        billing features by
        yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
        in the Knowledge Center.
      operationId: GET_Subscription_Adjustments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            A subscription number.
          in: query
          name: subscription-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    adjustments:
                      - adjustmentId: 4028818886a2149b0186a237d0ff003b
                        adjustmentNumber: ADJ-00000001
                        amount: -5
                        billingDate: '2023-02-26'
                        chargeNumber: C-00000001
                        creditMemoNumber: CM00000001
                        deferredRevenueAccountingCode: string
                        deliveryDate: '2023-02-26'
                        deliveryDay: sunday
                        reason: string
                        recognizedRevenueAccountingCode: string
                        revenueRecognitionRuleName: string
                        status: Billed
                        subscriptionNumber: A-S00000001
                      - adjustmentId: 4028818886a2149b0186a2404f67003c
                        adjustmentNumber: ADJ-00000002
                        amount: -5
                        billingDate: '2023-02-27'
                        chargeNumber: C-00000001
                        creditMemoNumber: CM00000002
                        debitMemoNumber: DM00000002
                        deferredRevenueAccountingCode: string
                        deliveryDate: '2023-02-27'
                        deliveryDay: monday
                        reason: string
                        recognizedRevenueAccountingCode: string
                        revenueRecognitionRuleName: string
                        status: Cancelled
                        subscriptionNumber: A-S00000001
                    success: true
              schema:
                $ref: >-
                  #/components/schemas/GETAdjustmentsBySubscriptionNumberResponseType
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specify a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all delivery adjustments of a subscription
      tags:
        - Delivery Adjustments
    post:
      description: >
        Describes how to create one or more delivery adjustments for a
        subscription. 


        **Notes**: 

        - The Delivery Adjustments 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 [Enable billing features by
        yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
        in the Knowledge Center.

        - This operation supports a partial success scenario: when at least one
        eligible delivery adjustment exists for a given time period, “success =
        true” as well as eligible delivery adjustments and ineligible delivery
        adjustments are returned in the response; only when no delivery
        adjustment is eligible, “success=false” is returned.
      operationId: Create_Adjustment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTCreateBillingAdjustmentRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    adjustments:
                      - adjustmentId: 4028818886a2149b0186a237d0ff003b
                        adjustmentNumber: ADJ-00000001
                        amount: -5
                        billingDate: '2023-02-26'
                        chargeNumber: C-00000001
                        creditMemoNumber: CM00000001
                        deferredRevenueAccountingCode: string
                        deliveryDate: '2023-02-26'
                        deliveryDay: sunday
                        eligible: true
                        reason: string
                        recognizedRevenueAccountingCode: string
                        revenueRecognitionRuleName: string
                        status: Billed
                        subscriptionNumber: A-S00000001
                    ineligibleAdjustments:
                      - adjustmentId: null
                        adjustmentNumber: null
                        amount: null
                        billingDate: null
                        chargeNumber: C-00000001
                        deferredRevenueAccountingCode: string
                        deliveryDate: '2023-02-27'
                        deliveryDay: monday
                        eligible: false
                        errorMessage: >-
                          Subscription does not have a delivery scheduled for
                          this day
                        reason: string
                        recognizedRevenueAccountingCode: string
                        revenueRecognitionRuleName: string
                        status: null
                        subscriptionNumber: A-S00000001
                    success: true
                    totalAmount: -5
                    totalNumberOfDeliveries: 1
              schema:
                $ref: '#/components/schemas/GETAdjustmentsResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specify a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a delivery adjustment
      tags:
        - Delivery Adjustments
  /v1/adjustments/preview:
    post:
      description: >
        Describes how to preview delivery adjustments of a subscription.


        **Notes**: 

        - The Delivery Adjustments 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 [Enable billing features by
        yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
        in the Knowledge Center.

        - This operation supports a partial success scenario: when at least one
        eligible delivery adjustment exists for a given time period, “success =
        true” as well as eligible delivery adjustments and ineligible delivery
        adjustments are returned in the response; only when no delivery
        adjustment is eligible, “success=false” is returned.
      operationId: Preview_Adjustment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPreviewBillingAdjustmentRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    adjustments:
                      - adjustmentId: 'null'
                        adjustmentNumber: 'null'
                        amount: -5
                        billingDate: '2023-02-26'
                        chargeNumber: C-00000001
                        creditMemoNumber: null
                        deferredRevenueAccountingCode: string
                        deliveryDate: '2023-02-26'
                        deliveryDay: sunday
                        eligible: true
                        reason: string
                        recognizedRevenueAccountingCode: string
                        revenueRecognitionRuleName: string
                        status: null
                        subscriptionNumber: A-S00000001
                    ineligibleAdjustments:
                      - adjustmentId: null
                        adjustmentNumber: null
                        amount: null
                        billingDate: null
                        chargeNumber: C-00000001
                        deferredRevenueAccountingCode: string
                        deliveryDate: '2023-02-27'
                        deliveryDay: monday
                        eligible: false
                        errorMessage: >-
                          Subscription does not have a delivery scheduled for
                          this day
                        reason: string
                        recognizedRevenueAccountingCode: string
                        revenueRecognitionRuleName: string
                        status: null
                        subscriptionNumber: A-S00000001
                    success: true
                    totalAmount: -5
                    totalNumberOfDeliveries: 1
              schema:
                $ref: '#/components/schemas/GETAdjustmentsResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specify a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Preview a delivery adjustment
      tags:
        - Delivery Adjustments
  /v1/adjustments/{adjustment-key}:
    get:
      description: >
        Describes how to retrieve detailed information about a delivery
        adjustment.


        **Note**: The Delivery Adjustments 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 [Enable
        billing features by
        yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
        in the Knowledge Center.
      operationId: GET_Adjustment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The delivery adjustment ID or number to retrieve.
          in: path
          name: adjustment-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    adjustmentId: 4028818886a2149b0186a2404f67003c
                    adjustmentNumber: ADJ-00000001
                    amount: -5
                    billingDate: '2023-02-26'
                    chargeNumber: C-00000001
                    creditMemoNumber: CM00000001
                    deferredRevenueAccountingCode: string
                    deliveryDate: '2023-02-26'
                    deliveryDay: sunday
                    reason: string
                    recognizedRevenueAccountingCode: string
                    revenueRecognitionRuleName: string
                    status: Billed
                    subscriptionNumber: A-S00000001
              schema:
                $ref: '#/components/schemas/GETAdjustmentByIdResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specify a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a delivery adjustment
      tags:
        - Delivery Adjustments
  /v1/adjustments/{adjustmentId}/cancel:
    put:
      description: >
        Describes how to cancel an unbilled delivery adjustment.


        **Note**: The Delivery Adjustments 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 [Enable
        billing features by
        yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
        in the Knowledge Center.
      operationId: PUT_CancelAdjustment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The ID of the delivery adjustment to cancel.
          in: path
          name: adjustmentId
          required: true
          schema:
            format: UUID
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelBillingAdjustmentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    debitMemoNumber: DM00000001
                    success: true
              schema:
                $ref: '#/components/schemas/GETCancelAdjustmentResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specify a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a delivery adjustment
      tags:
        - Delivery Adjustments
  /v1/billing-documents:
    get:
      description: >
        Retrieves the information about all billing documents associated with a
        specified account. The billing documents contain invoices, credit memos,
        and debit memos.


        To retrieve information about credit memos and debit memos, you must
        have the Invoice Settlement feature enabled. 


        You can use query parameters to restrict the data returned in the
        response.


        Examples:

        -
        /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate

        -
        /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted

        - /billing-documents?accountNumber=A00000001&sort=+documentDate

        - /billing-documents?accountNumber=A00000001&status=Posted
      operationId: GET_BillingDocuments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The ID of the customer account that the billing documents are
            associated with.


            **Note**: When retrieving information about all billing documents
            associated with an account, you must specify either `accountId` or
            `accountNumber` in the query parameters.
          in: query
          name: accountId
          required: false
          schema:
            format: uuid
            type: string
        - description: >
            The number of the customer account that the billing documents are
            associated with.


            **Note**: When retrieving information about all billing documents
            associated with an account, you must specify either `accountId` or
            `accountNumber` in the query parameters.
          in: query
          name: accountNumber
          required: false
          schema:
            format: uuid
            type: string
        - description: >
            The date of the billing document. It represents the invoice date for
            invoices, credit memo date for credit memos, and debit memo date for
            debit memos.
          in: query
          name: documentDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            The status of the billing document.
          in: query
          name: status
          required: false
          schema:
            enum:
              - Draft
              - Posted
              - Canceled
              - Error
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            If you do not specify any sortable field, the response data is
            sorted by the `documentDate` field in descending order.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by this
            field.  

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - documentDate
              - documentType

              
            Examples:

            - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1
              &sort=+documentDate,-documentType
            - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1
              &status=Posted&sort=+documentDate&page=2&pageSize=15
          in: query
          name: sort
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    documents:
                      - accountId: 4028905f5e4feb38bbb50af9aa002d1
                        accountNumber: A00000001
                        amount: 100
                        balance: 90
                        documentDate: '2017-10-01'
                        documentNumber: INV-0000001
                        documentType: Invoice
                        id: 4028905f5e4jjj015e50af9aa002d1
                        status: Posted
                        currency: USD
                      - accountId: 4028905f5e4feb38b111b50af9aa002d1
                        accountNumber: A00000001
                        amount: 100
                        balance: 90
                        documentDate: '2017-09-01'
                        documentNumber: CM-0000001
                        documentType: CreditMemo
                        id: 4028905f5e4jbbb015e50af9aa002d1
                        status: Posted
                        currency: USD
                      - accountId: 4028905f5e4feb3833b50af9aa002d1
                        accountNumber: A00000001
                        amount: 100
                        balance: 90
                        documentDate: '2017-07-01'
                        documentNumber: DM-0000001
                        documentType: DebitMemo
                        id: 4028905f5e4jccc015e50af9aa002d1
                        status: Posted
                        currency: USD
                    success: true
              schema:
                $ref: '#/components/schemas/BillingDocumentQueryResponseElementType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List billing documents for an account
      tags:
        - Billing Documents
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X GET -H "Authorization: Bearer
            6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type:
            application/json"
            "https://rest.sandbox.eu.zuora.com/v1/billing-documents?accountId=402892c74c9193cd014c91d35b0a0132"
  /v1/accounts/billing-documents/files/deletion-jobs:
    post:
      description: >
        Creates an asynchronous job to permanently delete all billing document
        PDF files for specific accounts. 


        After the deletion job is completed, all billing document PDF files are
        permanently deleted. To retrieve the status of a deletion job, call
        [Retrieve a job of hard deleting billing document
        files](https://developer.zuora.com/api-references/api/operation/GET_BillingDocumentFilesDeletionJob).


        **Note**: This operation can be used only if you have the Billing user
        permission "Hard Delete Billing Document Files" enabled. 
      operationId: POST_BillingDocumentFilesDeletionJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c92c8f83dc4f752013dc72c24ee016c
                    status: Pending
                    success: true
              schema:
                $ref: >-
                  #/components/schemas/POSTBillingDocumentFilesDeletionJobResponse
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a job to hard delete billing document files
      tags:
        - Billing Documents
  /v1/accounts/billing-documents/files/deletion-jobs/{jobId}:
    get:
      description: >
        Retrieves information about an asynchronous job of permanently deleting
        all billing document PDF files for specific accounts.


        **Note**: This operation can be used only if you have the Billing user
        permission "Hard Delete Billing Document Files" enabled. 
      operationId: GET_BillingDocumentFilesDeletionJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            The unique ID of a billing document file deletion job. For example,
            2c92c8f83dc4f752013dc72c24ee016c.
          in: path
          name: jobId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c92c8f83dc4f752013dc72c24ee016c
                    status: Pending
                    success: true
              schema:
                $ref: >-
                  #/components/schemas/GETBillingDocumentFilesDeletionJobResponse
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a job of hard deleting billing document files
      tags:
        - Billing Documents
  /v1/accounts/{key}/billing-documents/generate:
    post:
      description: >
        Generates draft or posted billing documents for a specified account. You
        can also generate billing documents for specified subscriptions of a
        specified account. The billing documents contain invoices and credit
        memos. To generate credit memos, you must have the Invoice Settlement
        feature enabled.


        **Note**: You cannot generate billing documents for cancelled or
        suspended subscriptions.
      operationId: POST_GenerateBillingDocuments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the customer account that billing documents are
            generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or
            AC0000001.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostGenerateBillingDocumentType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    invoices:
                      - id: 8ad084db909fae930190a121c84957ff
                    creditMemos: []
                    success: true
              schema:
                $ref: '#/components/schemas/GenerateBillingDocumentResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate billing documents by account ID
      tags:
        - Billing Documents
  /v1/invoices:
    post:
      description: >
        Creates a standalone invoice for selling physical goods, services or
        other items on a non-recurring basis to your subscription customers.


        To use this operation, you must have the **Modify Invoice** and at least
        one of the **Create Standalone Invoice With Product Catalog** or
        **Create Standalone Invoice Without Product Catalog** user permissions.

        See <a
        href="https://knowledgecenter.zuora.com/Zuora_Platform/System_Management/Administrator_Settings/User_Roles/d_Billing_Roles"
        target="_blank">Billing Roles</a> for more information.
      operationId: POST_StandaloneInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostInvoiceType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad084db909fae930190a121c84957ff
                    invoiceNumber: INV00000155
                    accountId: 8ad09be48db5aba7018db604776d4854
                    amount: 100
                    amountWithoutTax: 100
                    discount: 0
                    invoiceDate: '2024-07-30'
                    dueDate: '2024-08-29'
                    autoPay: false
                    comments: null
                    status: Draft
                    taxAmount: 0
                    taxExemptAmount: 0
                    transferredToAccounting: null
                    sourceType: Standalone
                    billToContactId: null
                    soldToContactId: null
                    templateId: null
                    paymentTerm: null
                    sequenceSetId: null
                    adjustmentAmount: 0
                    balance: 100
                    billToContactSnapshotId: null
                    creditMemoAmount: 0
                    includesOneTime: true
                    includesRecurring: true
                    includesUsage: true
                    lastEmailSentDate: null
                    paymentAmount: 0
                    postedBy: null
                    postedDate: null
                    refundAmount: 0
                    soldToContactSnapshotId: null
                    source: API
                    sourceId: null
                    targetDate: null
                    taxMessage: null
                    taxStatus: Complete
                    createdById: b243314d594646d3b2651aeedd4be47e
                    createdDate: '2024-07-11 02:31:04'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-11 02:31:04'
                    billRunId: null
                    currency: USD
                    invoiceGroupNumber: null
                    success: true
              schema:
                $ref: '#/components/schemas/PostInvoiceResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a standalone invoice
      tags:
        - Invoices
    put:
      description: >
        Updates multiple invoices in batches with one call. The following
        tutorials demonstrate how to use this operation:
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/D_Add_and_delete_invoice_items_of_draft_standalone_invoices"
          target="_blank">Add and delete invoice items of draft standalone invoices</a>
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/Edit_due_dates_of_draft_standalone_invoices"
          target="_blank">Edit due dates of draft standalone invoices</a>
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/Edit_invoice_item_prices_and_custom_fields_of_draft_standalone_invoices"
          target="_blank">Edit invoice item prices and custom fields of draft standalone invoices</a>
          

        ### Limitations


          - You can update a maximum of 50 invoices by one call.
      operationId: PUT_BatchUpdateInvoices
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutBatchInvoiceType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update invoices
      tags:
        - Invoices
  /v1/invoices/batch:
    post:
      description: >
        Creates multiple standalone invoices for selling physical goods,
        services or other items on a non-recurring basis to your subscription
        customers.



        To use this operation, you must have the **Modify Invoice** and at least
        one of the **Create Standalone Invoice With Product Catalog** or
        **Create Standalone Invoice Without Product Catalog** user permissions.

        See <a
        href="https://knowledgecenter.zuora.com/Zuora_Platform/System_Management/Administrator_Settings/User_Roles/d_Billing_Roles"
        target="_blank">Billing Roles</a> for more information.


        ### Limitations


        This operation has the following limitations:


        * You can create a maximum of 50 invoices in one request.


        * You can create a maximum of 1,000 invoice items in one request.
      operationId: POST_StandaloneInvoices
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBatchInvoicesType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    invoices:
                      - IntegrationId__NS: string
                        IntegrationStatus__NS: string
                        SyncDate__NS: string
                        accountId: 4028818484f483d20184f4f7efc40001
                        adjustmentAmount: 0
                        amount: 700
                        amountWithoutTax: 700
                        autoPay: true
                        balance: 700
                        billRunId: 4028818484f483d20184f50064950035
                        billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                        comments: ''
                        complexity__c: Middle
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2022-12-08 19:49:16'
                        currency: USD
                        description__c: description
                        discount: 0
                        dueDate: '2022-11-30'
                        id: 4028818484f483d20184f5006b97003f
                        includesOneTime: true
                        includesRecurring: true
                        includesUsage: true
                        invoiceDate: '2022-10-31'
                        invoiceGroupNumber: N-0001
                        invoiceNumber: INV00000001
                        lastEmailSentDate: '2022-12-08 19:51:16'
                        paymentAmount: 0
                        postedBy: 402881e522cf4f9b0122cf5d82860002
                        postedDate: '2022-12-09'
                        refundAmount: 0
                        sequenceSetId: 402881e522cf4f9b0122cf5d82860003
                        soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860005
                        source: BillRun
                        sourceId: BR-00000001
                        sourceType: Subscription
                        status: Posted
                        success: true
                        targetDate: '2022-10-31'
                        transferredToAccounting: string
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2022-12-08 19:51:23'
                      - objectIndex: 1
                        processId: CA037C0B8C5B0682
                        reasons:
                          - code: 58490020
                            message: >-
                              No account is found with accountId
                              ff8080817cda56fa017cda87aaa2071f.
                        success: false
                    success: true
              schema:
                $ref: '#/components/schemas/PostBatchInvoiceResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create standalone invoices
      tags:
        - Invoices
  /v1/invoices/bulk-post:
    post:
      description: >
        Posts multiple invoices.


        You can post a maximum of 50 invoices in one single request.
        Additionally, you can also update invoice dates while posting the
        invoices.

        **Note** : This operation is synchronous and invoices within the bulk
        request are posted one by one.  The maximum batch size depends on the
        posting performance, which varies with invoice complexity and
        integrations with external tax engines.
      operationId: POST_PostInvoices
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTInvoicesBatchPostType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    invoices:
                      - id: 402890555a7e9791015a7f15fe440123
                        success: true
                      - id: 402890555a7e9791015a7f15fe44013a
                        success: true
                      - id: ff808081804f25b001804f2d8971079f
                        processId: F3D4DAF98E6CE569
                        reasons:
                          - code: 59210020
                            message: Only invoices with Draft status can be posted.
                        success: false
                    success: true
              schema:
                $ref: '#/components/schemas/InvoicesBatchPostResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Post invoices
      tags:
        - Invoices
  /v1/invoices/pdf-status:
    get:
      description: 'Retrieves the PDF generation statuses of a batch of invoices. '
      operationId: GetInvoicePdfStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >-
            The IDs or numbers of the invoices separated by commas. For example
            -
            `?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001`.
            A maximum of 50 keys can be entered in this field.
          in: query
          name: invoiceKeys
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                invoiceFiles:
                  - invoiceId: 402824aa8cc894d5018cc8a120576881
                    invoiceNumber: INV00000003
                    pdfGenerationStatus: Generated
                    createdOn: '2024-01-01 11:35:56'
                    updatedOn: '2024-01-01 11:35:56'
                    pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
                  - invoiceId: 2c98908a904dfc2601904e6e14090241
                    invoiceNumber: INV00000004
                    pdfGenerationStatus: Error
                    createdOn: '2024-01-02 10:14:13'
                    updatedOn: '2024-01-02 10:14:13'
                    errorCode: INVALID_TEMPLATE
                    errorMessage: Unknown merge filed chargeNumber__c
                  - invoiceId: 513935bb9dd905e6129dd9b231687992
                    invoiceNumber: INV00000005
                    pdfGenerationStatus: Pending
                    createdOn: '2024-01-01 11:35:56'
                    updatedOn: '2024-01-01 11:35:56'
                success: true
              schema:
                $ref: '#/components/schemas/GetInvoicePdfStatusBatchResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '50000020'
                    message: Credit memo key is required
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              example:
                message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            WWW-Authenticate:
              description: >-
                The value of this header is: ``` Basic realm=Zuora API, ZSession
                realm=Zuora API, Bearer realm=Zuora API ``` 
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve the PDF file generation status of invoices
      tags:
        - Invoices
      x-accepts: application/json
  /v1/invoices/{invoiceKey}:
    delete:
      description: >
        Deletes a specific invoice.


        Whether to delete an invoice synchronously or asynchronously depends on
        the number of invoice items contained in the invoice. By default, if an
        invoice contains less than 100 items, the invoice is deleted
        synchronously. Otherwise, the invoice is deleted asynchronously. If you
        want to change the threshold, submit a request at <a
        href="http://support.zuora.com/" target="_blank">Zuora Global
        Support</a>.
      operationId: DELETE_DeleteInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice to be deleted. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 40288ae9600808280160081dc9c13f15
                    jobId: 40288ae9600808280160081db1533506
                    jobStatus: Completed
                    success: true
              schema:
                $ref: '#/components/schemas/DeleteInvoiceResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an invoice
      tags:
        - Invoices
    get:
      description: |
        Retrieves a specific invoice.
      operationId: Get_GetInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    IntegrationId__NS: string
                    IntegrationStatus__NS: string
                    SyncDate__NS: string
                    accountId: 4028818484f483d20184f4f7efc40001
                    adjustmentAmount: 0
                    amount: 700
                    amountWithoutTax: 700
                    autoPay: true
                    balance: 700
                    billRunId: 4028818484f483d20184f50064950035
                    billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860010
                    comments: ''
                    complexity__c: Middle
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2022-12-08 19:49:16'
                    currency: USD
                    description__c: description
                    discount: 0
                    dueDate: '2022-11-30'
                    id: 4028818484f483d20184f5006b97003f
                    includesOneTime: true
                    includesRecurring: true
                    includesUsage: true
                    invoiceDate: '2022-10-31'
                    invoiceGroupNumber: N-0001
                    invoiceNumber: INV00000001
                    lastEmailSentDate: '2022-12-08 19:51:16'
                    paymentAmount: 0
                    postedBy: 402881e522cf4f9b0122cf5d82860002
                    postedDate: '2022-12-09'
                    refundAmount: 0
                    sequenceSetId: 402881e522cf4f9b0122cf5d82860009
                    soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860011
                    source: BillRun
                    sourceId: BR-00000001
                    sourceType: Subscription
                    status: Posted
                    success: true
                    targetDate: '2022-10-31'
                    transferredToAccounting: string
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2022-12-08 19:51:23'
              schema:
                $ref: '#/components/schemas/PostInvoiceResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an invoice
      tags:
        - Invoices
    put:
      description: |
        Updates a specific invoice.
        The following tutorials demonstrate how to use this operation:
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/D_Add_and_delete_invoice_items_of_draft_standalone_invoices"
          target="_blank">Add and delete invoice items of draft standalone invoices</a>
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/Edit_due_dates_of_draft_standalone_invoices"
          target="_blank">Edit due dates of draft standalone invoices</a>
          - <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_both_subscription_and_non-subscription_transactions/Unified_Invoicing/Edit_invoice_item_prices_and_custom_fields_of_draft_standalone_invoices"
          target="_blank">Edit invoice item prices and custom fields of draft standalone invoices</a>
          
      operationId: PUT_UpdateInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutInvoiceType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad084db909fae930190a121c84957ff
                    number: INV00000155
                    accountId: 8ad09be48db5aba7018db604776d4854
                    invoiceDate: '2024-07-30'
                    currency: USD
                    targetDate: null
                    dueDate: '2024-08-29'
                    postedOn: null
                    postedById: null
                    status: Draft
                    amount: 105
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    balance: 105
                    discount: 0
                    comment: null
                    autoPay: false
                    transferredToAccounting: false
                    creditBalanceAdjustmentAmount: 0
                    createdDate: '2024-07-11 02:31:04'
                    createdById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-11 02:43:45'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    cancelledOn: null
                    cancelledById: null
                    success: true
              schema:
                $ref: '#/components/schemas/PutInvoiceResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an invoice
      tags:
        - Invoices
  /v1/invoices/{invoiceKey}/application-parts:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)

        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing

        Release 296 (March 2021). This feature includes Unapplied Payments,
        Credit and

        Debit Memo, and Invoice Item Settlement. If you want to enable Invoice
        Settlement,

        see [Invoice Settlement Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)

        for more information.


        If you are in Zuora version 341, this operation will return only
        processed payments applied to the invoices. If you are in the Zuora
        version less than 341, this operation behavior remains the same and
        returns all payments associated with the invoice regardless of the
        payment status.


        Retrieves information about the payments or credit memos that are
        applied to a

        specified invoice.
      operationId: GET_InvoiceApplicationParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    applicationParts:
                      - appliedAmount: 22
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2018-01-02 11:42:16'
                        creditMemoId: 4028905f60a165a50160b4f632ff023d
                        paymentId: null
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2018-01-02 11:42:16'
                      - appliedAmount: 11
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2018-01-02 11:41:38'
                        creditMemoId: null
                        paymentId: 4028905f60a165a50160b4f5d5cb0229
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2018-01-02 11:41:38'
                    success: true
              schema:
                $ref: '#/components/schemas/GetInvoiceApplicationPartCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all application parts of an invoice
      tags:
        - Invoices
  /v1/invoices/{invoiceKey}/emails:
    post:
      description: |
        Sends a posted invoice to the specified email addresses manually.
        ### Notes
          - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.

          - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.

          - The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:
            * The `useEmailTemplateSetting` field is set to `false`.
            * The email addresses are not specified in the `emailAddresses` field.
      operationId: POST_EmailInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostInvoiceEmailRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Email an invoice
      tags:
        - Invoices
  /v1/invoices/{invoiceKey}/files:
    get:
      description: >
        Retrieves the information about all PDF files of a specified invoice. 


        Invoice PDF files are returned in reverse chronological order by the
        value of the `versionNumber` field.

        **Note**: This API only retrieves the PDF files that have been
        generated. If the latest PDF file is being generated, it will not be
        included in the response.

        You can use the
        [Query](https://developer.zuora.com/api-references/api/operation/Action_POSTquery)
        action to get the latest PDF file, for example: `"select Body from
        Invoice where Id = '2c93808457d787030157e0324aea5158'"`.

        See [Query an Invoice
        Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field)
        for more information.
      operationId: GET_InvoiceFiles
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: >
            The unique ID or number of an invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    invoiceFiles:
                      - id: 2c98901f62d7d83d0162d7facec2262f
                        pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
                        versionNumber: 1524041954479
                      - id: 2c98901f62d7d83d0162d7f4a9792629
                        pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f4a95c2627
                        versionNumber: 1524041551946
                      - id: 2c98901f62d7d83d0162d7f491ea2626
                        pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f490f22624
                        versionNumber: 1524041544112
                    success: true
              schema:
                $ref: '#/components/schemas/GETInvoiceFilesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all files of an invoice
      tags:
        - Invoices
    post:
      description: >
        Uploads an externally generated invoice PDF file for an invoice that is
        in Draft or Posted status.

        To use this operation, you must enable the Modify Invoice permission.
        See [Billing
        Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.

        This operation has the following restrictions:

        - Only the PDF file format is supported.

        - The maximum size of the PDF file to upload is 4 MB.

        - A maximum of 50 PDF files can be uploaded for one invoice.

        - Ensure that each uploaded PDF file has a unique name. Duplicate
        filenames are not allowed when attaching files to an invoice.
      operationId: POST_UploadFileForInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The ID or number of the invoice that you want to upload a PDF file
            for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: |
                    The PDF file to upload for the invoice.
                  format: binary
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fileId: 40289f466463d683016463ef8b7301a2
                    success: true
              schema:
                $ref: '#/components/schemas/POSTUploadFileResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Upload a file for an invoice
      tags:
        - Invoices
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1" -F "file=@InvoiceFile.pdf"
            "https://rest.zuora.com/v1/invoices/2c92c8955bd63cc1015bd7c151af02ab/files"
  /v1/invoices/{invoiceKey}/items:
    get:
      description: |
        Retrieves the information about all items of a specified invoice. 
      operationId: GET_InvoiceItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: >
            The unique ID or number of an invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    invoiceItems:
                      - appliedToItemId: null
                        balance: 21.1
                        chargeAmount: 21.1
                        chargeDate: '2015-11-20 19:53:00'
                        chargeDescription: ''
                        chargeId: 2c92c0f9511f56b2015126814af832d2
                        chargeName: Annual Fee
                        chargeType: Recurring
                        description: ''
                        commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63
                        commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c
                        excludeItemBillingFromRevenueAccounting: true
                        id: 2c92c095511f5b4401512682dd017989
                        invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                        invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                        numberOfDeliveries: 1
                        processingType: Charge
                        productName: TeamCollab Enterprise
                        quantity: 1
                        serviceEndDate: '2015-11-30'
                        serviceStartDate: '2015-11-20'
                        soldToContactId: 2c92c0f9511f56b2015126814ad532cd
                        soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd
                        sourceItemType: SubscriptionComponent
                        subscriptionId: 2c92c0f9511f56b2015126814ad532cc
                        subscriptionName: A-S00000004
                        taxAmount: 0
                        taxationItems:
                          data:
                            - balance: 2.11
                              creditAmount: 0
                              exemptAmount: 0
                              id: 2c98901a68ff26800168ffce6eeb0ffe
                              jurisdiction: County
                              locationCode: 000-1
                              name: taxName
                              paymentAmount: 0
                              taxAmount: 2.11
                              taxCode: TAXCODE-1
                              taxCodeDescription: null
                              taxDate: '2015-11-20'
                              taxRate: 0.1
                              taxRateDescription: ''
                              taxRateType: Percentage
                        unitOfMeasure: ''
                        unitPrice: 21.1
                      - appliedToItemId: 2c92c095511f5b4401512682dd017989
                        chargeAmount: -2.1
                        chargeDate: '2015-11-20 19:53:00'
                        chargeDescription: ''
                        chargeId: 1b3dede652fa47db833a83be55d850a5
                        chargeName: Discount
                        chargeType: OneTime
                        description: ''
                        commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63
                        commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c
                        excludeItemBillingFromRevenueAccounting: true
                        id: 3e28d61d442f433797e268e2b7c11eeb
                        invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                        invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                        numberOfDeliveries: 1
                        processingType: Discount
                        productName: TeamCollab Enterprise
                        quantity: 0
                        serviceEndDate: '2015-11-30'
                        serviceStartDate: '2015-11-20'
                        soldToContactId: 2c92c0f9511f56b2015126814ad532cd
                        soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd
                        sourceItemType: SubscriptionComponent
                        subscriptionId: c2d9a5768db440cbbf2709a55c614bed
                        subscriptionName: A-S00000004
                        taxAmount: 0
                        taxationItems:
                          data:
                            - balance: 0.21
                              creditAmount: 0
                              exemptAmount: 0
                              id: 2c98901a68ff26800168ffce6eeb0ffe
                              jurisdiction: County
                              locationCode: 000-1
                              name: taxName
                              paymentAmount: 0
                              taxAmount: 0.21
                              taxCode: TAXCODE-1
                              taxCodeDescription: null
                              taxDate: '2015-11-20'
                              taxRate: 0.1
                              taxRateDescription: ''
                              taxRateType: Percentage
                        unitOfMeasure: ''
                        unitPrice: 10
                    success: true
              schema:
                $ref: '#/components/schemas/GETInvoiceItemsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all items of an invoice
      tags:
        - Invoices
  /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items:
    get:
      description: >
        Retrieves information about the taxation items of a specific invoice
        item. 
      operationId: GET_TaxationItemsOfInvoiceItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: >
            The unique ID or number of an invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV00000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - description: >
            The unique ID of an invoice item. For example,
            2c86c8955bd63cc1015bd7c151af02ef.
          in: path
          name: itemId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - balance: 10
                        creditAmount: 0
                        exemptAmount: 0
                        id: 2c98901a68ff26800168ffce84e3102c
                        jurisdiction: test
                        locationCode: code - 001
                        name: test
                        paymentAmount: 0
                        taxAmount: 10
                        taxCode: taxcode
                        taxCodeDescription: description
                        taxDate: '2019-02-18'
                        taxRate: 2
                        taxRateDescription: test
                        taxRateType: FlatFee
                      - balance: 10
                        creditAmount: 0
                        exemptAmount: 0
                        id: 2c98901a68ff26800168ffce85d6102e
                        jurisdiction: test
                        locationCode: code - 001
                        name: test
                        paymentAmount: 0
                        taxAmount: 10
                        taxCode: taxcode
                        taxCodeDescription: description
                        taxDate: '2019-02-18'
                        taxRate: 2
                        taxRateDescription: test
                        taxRateType: FlatFee
                    success: true
              schema:
                $ref: '#/components/schemas/GETInvoiceTaxationItemsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.        
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all taxation items of an invoice item
      tags:
        - Invoices
  /v1/invoices/{invoiceKey}/reverse:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Reverses a posted invoice. The reversal operation is performed
        asynchronously when the invoice contains more than 2,000 items in
        total. 


        **Restrictions**


        You are not allowed to reverse an invoice if any of the following
        restrictions is met:

        * Payments and credit memos are applied to the invoice.

        * The invoice is split.

        * The invoice is not in Posted status.

        * The total amount of the invoice is less than 0 (a negative invoice).

        * Using Tax Connector for Extension Platform to calculate taxes.

        * An invoice contains more than 50,000 items in total, including invoice
        items, discount items, and taxation items.


        See [Invoice
        Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices)
        for more information.
      operationId: PUT_ReverseInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutReverseInvoiceType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    creditMemo:
                      id: 402890555a40ca7f015a5b099b0e307a
                    success: true
              schema:
                $ref: '#/components/schemas/PutReverseInvoiceResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Reverse an invoice
      tags:
        - Invoices
  /v1/invoices/{invoiceKey}/taxation-items:
    post:
      description: |
        Creates taxation items for an invoice.
      operationId: POST_INV_TaxationItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an invoice. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTTaxationItemList'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    taxationItems:
                      - createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 10:08:43'
                        exemptAmount: 0
                        financeInformation:
                          accountsReceivableAccountingCode: Check
                          accountsReceivableAccountingCodeType: Cash
                          salesTaxPayableAccountingCode: Check
                          salesTaxPayableAccountingCodeType: Cash
                        id: 402890555a7e9791015a87a072880062
                        invoiceItemId: 402890555a7e9791015a879f064d0055
                        jurisdiction: CALIFORNIA
                        locationCode: '06'
                        name: STATE TAX
                        taxAmount: 0.1
                        taxCode: ServiceTaxCode
                        taxCodeDescription: This is tax code description!
                        taxDate: '2016-09-30'
                        taxMode: TaxExclusive
                        taxRate: 0.0625
                        taxRateDescription: This is tax rate description!
                        taxRateType: Percentage
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 10:08:43'
              schema:
                $ref: '#/components/schemas/GETTaxationItemListType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create taxation items for an invoice
      tags:
        - Invoices
  /v1/invoices/{invoiceKey}/write-off:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Writes off a posted invoice. 


        By writing off an invoice, a credit memo is created and applied to the
        invoice. The generated credit memo items and credit memo taxation items
        are applied to invoice items and invoice taxation items based on the
        configured default application rule. If an invoice is written off, the
        balance of each invoice item and invoice taxation item must be zero.


        If you set the **Create credit memos mirroring invoice items billing
        rule** to **Yes**, you can write off an invoice even if all its items
        have zero balance.


        **Restrictions**: You cannot write off an invoice if any of the
        following restrictions is met:

        * The balance of an invoice has been changed before Invoice Settlement
        is enabled.
          For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice.
        * An invoice contains more than 2,000 items in total, including invoice
        items, discount items, and taxation items.

        See [Invoice
        Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off)
        for more information.        
      operationId: PUT_WriteOffInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTWriteOffInvoiceRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    creditMemo:
                      id: 402890555a40ca7f015a5b099b0e307a
                    success: true
              schema:
                $ref: '#/components/schemas/PUTWriteOffInvoiceResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Write off an invoice
      tags:
        - Invoices
  /v1/credit-memos:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all credit memos. 


        For a use case of this operation, see [Get credit
        memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo).



        ### Filtering


        You can use query parameters to restrict the data returned in the
        response. Each query parameter corresponds to one field in the response
        body.


        If the value of a filterable field is string, you can set the
        corresponding query parameter to `null` when filtering. Then, you can
        get the response data with this field value being `null`. 
          
        Examples:


        - /v1/credit-memos?status=Posted


        - /v1/credit-memos?referredInvoiceId=null&status=Draft


        - /v1/credit-memos?status=Posted&type=External&sort=+number
      operationId: GET_CreditMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: |
            This parameter filters the response based on the `accountId` field.
          in: query
          name: accountId
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `accountNumber`
            field.
          in: query
          name: accountNumber
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `amount` field. 
          in: query
          name: amount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `appliedAmount`
            field. 
          in: query
          name: appliedAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the
            `autoApplyUponPosting` field. 
          in: query
          name: autoApplyUponPosting
          required: false
          schema:
            type: boolean
        - description: >
            This parameter filters the response based on the `createdById`
            field. 
          in: query
          name: createdById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `createdDate`
            field. 
          in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter filters the response based on the `creditMemoDate`
            field. 
          in: query
          name: creditMemoDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `currency` field. 
          in: query
          name: currency
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the
            `excludeFromAutoApplyRules` field. 
          in: query
          name: excludeFromAutoApplyRules
          required: false
          schema:
            type: boolean
        - description: |
            This parameter filters the response based on the `number` field. 
          in: query
          name: number
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `referredInvoiceId`
            field. 
          in: query
          name: referredInvoiceId
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `refundAmount`
            field. 
          in: query
          name: refundAmount
          required: false
          schema:
            format: double
            type: number
        - description: |
            This parameter filters the response based on the `sourceId` field. 
          in: query
          name: sourceId
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `status` field. 
          in: query
          name: status
          required: false
          schema:
            enum:
              - Draft
              - Posted
              - Canceled
              - Error
              - PendingForTax
              - Generating
              - CancelInProgress
            type: string
        - description: >
            This parameter filters the response based on the `targetDate`
            field. 
          in: query
          name: targetDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `taxAmount` field. 
          in: query
          name: taxAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the
            `totalTaxExemptAmount` field.
          in: query
          name: totalTaxExemptAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the
            `transferredToAccounting` field. 
          in: query
          name: transferredToAccounting
          required: false
          schema:
            enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
            type: string
        - description: >
            This parameter filters the response based on the `unappliedAmount`
            field. 
          in: query
          name: unappliedAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `updatedById`
            field. 
          in: query
          name: updatedById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedDate`
            field.
          in: query
          name: updatedDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by this
            field.

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            By default, the response data is displayed in descending order by
            credit memo number.


            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - accountId
              - amount
              - appliedAmount
              - createdById
              - createdDate
              - creditMemoDate
              - number
              - referredInvoiceId
              - refundAmount
              - status
              - targetDate
              - taxAmount
              - totalTaxExemptAmount
              - transferredToAccounting
              - unappliedAmount
              - updatedDate


              
            Examples:


            - /v1/credit-memos?sort=+number


            - /v1/credit-memos?status=Processed&sort=-number,+amount
          in: query
          name: sort
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    creditmemos:
                      - accountId: 2c92c8f95bd63b98015bd7ab09ef0926
                        accountNumber: A00000001
                        amount: 23
                        appliedAmount: 0
                        autoApplyUponPosting: false
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: ''
                        createdById: 2c92c8f95b79c9ad015b80614273052c
                        createdDate: '2017-05-05 01:39:30'
                        creditMemoDate: '2017-05-05'
                        currency: USD
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        excludeFromAutoApplyRules: false
                        id: 2c92c8f95bd63b94015bd7c39289112e
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: 2c92c8955bd63b6c015bd7c395e90023
                        number: CM00000002
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredInvoiceId: null
                        refundAmount: 0
                        reversed: false
                        sequenceSetId: null
                        source: BillRun
                        sourceId: BR-00000024
                        sourceType: Standalone
                        status: Draft
                        targetDate: null
                        taxAmount: 0
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        unappliedAmount: 23
                        updatedById: 2c92c8f95b79c9ad015b80614273052c
                        updatedDate: '2017-05-05 01:39:30'
                      - accountId: 2c92c8f95bd63b98015bd7ab09ef0926
                        accountNumber: A00000001
                        amount: 10
                        appliedAmount: 0
                        autoApplyUponPosting: false
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: ''
                        createdById: 2c92c8f95b79c9ad015b80614273052c
                        createdDate: '2017-05-05 01:15:23'
                        creditMemoDate: '2017-05-01'
                        currency: USD
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        excludeFromAutoApplyRules: false
                        id: 2c92c8f95bd63b9d015bd7ad7fe206f9
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: 2c92c8955bd63b6c015bd7ad8921001d
                        number: CM00000001
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredInvoiceId: 2c92c8955bd63cc1015bd7c151af02ab
                        refundAmount: 0
                        reversed: false
                        sequenceSetId: null
                        source: AdhocFromInvoice
                        sourceId: null
                        sourceType: Standalone
                        status: Draft
                        targetDate: null
                        taxAmount: 0
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        unappliedAmount: 10
                        updatedById: 2c92c8f95b79c9ad015b80614273052c
                        updatedDate: '2017-05-05 01:15:24'
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List credit memos
      tags:
        - Credit Memos
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Creates an ad-hoc credit memo from a product rate plan charge. Zuora
        supports the creation of credit memos from any type of product rate plan
        charge. The charges can also have any amount and any charge model,
        except for discout charge models. 


        When credit memos are created from product rate plan charges, the
        specified amount with decimal places is now validated based on the
        decimal places supported by each currency.


        You can create a credit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
      operationId: POST_CreditMemoFromPrpc
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditMemoFromChargeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad08f0091698a7a01916e70df165b3b
                    number: CM00000010
                    accountId: 8ad09be48db5aba7018db604776d4854
                    accountNumber: A00000097
                    currency: USD
                    creditMemoDate: '2024-08-19'
                    targetDate: null
                    postedById: null
                    postedOn: null
                    status: Draft
                    amount: 10
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    unappliedAmount: 10
                    refundAmount: 0
                    appliedAmount: 0
                    comment: null
                    source: AdhocFromPrpc
                    sourceId: null
                    referredInvoiceId: null
                    reasonCode: Correcting invoice error
                    createdDate: '2024-08-19 23:19:36'
                    createdById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-08-19 23:19:36'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    cancelledOn: null
                    cancelledById: null
                    latestPDFFileId: ac1ebc24569sd
                    transferredToAccounting: 'No'
                    excludeFromAutoApplyRules: false
                    autoApplyUponPosting: false
                    reversed: false
                    taxStatus: Complete
                    sourceType: Standalone
                    taxMessage: null
                    billToContactId: null
                    billToContactSnapshotId: null
                    sequenceSetId: null
                    invoiceGroupNumber: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a credit memo from a charge
      tags:
        - Credit Memos
  /v1/credit-memos/bulk:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Creates multiple credit memos from invoices or product rate plan
        charges. You can create a maximum of 50 credit memos in one single
        request. 


        - If you set the `sourceType` request field to `Invoice`, you can create
        multiple credit memos from invoices.

        - If you set the `sourceType` request field to `Standalone`, you can
        create multiple credit memos from product rate plan charges.


        The credit memos that are created are each in separate database
        transactions. If the creation of one credit memo fails, other credit
        memos can still be created successfully. 


        You can create credit memos only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        Zero-amount memo items are supported in the following scenarios:

        - If you want to correct taxation items only for an invoice, you can set
        the memo item amount to zero, but the taxation item amount to non-zero.

        - If you want to correct personal data in an invoice, you can set the
        memo item amount to zero to create a zero-amount credit memo from an
        invoice.
      operationId: POST_CreateCreditMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTBulkCreditMemosRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    memos:
                      - accountId: ff8080817fe9d7b9017fe9e5234d04cb
                        accountNumber: A00000001
                        amount: 100
                        appliedAmount: 0
                        autoApplyUponPosting: false
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: test
                        createdById: ff8080817fe9d7b9017fe9e41732030e
                        createdDate: '2022-04-02 18:49:47'
                        creditMemoDate: '2022-04-02'
                        currency: USD
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        excludeFromAutoApplyRules: false
                        id: ff8080817fe9d7b9017fe9e5382f04f5
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: ac1ebc24569sd
                        number: CM00000001
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0
                        refundAmount: 0
                        reversed: false
                        sequenceSetId: null
                        source: AdhocFromInvoice
                        sourceId: null
                        sourceType: Invoice
                        status: Draft
                        success: true
                        targetDate: null
                        taxAmount: 0
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        unappliedAmount: 100
                        updatedById: ff8080817fe9d7b9017fe9e41732030e
                        updatedDate: '2022-04-02 18:49:47'
                      - objectIndex: 1
                        processId: 0356073CB721291A
                        reasons:
                          - code: 50000040
                            message: Cannot find a Invoice instance with id test.
                        success: false
                    success: true
              schema:
                $ref: '#/components/schemas/BulkCreditMemosResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create credit memos
      tags:
        - Credit Memos
    put:
      description: >
        **Notes:** 

        - This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.

        - You can update credit memos only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        Updates the basic and finance information about multiple credit memos.
        You can update a maximum of 50 credit memos in one single request. 


        Currently, Zuora supports updating tax-exclusive memo items, but does
        not support updating tax-inclusive memo items. If the amount of a memo
        item is updated, the tax will be recalculated in the following
        conditions:

        - The memo is created from a product rate plan charge and you use
        Avalara to calculate the tax.

        - The memo is created from an invoice and you use Avalara or Zuora Tax
        to calculate the tax.


        The <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API/"
        target="_blank">Edit credit and debit memos</a> tutorial demonstrates
        how to use this operation to add and delete memo items.


        The credit memos that are updated are each in separate database
        transactions. If the update of one credit memo fails, other credit memos
        can still be updated successfully.
      operationId: PUT_UpdateCreditMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTBulkCreditMemosRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    memos:
                      - accountId: ff8080817fe9d7b9017fe9e5234d04cb
                        accountNumber: A00000001
                        amount: 100
                        appliedAmount: 0
                        autoApplyUponPosting: false
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: test
                        createdById: ff8080817fe9d7b9017fe9e41732030e
                        createdDate: '2022-04-02 18:49:47'
                        creditMemoDate: '2022-04-02'
                        currency: USD
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        excludeFromAutoApplyRules: false
                        id: ff8080817fe9d7b9017fe9e5382f04f5
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: ac1ebc24569sd
                        number: CM00000001
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0
                        refundAmount: 0
                        reversed: false
                        sequenceSetId: null
                        source: AdhocFromInvoice
                        sourceId: null
                        sourceType: Invoice
                        status: Draft
                        success: true
                        targetDate: null
                        taxAmount: 0
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        unappliedAmount: 100
                        updatedById: ff8080817fe9d7b9017fe9e41732030e
                        updatedDate: '2022-04-02 18:49:47'
                      - id: ff8080817fe9d7b9017fe9e41732030f
                        objectIndex: 1
                        processId: 0356073CB721291A
                        reasons:
                          - code: 50000040
                            message: Cannot find a Invoice instance with id.
                        success: false
                    success: true
              schema:
                $ref: '#/components/schemas/BulkCreditMemosResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update credit memos
      tags:
        - Credit Memos
  /v1/credit-memos/pdf-status:
    get:
      description: |
        Retrieves the PDF generation statuses of a batch of credit memos.
      operationId: Get_CreditMemoPdfStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >-
            The IDs or numbers of the credit memos separated by commas. For
            example -
            `?creditMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,CM0000001`.
            A maximum of 50 keys can be entered in this field. 
          in: query
          name: creditMemoKeys
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                creditMemoFiles:
                  - creditMemoId: 402824aa8cc894d5018cc8a120576881
                    creditMemoNumber: CM00000003
                    pdfGenerationStatus: Generated
                    createdOn: '2024-01-01 11:35:56'
                    updatedOn: '2024-01-01 11:35:56'
                    pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
                  - creditMemoId: 2c98908a904dfc2601904e6e14090241
                    creditMemoNumber: CM00000004
                    pdfGenerationStatus: Error
                    createdOn: '2024-01-02 10:14:13'
                    updatedOn: '2024-01-02 10:14:13'
                    errorCode: INVALID_TEMPLATE
                    errorMessage: Unknown merge filed chargeNumber__c
                  - creditMemoId: 514936bb7dd014e6230dd0c342798103
                    creditMemoNumber: CM00000005
                    pdfGenerationStatus: Pending
                    createdOn: '2024-01-01 11:35:56'
                    updatedOn: '2024-01-01 11:35:56'
                success: true
              schema:
                $ref: '#/components/schemas/GetCreditMemoPdfStatusBatchResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '50000020'
                    message: Credit memo key is required
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              example:
                message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            WWW-Authenticate:
              description: >-
                The value of this header is: ``` Basic realm=Zuora API, ZSession
                realm=Zuora API, Bearer realm=Zuora API ``` 
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve the PDF file generation status of credit memos
      tags:
        - Credit Memos
      x-accepts: application/json
  /v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Retrieves information about the taxation items of a specific credit memo
        item. 
      operationId: GET_TaxationItemsOfCreditMemoItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: >
            The unique ID of a credit memo item. You can get the credit memo
            item ID from the response of [List credit memo
            items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems).
          in: path
          name: cmitemid
          required: true
          schema:
            type: string
        - description: >
            The unique ID of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - appliedAmount: 0
                        exemptAmount: 10
                        financeInformation:
                          onAccountAccountingCode: Check
                          onAccountAccountingCodeType: Cash
                          salesTaxPayableAccountingCode: Check
                          salesTaxPayableAccountingCodeType: Cash
                        id: 2c98901a68ff2680016903216a271a67
                        jurisdiction: Jurisdiction
                        locationCode: '8'
                        name: taxName_0
                        refundAmount: 0
                        sourceTaxItemId: null
                        taxAmount: 10
                        taxCode: taxCode
                        taxCodeDescription: taxCodeDescription
                        taxDate: '2016-10-10'
                        taxRate: 0.1
                        taxRateDescription: taxRateDescription
                        taxRateType: Percentage
                        unappliedAmount: 10
                    success: true
              schema:
                $ref: '#/components/schemas/GETTaxationItemsOfCreditMemoItemType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.        
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all taxation items of a credit memo item
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoId}/write-off:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Write off a fully unapplied credit memo. When writing off a credit memo,
        a debit memo is automatically created, and then the credit memo to be
        written off is fully applied to the debit memo.


        Note that this operation only supports writing off credit memos that are
        fully unapplied. Credit memos that are not fully unapplied cannot be
        written off by this operation. 
      operationId: PUT_WriteOffCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTCreditMemoWriteOff'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    debitMemo:
                      id: 4028905f5a87c0ff015a87e49e6b0062
                    success: true
              schema:
                $ref: '#/components/schemas/PUTCreditMemoWriteOffResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Write off a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}:
    delete:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Deletes a credit memo. Only credit memos with the Cancelled status can
        be deleted. 


        You can delete a credit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
      operationId: DELETE_CreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a credit memo
      tags:
        - Credit Memos
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about a specific credit memo.


        For a use case of this operation, see [Get credit
        memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo).
      operationId: GET_CreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402890555a7e9791015a7f15fe44001c
                    accountNumber: A00000001
                    amount: 3.1
                    appliedAmount: 0
                    autoApplyUponPosting: false
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: null
                    cancelledOn: null
                    comment: ''
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 10:07:10'
                    creditMemoDate: '2017-03-01'
                    currency: USD
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    excludeFromAutoApplyRules: false
                    id: 402890555a7e9791015a879f064a0054
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: 402890555a7e9791015a879f07fb005e
                    number: CM00000012
                    postedById: null
                    postedOn: null
                    reasonCode: Correcting invoice error
                    referredInvoiceId: 402890555a7e9791015a7f1756aa0035
                    refundAmount: 0
                    reversed: false
                    sequenceSetId: null
                    source: API
                    sourceId: null
                    sourceType: Standalone
                    status: Draft
                    success: true
                    targetDate: null
                    taxAmount: 0.1
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    unappliedAmount: 3.1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 10:08:43'
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a credit memo
      tags:
        - Credit Memos
    put:
      description: >
        **Notes:** 

        - This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.

        - You can update a credit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        Updates the basic and finance information about a credit memo. 


        Currently, Zuora supports updating tax-exclusive memo items, but does
        not support updating tax-inclusive memo items. If the amount of a memo
        item is updated, the tax will be recalculated in the following
        conditions:

        - The memo is created from a product rate plan charge and you use
        Avalara to calculate the tax.

        - The memo is created from an invoice and you use Avalara or Zuora Tax
        to calculate the tax.


        The [Edit credit and debit
        memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API)
        tutorial demonstrates how to use this operation to add and delete memo
        items.
      operationId: PUT_UpdateCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTCreditMemoType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad081dd91698b2801916e637b19583f
                    number: CM00000008
                    accountId: 8ad09be48db5aba7018db604776d4854
                    accountNumber: A00000097
                    currency: USD
                    creditMemoDate: '2024-08-19'
                    targetDate: null
                    postedById: null
                    postedOn: null
                    status: Draft
                    amount: 14.99
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    unappliedAmount: 14.99
                    refundAmount: 0
                    appliedAmount: 0
                    comment: Details about this Credit Memo
                    source: AdhocFromPrpc
                    sourceId: null
                    referredInvoiceId: null
                    reasonCode: Ad hoc credit
                    createdDate: '2024-08-19 23:04:59'
                    createdById: 8ad09fc28193c189018194da28be74ba
                    updatedDate: '2024-08-19 23:05:55'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    cancelledOn: null
                    cancelledById: null
                    latestPDFFileId: ac1ebc24569sd
                    transferredToAccounting: 'No'
                    excludeFromAutoApplyRules: true
                    autoApplyUponPosting: false
                    reversed: false
                    taxStatus: Complete
                    sourceType: Standalone
                    taxMessage: null
                    billToContactId: null
                    billToContactSnapshotId: null
                    sequenceSetId: null
                    invoiceGroupNumber: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/apply:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Applies a posted credit memo to one or more invoices and debit memos. 


        You can apply a credit memo to an invoice or a debit memo only if you
        have the user permission. See [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        When you apply a credit memo, the total number of credit memo items and
        the items that credit memo items to be applied to must be less than or
        equal to 15,000.


        If the limit is hit, you can follow the following instructions:


        - If you want to apply one credit memo to multiple invoices or debit
        memos, decrease the number of invoices or debit memos in the request.

        - If you want to apply one credit memo to a single invoice or debit memo
        with a large volume of items, you have to specify invoice items or debit
        memo items in the request. The maximum number of invoice items or debit
        memo items that you can specify in the request is 1,000.

        - If a credit memo has a large volume of items, you have to specify
        credit memo items in the request. The maximum number of credit memo
        items that you can specify in the request is 1,000.
                
        If the Proration application rule is used, when applying credit memos,
        the following quantity must be less than or equal to 10,000: 


        (number of invoice items + number of debit memo items) * number of
        credit memo items


        Otherwise, the First In First Out rule will be used instead of the
        Proration rule.
      operationId: PUT_ApplyCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyCreditMemoType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad081dd91698b2801916e5a84b65653
                    number: CM00000007
                    accountId: 8ad09be48db5aba7018db604776d4854
                    accountNumber: A00000097
                    currency: USD
                    creditMemoDate: '2024-08-19'
                    targetDate: null
                    postedById: 8ad09fc28193c189018194da28be74ba
                    postedOn: '2024-08-19 22:55:11'
                    status: Posted
                    amount: 14.99
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    unappliedAmount: 3.99
                    refundAmount: 0
                    appliedAmount: 11
                    comment: ''
                    source: AdhocFromPrpc
                    sourceId: null
                    referredInvoiceId: null
                    reasonCode: Ad hoc credit
                    createdDate: '2024-08-19 22:55:11'
                    createdById: 8ad09fc28193c189018194da28be74ba
                    updatedDate: '2024-08-19 22:59:54'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    cancelledOn: null
                    cancelledById: null
                    latestPDFFileId: ac1ebc24569sd
                    transferredToAccounting: 'No'
                    excludeFromAutoApplyRules: true
                    autoApplyUponPosting: false
                    reversed: false
                    taxStatus: Complete
                    sourceType: Standalone
                    taxMessage: null
                    billToContactId: null
                    billToContactSnapshotId: null
                    sequenceSetId: null
                    invoiceGroupNumber: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Apply a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/cancel:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Cancels a credit memo. Only credit memos with the Draft status can be
        cancelled. 


        You can cancel a credit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
      operationId: PUT_CancelCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402890555a7e9791015a7f15fe44001c
                    accountNumber: A00000001
                    amount: 2020
                    appliedAmount: 0
                    autoApplyUponPosting: false
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: 402881e522cf4f9b0122cf5d82860002
                    cancelledOn: '2017-09-03 19:59:07'
                    comment: the comment
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 15:31:10'
                    creditMemoDate: '2017-10-17'
                    currency: USD
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    excludeFromAutoApplyRules: false
                    id: 402890555a87d7f5015a88c7a6830022
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: 402890555a87d7f5015a88c7a7a2002a
                    number: CM00000015
                    postedById: null
                    postedOn: null
                    reasonCode: Correcting invoice error
                    referredInvoiceId: null
                    refundAmount: 0
                    reversed: false
                    sequenceSetId: null
                    source: AdhocFromPrpc
                    sourceId: null
                    sourceType: Standalone
                    status: Canceled
                    success: true
                    targetDate: null
                    taxAmount: 0
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    unappliedAmount: 2020
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 15:36:57'
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/emails:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Sends a posted credit memo to the specified email addresses manually.




        ### Notes
          - You must activate the **Email Credit Memo | Manually email Credit Memo** notification before emailing credit memos. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.


          - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Credit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.


          - The credit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:

            * The `useEmailTemplateSetting` field is set to `false`.
            * The email addresses are not specified in the `emailAddresses` field.
      operationId: POST_EmailCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of a posted credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCreditMemoEmailRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Email a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/files:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Uploads an externally generated PDF file for a credit memo that is in
        Draft or Posted status.


        To use this operation, you must enable the Modify Modify Credit Memo
        permission. See [Billing
        Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        This operation has the following restrictions:

        - Only the PDF file format is supported.

        - The maximum size of the PDF file to upload is 4 MB.

        - A maximum of 50 PDF files can be uploaded for one credit memo.
      operationId: POST_UploadFileForCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The ID or number of the credit memo that you want to upload a PDF
            file for. For example, 402890555a7e9791015a879f064a0054 or
            CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: |
                    The PDF file to upload for the credit memo.
                  format: binary
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fileId: 40289f466463d683016463ef8b7301a4
                    success: true
              schema:
                $ref: '#/components/schemas/POSTUploadFileResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Upload a file for a credit memo
      tags:
        - Credit Memos
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreditMemoFile.pdf"
            "https://rest.zuora.com/v1/credit-memos/402890555a7e9791015a879f064a0054/files"
    get:
      description: >
        Retrieves the information about all PDF files of a specified credit
        memo. 


        Credit Memo PDF files are returned in reverse chronological order by the
        value of the `versionNumber` field.

        **Note**: This API only retrieves the PDF files that have been
        generated. If the latest PDF file is being generated, it will not be
        included in the response.
      operationId: GET_CreditMemoFiles
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: >
            The unique ID or number of an credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    creditMemoFiles:
                      - id: 8a90a24f8e128020018e12cf610f03f9
                        pdfFileUrl: /v1/files/8a90a24f8e128020018e12cf610903f8
                        versionNumber: 1709712563443
                      - id: 8a90b5148c6d127b018c6d1e3c6e022e
                        pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e3c68022d
                        versionNumber: 1702637739555
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoFilesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all files of a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/items:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all items of a credit memo. A credit
        memo item is a single line item in a credit memo. 


        ### Filtering


        You can use query parameters to restrict the data returned in the
        response. Each query parameter corresponds to one field in the response
        body.


        If the value of a filterable field is string, you can set the
        corresponding query parameter to `null` when filtering. Then, you can
        get the response data with this field value being `null`. 


        Examples:
            
          - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100
          
          - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate
            
      operationId: GET_CreditMemoItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: |
            This parameter filters the response based on the `amount` field. 
          in: query
          name: amount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `appliedAmount`
            field.
          in: query
          name: appliedAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `createdById`
            field. 
          in: query
          name: createdById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `createdDate`
            field. 
          in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            This parameter filters the response based on the `id` field. 
          in: query
          name: id
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `refundAmount`
            field. 
          in: query
          name: refundAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `serviceEndDate`
            field. 
          in: query
          name: serviceEndDate
          required: false
          schema:
            format: date
            type: string
        - description: >
            This parameter filters the response based on the `serviceStartDate`
            field. 
          in: query
          name: serviceStartDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `sku` field. 
          in: query
          name: sku
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `skuName` field. 
          in: query
          name: skuName
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `sourceItemId`
            field. 
          in: query
          name: sourceItemId
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `subscriptionId`
            field.
          in: query
          name: subscriptionId
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedById`
            field. 
          in: query
          name: updatedById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedDate`
            field.
          in: query
          name: updatedDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by this
            field.

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            By default, the response data is displayed in descending order by
            updated date.


            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - amount
              - appliedAmount
              - createdById
              - createdDate
              - id
              - refundAmount
              - serviceEndDate
              - serviceStartDate
              - sku
              - skuName
              - sourceItemId
              - subscriptionId
              - updatedById
              - updatedDate

              
            Examples:


            -
            /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate


            -
            /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate
          in: query
          name: sort
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    items:
                      - amount: 1
                        amountWithoutTax: 0
                        appliedAmount: 0
                        appliedToItemId: null
                        comment: ''
                        commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63
                        commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 10:07:10'
                        creditFromItemId: 402880e97a56f30b017a574012e50085
                        creditFromItemSource: CreditMemoItem
                        excludeItemBillingFromRevenueAccounting: true
                        financeInformation:
                          deferredRevenueAccountingCode: null
                          deferredRevenueAccountingCodeType: null
                          onAccountAccountingCode: null
                          onAccountAccountingCodeType: null
                          recognizedRevenueAccountingCode: null
                          recognizedRevenueAccountingCodeType: null
                        id: 402890555a7e9791015a879f064d0055
                        invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                        invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                        numberOfDeliveries: 1
                        processingType: Charge
                        quantity: 1
                        refundAmount: 0
                        serviceEndDate: '2017-03-26'
                        serviceStartDate: '2017-02-27'
                        sku: SKU-00000001
                        skuName: New Component
                        soldToContactId: 402881e522cf4f9b0122cf5d82860003
                        soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                        sourceItemId: 402890555a7e9791015a7f1756bc0037
                        sourceItemType: InvoiceDetail
                        subscriptionId: 402890d25bec1155015bec35cc7c0bc7
                        taxMode: TaxExclusive
                        taxationItems:
                          data:
                            - appliedAmount: 0
                              exemptAmount: 0
                              financeInformation:
                                onAccountAccountingCode: Check
                                onAccountAccountingCodeType: Cash
                                salesTaxPayableAccountingCode: Check
                                salesTaxPayableAccountingCodeType: Cash
                              id: 402890555a7e9791015a87a072880062
                              jurisdiction: CALIFORNIA
                              locationCode: '06'
                              name: STATE TAX
                              refundAmount: 0
                              sourceTaxItemId: null
                              taxAmount: 0.1
                              taxCode: ServiceTaxCode
                              taxCodeDescription: This is tax code description!
                              taxDate: '2016-09-30'
                              taxRate: 0.0625
                              taxRateDescription: This is tax rate description!
                              taxRateType: Percentage
                              unappliedAmount: 0.1
                        unappliedAmount: 1
                        unitOfMeasure: Each
                        unitPrice: 1
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 10:08:43'
                      - amount: 2
                        amountWithoutTax: 2
                        appliedAmount: 0
                        appliedToItemId: null
                        comment: ''
                        commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63
                        commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 10:07:10'
                        creditFromItemId: 402880e97a56f30b017a574012f00086
                        creditFromItemSource: CreditMemoItem
                        excludeItemBillingFromRevenueAccounting: true
                        financeInformation:
                          deferredRevenueAccountingCode: null
                          deferredRevenueAccountingCodeType: null
                          onAccountAccountingCode: null
                          onAccountAccountingCodeType: null
                          recognizedRevenueAccountingCode: null
                          recognizedRevenueAccountingCodeType: null
                        id: 402890555a7e9791015a879f06610056
                        invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                        invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                        numberOfDeliveries: 1
                        processingType: Charge
                        quantity: 1
                        refundAmount: 0
                        serviceEndDate: '2017-03-26'
                        serviceStartDate: '2017-02-27'
                        sku: SKU-00000001
                        skuName: New Component
                        soldToContactId: 402881e522cf4f9b0122cf5d82860003
                        soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                        sourceItemId: 402890555a7e9791015a7f1756bd0038
                        sourceItemType: InvoiceDetail
                        subscriptionId: 402890d25bec1155015bec35cc7c0bc7
                        taxMode: TaxExclusive
                        taxationItems:
                          data: []
                        unappliedAmount: 2
                        unitOfMeasure: Each
                        unitPrice: 2
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 10:07:10'
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoItemsListType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List credit memo items
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/items/{cmitemid}:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Retrieves the information about a specific item of a credit memo. A
        credit memo item is a single line item in a credit memo.
      operationId: GET_CreditMemoItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a credit memo item. You can get the credit memo
            item ID from the response of [List credit memo
            items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems).
          in: path
          name: cmitemid
          required: true
          schema:
            type: string
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 1
                    amountWithoutTax: 1
                    appliedAmount: 0
                    appliedToItemId: null
                    comment: ''
                    commitmentId: 4028819f9a4dfdf1019a4e04acfb7e63
                    commitmentPeriodId: 4028819f9a4dfdf1019a4e06f04a402c
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 10:07:10'
                    creditFromItemId: 402880e97a56f30b017a574012f00086
                    creditFromItemSource: CreditMemoItem
                    excludeItemBillingFromRevenueAccounting: true
                    financeInformation:
                      deferredRevenueAccountingCode: Check
                      deferredRevenueAccountingCodeType: null
                      onAccountAccountingCode: null
                      onAccountAccountingCodeType: null
                      recognizedRevenueAccountingCode: null
                      recognizedRevenueAccountingCodeType: null
                    id: 402890555a7e9791015a879f064d0055
                    invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                    invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                    numberOfDeliveries: 1
                    processingType: Charge
                    quantity: 1
                    refundAmount: 0
                    serviceEndDate: '2017-03-26'
                    serviceStartDate: '2017-02-27'
                    sku: SKU-00000001
                    skuName: New Component
                    soldToContactId: 402881e522cf4f9b0122cf5d82860003
                    soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                    sourceItemId: 402890555a7e9791015a7f1756bc0037
                    sourceItemType: InvoiceDetail
                    subscriptionId: 402890d25bec1155015bec35cc7c0bc7
                    success: true
                    taxMode: TaxExclusive
                    taxationItems:
                      data: []
                    unappliedAmount: 1
                    unitOfMeasure: Each
                    unitPrice: 1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 10:08:43'
              schema:
                $ref: '#/components/schemas/GETCreditMemoItemType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a credit memo item
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/parts:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all parts of a credit memo. A credit
        memo can consist of an unapplied part, and several parts applied to
        invoices and debit memos. You can use this operation to get all the
        applied and unapplied portions of a credit memo. Note that a fully
        refunded credit memo does not contain any credit memo part.
      operationId: GET_CreditMemoParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    parts:
                      - amount: 3.66
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-02 13:21:55'
                        debitMemoId: null
                        id: 4028905f5a890526015a8d77adea0029
                        invoiceId: null
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-02 13:21:55'
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoPartsCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all parts of a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/parts/{partid}:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about a specific credit memo part. A credit
        memo can consist of an unapplied part, and several parts applied to
        invoices and debit memos.


        A fully refunded credit memo does not contain any credit memo part.
      operationId: GET_CreditMemoPart
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a specific credit memo part. You can get the credit
            memo part ID from the response of [List all parts of a credit
            memo](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoParts).
          in: path
          name: partid
          required: true
          schema:
            type: string
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 1
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-02 14:00:21'
                    debitMemoId: null
                    id: 4028905f5a890526015a8d9adeb30059
                    invoiceId: 4028905f5a87c0ff015a87d3f8f10043
                    success: true
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-02 14:00:21'
              schema:
                $ref: '#/components/schemas/GETCreditMemoPartType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a credit memo part
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/pdfs:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Creates a PDF file for a specified credit memo. To access the generated
        PDF file, you can download it by clicking **View PDF** on the detailed
        credit memo page through the Zuora UI.


        This REST API operation can be used only if you have the billing
        document file generation feature and the Billing user permission
        "Regenerate PDF" enabled.
      operationId: POST_CreditMemoPDF
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the credit memo that you want to create a
            PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or
            CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/POSTMemoPdfResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate a credit memo PDF file
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/post:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Posts a credit memo to activate it. You can post credit memos only if
        you have the [Billing
        permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).
      operationId: PUT_PostCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402890555a7e9791015a7f15fe44001c
                    accountNumber: A00000001
                    amount: 3.1
                    appliedAmount: 0
                    autoApplyUponPosting: false
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: null
                    cancelledOn: null
                    comment: ''
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 10:07:10'
                    creditMemoDate: '2017-03-01'
                    currency: USD
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    excludeFromAutoApplyRules: false
                    id: 402890555a7e9791015a879f064a0054
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: ac1ebc24569sd
                    number: CM00000012
                    postedById: 402881e522cf4f9b0122cf5d82860002
                    postedOn: '2017-03-01 14:28:06'
                    reasonCode: Correcting invoice error
                    referredInvoiceId: 402890555a7e9791015a7f1756aa0035
                    refundAmount: 0
                    reversed: false
                    sequenceSetId: null
                    source: API
                    sourceId: null
                    sourceType: Standalone
                    status: Posted
                    success: true
                    targetDate: null
                    taxAmount: 0.1
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    unappliedAmount: 3.1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:28:06'
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Post a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/refund:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Refunds a full or partial posted credit memo to your customers. Only the
        amount of unapplied part could be refunded. 


        You can refund a credit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        When you refund a credit memo, the total number of credit memo items to
        be refunded must be less than or equal to 15,000.


        For a use case of this operation, see [Refund
        processing](https://developer.zuora.com/rest-api/general-concepts/authentication//#Refund-processing).
      operationId: POST_RefundCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the credit memo. For example,
            2c92c8955bd63cc1015bd7c151af02ab or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostNonRefRefundType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad0937890e7fca00190e8c290d46fad
                    number: R-00000001
                    status: Processed
                    type: Electronic
                    methodType: CreditCard
                    accountId: 8ad09be48db5aba7018db604776d4854
                    amount: 10
                    refundDate: '2024-07-25'
                    comment: null
                    paymentMethodId: 8ad084db90a5e73b0190c02783f552fa
                    paymentMethodSnapshotId: 8ad0937890e7fca00190e8c290b86fab
                    paymentId: null
                    paymentNumber: null
                    creditMemoId: 8ad0835290c4bb2f0190d9955e414e62
                    reasonCode: null
                    gatewayId: 2c92c0f972bc6aa90172bc77ccaf379a
                    paymentGatewayNumber: null
                    gatewayResponse: This transaction has been approved by Test gateway.
                    gatewayResponseCode: approve
                    gatewayState: Submitted
                    markedForSubmissionOn: null
                    referenceId: '70028533'
                    secondRefundReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: '2024-07-25 00:19:43'
                    settledOn: null
                    cancelledOn: null
                    createdDate: '2024-07-25 00:19:43'
                    createdById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-25 00:19:43'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    refundTransactionTime: '2024-07-25 00:19:43'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: Accounts Receivable
                      unappliedPaymentAccountingCodeType: AccountsReceivable
                      transferredToAccounting: 'No'
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETRefundCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Refund a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/reverse:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Reverses a posted credit memo. See [Reverse credit
        memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/C_Management_of_Credit_and_Debit_Memos/Reverse_credit_memos)
        for more information.


        You can reverse a credit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        **Restrictions**


        You cannot reverse credit memos if any of the following conditions is
        met:


        * A credit memo's applied amount is not 0.

        * A credit memo is not in Posted status.

        * A credit memo contains more than 2,000 items in total, including
        credit memo items, discount items, and taxation items.
      operationId: PUT_ReverseCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the credit memo. For example,
            2c92c8955bd63cc1015bd7c151af02ab or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutReverseCreditMemoType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    debitMemo:
                      id: 402890555a40ca7f015a5b099b0e307a
                    success: true
              schema:
                $ref: '#/components/schemas/PutReverseCreditMemoResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Reverse a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/taxation-items:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Creates taxation items for a credit memo.
      operationId: POST_CM_TaxationItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTTaxationItemListForCMType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    taxationItems:
                      - createdById: 8ad084a67f9c7138017fab8a8b511b5a
                        createdDate: '2024-11-15 14:41:04'
                        exemptAmount: 0
                        id: 8ad0980c932a209d01932e8dcbf83bc8
                        memoItemId: 8ad086fa932a0b5401932e82ab1f1fb3
                        invoiceItemId: 8ad086fa932a0b5401932e82a3e5b211
                        sourceTaxItemId: null
                        jurisdiction: CALIFORNIA
                        locationCode: null
                        name: STATE TAX
                        taxAmount: 0.5
                        applicableTaxUnRounded: 0.5
                        country: null
                        taxCode: ServiceTaxCode
                        taxCodeDescription: null
                        taxDate: '2024-11-15'
                        taxRate: 0.05
                        taxMode: TaxExclusive
                        taxRateDescription: null
                        taxRateType: Percentage
                        updatedById: 8ad084a67f9c7138017fab8a8b511b5a
                        updatedDate: '2024-11-15 14:41:04'
                        financeInformation:
                          salesTaxPayableAccountingCode: Sales Tax Payable
                          salesTaxPayableAccountingCodeType: SalesTaxPayable
                          accountsReceivableAccountingCode: Accounts Receivable
                          accountsReceivableAccountingCodeType: AccountsReceivable
                    success: true
              schema:
                $ref: '#/components/schemas/GETTaxationItemListType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create taxation items for a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/unapply:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Unapplies an applied credit memo from one or more invoices and debit
        memos. The full applied amount from invoices and debit memos is
        transferred into the unapplied amount of the credit memo. 


        You can unapply a credit memo from an invoice or a debit memo only if
        you have the user permission. See [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        When you unapply a credit memo, the total number of credit memo items
        and the items that credit memo items to be unapplied from must be less
        than or equal to 15,000.


        If the limit is hit, you can follow the following instructions:


        - If you want to unapply one credit memo without specifying invoices or
        debit memos and the limit is hit, you have to specify the invoice items
        or debit memo items in the request to decrease the number of items.

        - If you want to unapply one credit memo from multiple specified
        invoices or debit memos, decrease the number of invoices or debit memos
        in the request.

        - If you want to unapply one credit memo from a single invoice or debit
        memo with a large volume of items, you have to specify invoice items or
        debit memo items in the request. The maximum number of invoice items or
        debit memo items that you can specify in the request is 1,000.

        - If a credit memo has a large volume of items, you have to specify
        credit memo items in the request. The maximum number of credit memo
        items that you can specify in the request is 1,000.

        - When unapplying a credit memo, the total number of the credit memo's
        item parts must be less than or equal to 1,000. Otherwise, the operation
        would fail and an error message would pop up. When you see this error,
        you can try using the Unapply a credit memo API as an alternative.
        Similarly, make sure that all the requirements listed in the API
        reference are met.
      operationId: PUT_UnapplyCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnapplyCreditMemoType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90aac892dc8c3a0192dce41af10077
                    number: CM00000619
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    accountNumber: A00000370
                    currency: USD
                    creditMemoDate: '2024-10-30'
                    targetDate: null
                    postedById: 2c92c8f95e2d6ebb015e325df48e02da
                    postedOn: '2024-10-30 18:06:30'
                    status: Posted
                    amount: 15
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    unappliedAmount: 1
                    refundAmount: 0
                    appliedAmount: 14
                    comment: ''
                    source: AdhocFromInvoice
                    sourceId: null
                    referredInvoiceId: 8a90d7a892d82d920192dbcb314501c7
                    reasonCode: Correcting invoice error
                    createdDate: '2024-10-30 18:06:29'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-10-30 18:08:37'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    cancelledOn: null
                    cancelledById: null
                    latestPDFFileId: null
                    transferredToAccounting: 'No'
                    excludeFromAutoApplyRules: false
                    autoApplyUponPosting: false
                    reversed: false
                    taxStatus: Complete
                    sourceType: Invoice
                    eInvoiceStatus: Failed
                    eInvoiceErrorCode: IntegrationError
                    eInvoiceErrorMessage: Input string was null.
                    eInvoiceFileId: null
                    taxMessage: null
                    billToContactId: null
                    billToContactSnapshotId: 8a90b4488e7d5c0f018e7dbef1f900c9
                    sequenceSetId: null
                    invoiceGroupNumber: null
                    revenueImpacting: 'Yes'
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Unapply a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/unpost:
    put:
      description: >-
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Unposts a credit memo that is in Posted status. If a credit memo has
        been applied or refunded, you are not allowed to unpost it. After a
        credit memo is unposted, its status becomes Draft. 


        You can unpost credit memos only if you have the [Billing
        permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). 


        You can prevent  an unpost operation by configuring the  'Do not allow
        unposting invoices and memos if their revenue is already recognized in a
        closed accounting period' accounting  rule. The default value of this
        rule is set to 'disabled.' 

         For more information,  see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period).
      operationId: PUT_UnpostCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402890555a7e9791015a7f15fe44001c
                    accountNumber: A00000001
                    amount: 3.1
                    appliedAmount: 0
                    autoApplyUponPosting: false
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: null
                    cancelledOn: null
                    comment: ''
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 10:07:10'
                    creditMemoDate: '2017-03-01'
                    currency: USD
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    excludeFromAutoApplyRules: false
                    id: 402890555a7e9791015a879f064a0054
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: ac1ebc24569sd
                    number: CM00000012
                    postedById: 402881e522cf4f9b0122cf5d82860002
                    postedOn: '2017-03-01 14:28:06'
                    reasonCode: Correcting invoice error
                    referredInvoiceId: 402890555a7e9791015a7f1756aa0035
                    refundAmount: 0
                    reversed: false
                    sequenceSetId: null
                    source: API
                    sourceId: null
                    sourceType: Standalone
                    status: Draft
                    success: true
                    targetDate: null
                    taxAmount: 0.1
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    unappliedAmount: 3.1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:28:06'
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Unpost a credit memo
      tags:
        - Credit Memos
  /v1/credit-memos/invoice/{invoiceKey}:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Creates an ad-hoc credit memo from an invoice.


        You can create a credit memo from an invoice only if you have the user
        permission. See [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        For a use case of this operation, see [Create credit
        memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Create-credit-memo).


        Zero-amount memo items are supported in the following scenarios:

        - If you want to correct taxation items only for an invoice, you can set
        the memo item amount to zero, but the taxation item amount to non-zero.

        - If you want to correct personal data in an invoice, you can set the
        memo item amount to zero to create a zero-amount credit memo from an
        invoice.
      operationId: POST_CreditMemoFromInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >
            The ID or number of an invoice that you want to create a credit memo
            from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditMemoFromInvoiceRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90e4a792d82d8c0192dbda90671d66
                    number: CM00000618
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    accountNumber: A00000370
                    currency: USD
                    creditMemoDate: '2024-10-30'
                    targetDate: null
                    postedById: null
                    postedOn: null
                    status: Draft
                    amount: 10
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    unappliedAmount: 10
                    refundAmount: 0
                    appliedAmount: 0
                    comment: null
                    source: AdhocFromInvoice
                    sourceId: null
                    referredInvoiceId: 8a90d7a892d82d920192dbcb314501c7
                    reasonCode: Correcting invoice error
                    createdDate: '2024-10-30 13:16:27'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-10-30 13:16:27'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    cancelledOn: null
                    cancelledById: null
                    latestPDFFileId: null
                    transferredToAccounting: 'No'
                    excludeFromAutoApplyRules: false
                    autoApplyUponPosting: false
                    reversed: false
                    taxStatus: Complete
                    sourceType: Invoice
                    eInvoiceStatus: null
                    eInvoiceErrorCode: null
                    eInvoiceErrorMessage: null
                    eInvoiceFileId: null
                    taxMessage: null
                    billToContactId: null
                    billToContactSnapshotId: null
                    sequenceSetId: null
                    invoiceGroupNumber: null
                    revenueImpacting: 'Yes'
                    success: true
              schema:
                $ref: '#/components/schemas/GETCreditMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a credit memo from an invoice
      tags:
        - Credit Memos
  /v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}:
    get:
      description: >-
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
          Retrieves information about a specific Async Credit Memo Unapply job.  
      operationId: getUnapplyCreditMemoAsyncJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique ID of a Credit Memo Async Unapply Job Id. For example,
            8a92ade496140e830196148cd0af000a.
          in: path
          name: unapplyAsyncJobId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      responses:
        '200':
          content:
            application/json:
              example:
                id: 8a92ade496140e830196148cd0af000a
                status: Processed
                operationType: AsyncCreditMemoUnapply
                referenceId: 4028905f5a890526015a8d73f73d0015
                referenceType: CreditMemo
                error: null
                success: true
              schema:
                $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.        
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an async unapply credit memo job by ID
      tags:
        - Credit Memos
  /v1/credit-memos/apply-async-jobs/{applyAsyncJobId}:
    get:
      description: >-
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
          Retrieves information about a specific Async Credit Memo Apply job.  
      operationId: getApplyCreditMemoAsyncJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique ID of a Credit Memo Async Apply Job Id. For example,
            8a92ade496140e830196141f6cfa0001.
          in: path
          name: applyAsyncJobId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      responses:
        '200':
          content:
            application/json:
              example:
                id: 8a92ade496140e830196141f6cfa0001
                status: Processed
                operationType: AsyncCreditMemoApply
                referenceId: 4028905f5a890526015a8d73f73d0015
                referenceType: CreditMemo
                error: null
                success: true
              schema:
                $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.        
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an async unapply credit memo job by ID
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/apply-async:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.

          Asynchronously applies a posted credit memo to one or more invoices
          You can apply a credit memo to an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
          When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 300,000.
          The maximum number of invoices that you can specify in the request is 1,000
          If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: 

        (number of invoice items) * number of credit memo items


        Otherwise, the First In First Out rule will be used instead of the
        Proration rule.
      operationId: applyCreditMemoAsync
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsyncApplyCreditMemoRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                id: 402881e522cf4f9b0122cf5d82860002
                status: Pending
                operationType: AsyncCreditMemoApply
                referenceId: 4028905f5a890526015a8d73f73d0015
                referenceType: CreditMemo
                error: null
                success: true
              schema:
                $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.        
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Apply a credit memo aysnchronously
      tags:
        - Credit Memos
  /v1/credit-memos/{creditMemoKey}/unapply-async:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.
           Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo. 

        You can unapply a credit memo from an invoice only if you have the user
        permission. See [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
          When you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 300,000.
          The maximum number of invoices that you can specify in the request is 1,000
      operationId: unapplyCreditMemoAsync
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >
            The unique ID or number of a credit memo. For example,
            8a8082e65b27f6c3015ba45ff82c7172.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsyncUnapplyCreditMemoRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                id: 8a92ade496140e830196148cd0af000a
                status: Pending
                operationType: AsyncCreditMemoUnapply
                referenceId: 8a8082e65b27f6c3015ba45ff82c7172
                referenceType: CreditMemo
                error: null
                success: true
              schema:
                $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.        
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Unapply a credit memo asynchronously
      tags:
        - Credit Memos
  /v1/debit-memos:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Retrieves the information about all debit memos associated with all
        customer accounts.


        ### Filtering


        You can use query parameters to restrict the data returned in the
        response. Each query parameter corresponds to one field in the response
        body.


        If the value of a filterable field is string, you can set the
        corresponding query parameter to `null` when filtering. Then, you can
        get the response data with this field value being `null`. 


        Examples:


        - /v1/debit-memos?status=Posted


        - /v1/debit-memos?referredInvoiceId=null&status=Draft


        - /v1/debit-memos?status=Posted&type=External&sort=+number
      operationId: GET_DebitMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: |
            This parameter filters the response based on the `accountId` field.
          in: query
          name: accountId
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `accountNumber`
            field.
          in: query
          name: accountNumber
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `amount` field.
          in: query
          name: amount
          required: false
          schema:
            format: double
            type: number
        - description: |
            This parameter filters the response based on the `balance` field.
          in: query
          name: balance
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `beAppliedAmount`
            field.
          in: query
          name: beAppliedAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `createdById`
            field.
          in: query
          name: createdById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `createdDate`
            field.
          in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            This parameter filters the response based on the `currency` field.
          in: query
          name: currency
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `debitMemoDate`
            field.
          in: query
          name: debitMemoDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `dueDate` field.
          in: query
          name: dueDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `number` field.
          in: query
          name: number
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `referredInvoiceId`
            field.
          in: query
          name: referredInvoiceId
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `status` field.
          in: query
          name: status
          required: false
          schema:
            enum:
              - Draft
              - Posted
              - Canceled
              - Error
              - PendingForTax
              - Generating
              - CancelInProgress
            type: string
        - description: |
            This parameter filters the response based on the `targetDate` field.
          in: query
          name: targetDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `taxAmount` field.
          in: query
          name: taxAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the
            `totalTaxExemptAmount` field.
          in: query
          name: totalTaxExemptAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `updatedById`
            field.
          in: query
          name: updatedById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedDate`
            field.
          in: query
          name: updatedDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by this
            field.

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            By default, the response data is displayed in descending order by
            debit memo number.


            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - number
              - accountId
              - debitMemoDate
              - targetDate
              - dueDate
              - amount
              - taxAmount
              - totalTaxExemptAmount
              - balance
              - beAppliedAmount
              - referredInvoiceId
              - createdDate
              - createdById
              - updatedDate
              - updatedById

              
            Examples:


            - /v1/debit-memos?sort=+number


            - /v1/debit-memos?status=Processed&sort=-number,+amount
          in: query
          name: sort
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    debitmemos:
                      - accountId: 402890555a7e9791015a7f15fe44001c
                        accountNumber: AN_1679649466484
                        amount: 50
                        autoPay: true
                        balance: 50
                        beAppliedAmount: 0
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: the comment
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 17:24:14'
                        currency: USD
                        debitMemoDate: '2017-10-17'
                        dueDate: '2017-11-16'
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        id: 402890555a87d7f5015a892f2ba10057
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: 402890555a87d7f5015a892f2c5c0060
                        number: DM00000006
                        paymentTerm: null
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredInvoiceId: null
                        sequenceSetId: null
                        sourceType: Standalone
                        status: Draft
                        targetDate: null
                        taxAmount: 0
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 17:24:14'
                      - accountId: 402890555a7d4022015a7dabf5f60088
                        accountNumber: AN_1679649466488
                        amount: 0.01
                        autoPay: true
                        balance: 0.01
                        beAppliedAmount: 0
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: the comment
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 17:13:15'
                        currency: USD
                        debitMemoDate: '2017-11-30'
                        dueDate: '2017-12-30'
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        id: 402890555a87d7f5015a89251edc0045
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: ac1ebc24569sd
                        number: DM00000003
                        paymentTerm: null
                        postedById: null
                        postedOn: null
                        reasonCode: Charge Dispute
                        referredInvoiceId: 402890555a7d4022015a7dadb3b300a4
                        sequenceSetId: null
                        sourceType: Standalone
                        status: Draft
                        targetDate: null
                        taxAmount: 0.01
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 17:13:15'
                      - accountId: 402890555a7d4022015a7dabf5f60088
                        accountNumber: AN_1679649466488
                        amount: 9
                        autoPay: true
                        balance: 9
                        beAppliedAmount: 0
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: ''
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 17:01:00'
                        currency: USD
                        debitMemoDate: '2017-03-01'
                        dueDate: '2017-03-31'
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        id: 402890555a87d7f5015a8919e4fe002e
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: 402890555a87d7f5015a8919e95d003a
                        number: DM00000002
                        paymentTerm: null
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredCreditMemoId: 1a2b3c4d5e6f
                        referredInvoiceId: 402890555a7d4022015a7dadb3b300a4
                        sequenceSetId: null
                        sourceType: Standalone
                        status: Draft
                        targetDate: null
                        taxAmount: 8
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 17:01:00'
                      - accountId: 402890555a7e9791015a7f15fe44001c
                        accountNumber: AN_1679649466684
                        amount: 8.02
                        autoPay: true
                        balance: 8.02
                        beAppliedAmount: 0
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: ''
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 10:26:16'
                        currency: USD
                        debitMemoDate: '2017-03-01'
                        dueDate: '2017-03-31'
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        id: 402890555a7e9791015a87b082940067
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: 402890555a7e9791015a87b083f00072
                        number: DM00000001
                        paymentTerm: null
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredCreditMemoId: 1a2b3c4d5e6f
                        referredInvoiceId: 402890555a7e9791015a7f1756aa0035
                        sequenceSetId: null
                        sourceType: Standalone
                        status: Draft
                        targetDate: null
                        taxAmount: 0.02
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 10:45:03'
                    success: true
              schema:
                $ref: '#/components/schemas/GETDebitMemoCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List debit memos
      tags:
        - Debit Memos
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Creates an ad-hoc debit memo from a product rate plan charge. Zuora
        supports the creation of debit memos from any type of product rate plan
        charge. The charges can also have any amount and any charge model,
        except for discout charge models.


        When debit memos are created from product rate plan charges, the
        specified amount with decimal places is now validated based on the
        decimal places supported by each currency.


        You can create a debit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
      operationId: POST_DebitMemoFromPrpc
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DebitMemoFromChargeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad093789169a0c001916e6be7cf7113
                    number: DM00000002
                    accountId: 8ad09be48db5aba7018db604776d4854
                    accountNumber: A00000097
                    debitMemoDate: '2024-08-19'
                    currency: USD
                    targetDate: null
                    dueDate: '2024-09-18'
                    postedOn: null
                    postedById: null
                    status: Draft
                    amount: 10
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    balance: 10
                    beAppliedAmount: 0
                    autoPay: true
                    comment: null
                    referredInvoiceId: null
                    transferredToAccounting: 'No'
                    reasonCode: Correcting invoice error
                    createdDate: '2024-08-19 23:14:11'
                    createdById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-08-19 23:14:11'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    cancelledOn: null
                    cancelledById: null
                    referredCreditMemoId: 1a2b3c4d5e6f
                    latestPDFFileId: ac1ebc24569sd
                    taxStatus: Complete
                    sourceType: Standalone
                    taxMessage: null
                    billToContactId: null
                    billToContactSnapshotId: null
                    paymentTerm: null
                    sequenceSetId: null
                    invoiceGroupNumber: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETDebitMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a debit memo from a charge
      tags:
        - Debit Memos
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Updates the due date for multiple debit memos in one single request. 


        This API operation will be deprecated. You can use the [Update debit
        memos](https://developer.zuora.com/api-references/api/operation/PUT_BulkUpdateDebitMemos)
        instead, which provides more flexible functionality.
      operationId: PUT_UpdateDebitMemosDueDates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTBatchDebitMemosRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update due dates for debit memos
      tags:
        - Debit Memos
  /v1/debit-memos/bulk:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Creates multiple debit memos from invoices or product rate plan charges.
        You can create a maximum of 50 debit memos in one single request. 


        - If you set the `sourceType` request field to `Invoice`, you can create
        multiple debit memos from invoices.

        - If you set the `sourceType` request field to `Standalone`, you can
        create multiple debit memos from product rate plan charges.


        The debit memos that are created are each in separate database
        transactions. If the creation of one debit memo fails, other debit memos
        can still be created successfully.


        You can create  debit memos only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
      operationId: POST_CreateDebitMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTBulkDebitMemosRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    memos:
                      - accountId: 4028ab1f87121698018712fef63e33cb
                        accountNumber: AN_Test11679650911374
                        amount: 100
                        autoPay: true
                        balance: 100
                        beAppliedAmount: 0
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: This is a comment
                        createdById: 3e2bcd869cea43eeb00d7a20cc1cb72b
                        createdDate: '2023-03-24 15:12:01'
                        currency: USD
                        debitMemoDate: '2023-03-24'
                        dueDate: '2023-03-24'
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        id: 4028ab1f87121698018712ff1b0633e2
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: ac1ebc24569sd
                        number: DM00000001
                        organizationLabel: MS US
                        paymentTerm: null
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredCreditMemoId: 1a2b3c4d5e6f
                        referredInvoiceId: null
                        sequenceSetId: null
                        sourceType: Standalone
                        status: Draft
                        success: true
                        targetDate: null
                        taxAmount: 0
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        updatedById: 3e2bcd869cea43eeb00d7a20cc1cb72b
                        updatedDate: '2023-03-24 15:12:01'
                      - objectIndex: 1
                        processId: 0356073CB721291A
                        reasons:
                          - code: 50000040
                            message: Cannot find a Invoice instance with id test.
                        success: false
                    success: true
              schema:
                $ref: '#/components/schemas/BulkDebitMemosResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create debit memos
      tags:
        - Debit Memos
    put:
      description: >
        **Notes:** 

        - This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.

        - You can update debit memos only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        Updates the basic and finance information about multiple debit memos.
        You can update a maximum of 50 credit memos in one single request. 


        Currently, Zuora supports updating tax-exclusive memo items, but does
        not support updating tax-inclusive memo items. If the amount of a memo
        item is updated, the tax will be recalculated in the following
        conditions:

        - The memo is created from a product rate plan charge and you use
        Avalara to calculate the tax.

        - The memo is created from an invoice and you use Avalara or Zuora Tax
        to calculate the tax.


        The [Edit credit and debit
        memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API)
        tutorial demonstrates how to use this operation to add and delete memo
        items.


        The credit memos that are updated are each in separate database
        transactions. If the update of one debit memo fails, other debit memos
        can still be updated successfully.
      operationId: PUT_UpdateDebitMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTBulkDebitMemosRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    memos:
                      - accountId: 4028ab1f87121698018726851cc765ee
                        accountNumber: AN_Test11679978470016
                        amount: 100
                        autoPay: true
                        balance: 100
                        beAppliedAmount: 0
                        billToContactId: null
                        billToContactSnapshotId: null
                        cancelledById: null
                        cancelledOn: null
                        comment: new comment123
                        createdById: aff81dbb5dd846868685592640363b5b
                        createdDate: '2023-03-28 10:11:45'
                        currency: USD
                        debitMemoDate: '2023-03-27'
                        dueDate: '2023-03-27'
                        einvoiceErrorCode: null
                        einvoiceErrorMessage: null
                        einvoiceFileId: null
                        einvoiceStatus: Processing
                        id: 4028ab1f8712169801872685a5f46605
                        invoiceGroupNumber: N-0001
                        latestPDFFileId: ac1ebc24569sd
                        number: DM00000001
                        organizationLabel: MS US
                        paymentTerm: null
                        postedById: null
                        postedOn: null
                        reasonCode: Correcting invoice error
                        referredCreditMemoId: 1a2b3c4d5e6f
                        referredInvoiceId: null
                        sequenceSetId: null
                        sourceType: Standalone
                        status: Draft
                        success: true
                        targetDate: null
                        taxAmount: 0
                        taxMessage: null
                        taxStatus: Complete
                        totalTaxExemptAmount: 0
                        transferredToAccounting: 'No'
                        updatedById: aff81dbb5dd846868685592640363b5b
                        updatedDate: '2023-03-28 10:12:37'
                      - id: 2c98907562482a8301624b9c0a1a0056
                        objectIndex: 1
                        processId: string
                        reasons:
                          - code: string
                            message: string
                        success: false
                    success: true
              schema:
                $ref: '#/components/schemas/BulkDebitMemosResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update debit memos
      tags:
        - Debit Memos
  /v1/debit-memos/pdf-status:
    get:
      description: |
        Retrieves the PDF generation statuses of a batch of debit memos.
      operationId: Get_DebitMemoPdfStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >-
            The IDs or numbers of the debit memos separated by commas. For
            example -
            `?debitMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,DM0000001`.
            A maximum of 50 keys can be entered in this field. 
          in: query
          name: debitMemoKeys
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                debitMemoFiles:
                  - debitMemoId: 402824aa8cc894d5018cc8a120576881
                    debitMemoNumber: DM00000003
                    pdfGenerationStatus: Generated
                    createdOn: '2024-01-01 11:32:19'
                    updatedOn: '2024-01-01 11:32:19'
                    pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
                  - debitMemoId: 2c98908a904dfc2601904e6e14090241
                    debitMemoNumber: DM00000004
                    pdfGenerationStatus: Error
                    createdOn: '2024-01-02 10:14:13'
                    updatedOn: '2024-01-02 10:14:13'
                    errorCode: INVALID_TEMPLATE
                    errorMessage: Unknown merge filed chargeNumber__c
                  - debitMemoId: 623935cc6ee105f7341ee1d453809214
                    debitMemoNumber: DM00000005
                    pdfGenerationStatus: Pending
                    createdOn: '2024-01-01 11:35:56'
                    updatedOn: '2024-01-01 11:35:56'
                success: true
              schema:
                $ref: '#/components/schemas/GetDebitMemoPdfStatusBatchResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '50000020'
                    message: Credit memo key is required
                success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              example:
                message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            WWW-Authenticate:
              description: >-
                The value of this header is: ``` Basic realm=Zuora API, ZSession
                realm=Zuora API, Bearer realm=Zuora API ``` 
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve the PDF file generation status of debit memos
      tags:
        - Debit Memos
      x-accepts: application/json
  /v1/debit-memos/{debitMemoId}/application-parts:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves information about the payments or credit memos that are
        applied to a specified debit memo. 


        If you use the Zuora version 341.0 or a [later available
        version](https://developer.zuora.com/v1-api-reference/api-versions/),
        this operation will return only processed payments applied to the debit
        memos. For Zuora versions earlier than 341.0,  it returns all payments
        associated with the debit memo regardless of the payment status.
      operationId: GET_DebitMemoApplicationParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e.
          in: path
          name: debitMemoId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    applicationParts:
                      - appliedAmount: 22
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2018-01-02 11:42:16'
                        creditMemoId: 4028905f60a165a50160b4f632ff023d
                        paymentId: null
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2018-01-02 11:42:16'
                      - appliedAmount: 11
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2018-01-02 11:41:38'
                        creditMemoId: null
                        paymentId: 4028905f60a165a50160b4f5d5cb0229
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2018-01-02 11:41:38'
                    success: true
              schema:
                $ref: '#/components/schemas/GetDebitMemoApplicationPartCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all application parts of a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Retrieves information about the taxation items of a specific debit memo
        item.
      operationId: GET_TaxationItemsOfDebitMemoItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: >
            The unique ID of a debit memo item. You can get the debit memo item
            ID from the response of [List debit memo
            items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems).
          in: path
          name: dmitemid
          required: true
          schema:
            type: string
        - description: >
            The unique ID of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e.
          in: path
          name: debitMemoId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - balance: 10
                        creditAmount: 0
                        exemptAmount: 10
                        financeInformation:
                          salesTaxPayableAccountingCode: Check
                          salesTaxPayableAccountingCodeType: Cash
                        id: 402883836904567d01690530df760231
                        jurisdiction: Jurisdiction
                        locationCode: '8'
                        name: taxName_0
                        paymentAmount: 0
                        sourceTaxItemId: null
                        taxAmount: 10
                        taxCode: taxCode
                        taxCodeDescription: taxCodeDescription
                        taxDate: '2016-10-10'
                        taxRate: 0.1
                        taxRateDescription: taxRateDescription
                        taxRateType: Percentage
                    success: true
              schema:
                $ref: '#/components/schemas/GETTaxationItemsOfDebitMemoItemType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.        
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all taxation items of a debit memo item
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}:
    delete:
      description: >-
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Deletes a debit memo. Only debit memos with the Cancelled status can be
        deleted. 


        You can delete a debit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
          The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items.
      operationId: DELETE_DebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000003.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a debit memo
      tags:
        - Debit Memos
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about a specific debit memo.
      operationId: GET_DebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028ab1f87121698018722ff25be58a1
                    accountNumber: AN_Test11679919358984
                    amount: 100
                    autoPay: true
                    balance: 100
                    beAppliedAmount: 0
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: null
                    cancelledOn: null
                    comment: This is a comment
                    createdById: 0124a1a5d0f84d4288d875fc3b34b1e1
                    createdDate: '2023-03-27 17:46:01'
                    currency: USD
                    debitMemoDate: '2023-03-27'
                    dueDate: '2023-03-27'
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    id: 4028ab1f87121698018722ff2bff58b8
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: ac1ebc24569sd
                    number: DM00000001
                    organizationLabel: MS US
                    paymentTerm: null
                    postedById: null
                    postedOn: null
                    reasonCode: Correcting invoice error
                    referredCreditMemoId: 1a2b3c4d5e6f
                    referredInvoiceId: null
                    sequenceSetId: null
                    sourceType: Standalone
                    status: Draft
                    success: true
                    targetDate: null
                    taxAmount: 0
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    updatedById: 0124a1a5d0f84d4288d875fc3b34b1e1
                    updatedDate: '2023-03-27 17:46:01'
              schema:
                $ref: '#/components/schemas/GETDebitMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a debit memo
      tags:
        - Debit Memos
    put:
      description: >
        **Notes:** 

        - This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 

        - You can update a debit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        Updates the basic and finance information about a debit memo. 



        Currently, Zuora supports updating tax-exclusive memo items, but does
        not support updating tax-inclusive memo items. If the amount of a memo
        item is updated, the tax will be recalculated in the following
        conditions:

        - The memo is created from a product rate plan charge and you use
        Avalara to calculate the tax.

        - The memo is created from an invoice and you use Avalara or Zuora Tax
        to calculate the tax.


        The [Edit credit and debit
        memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API)
        tutorial demonstrates how to use this operation to add and delete memo
        items.
      operationId: PUT_DebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTDebitMemoType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028ab1f87121698018722f82d133fe4
                    accountNumber: AN_Test11679918902100
                    amount: 100
                    autoPay: true
                    balance: 100
                    beAppliedAmount: 0
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: null
                    cancelledOn: null
                    comment: Details about this Debit Memo
                    createdById: 97e12d40f0ab4418a95a93118b272fb6
                    createdDate: '2023-03-27 17:38:24'
                    currency: USD
                    debitMemoDate: '2023-03-27'
                    dueDate: '2023-03-27'
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    id: 4028ab1f87121698018722f8335b3ffb
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: ac1ebc24569sd
                    number: DM00000001
                    organizationLabel: MS US
                    paymentTerm: null
                    postedById: null
                    postedOn: null
                    reasonCode: Correcting invoice error
                    referredCreditMemoId: 1a2b3c4d5e6f
                    referredInvoiceId: null
                    sequenceSetId: null
                    sourceType: Standalone
                    status: Draft
                    success: true
                    targetDate: null
                    taxAmount: 0
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    updatedById: 97e12d40f0ab4418a95a93118b272fb6
                    updatedDate: '2023-03-27 17:38:27'
              schema:
                $ref: '#/components/schemas/GETDebitMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/cancel:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Cancels a debit memo. Only debit memos with the Draft status can be
        cancelled. 


        You can cancel a debit memo only if you have the user permission. See
        [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
      operationId: PUT_CancelDebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000003.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028ab1f87121698018722fd2e705066
                    accountNumber: AN_Test11679919230033
                    amount: 100
                    autoPay: true
                    balance: 100
                    beAppliedAmount: 0
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: bc0211e8ca1440eb97a0aff808f87293
                    cancelledOn: '2023-03-27 17:43:59'
                    comment: This is a comment
                    createdById: bc0211e8ca1440eb97a0aff808f87293
                    createdDate: '2023-03-27 17:43:52'
                    currency: USD
                    debitMemoDate: '2023-03-27'
                    dueDate: '2023-03-27'
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    id: 4028ab1f87121698018722fd34c6507d
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: 4028ab1f87121698018722fd39fe5087
                    number: DM00000001
                    organizationLabel: MS US
                    paymentTerm: null
                    postedById: null
                    postedOn: null
                    reasonCode: Correcting invoice error
                    referredCreditMemoId: 1a2b3c4d5e6f
                    referredInvoiceId: null
                    sequenceSetId: null
                    sourceType: Standalone
                    status: Canceled
                    success: true
                    targetDate: null
                    taxAmount: 0
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    updatedById: bc0211e8ca1440eb97a0aff808f87293
                    updatedDate: '2023-03-27 17:43:59'
              schema:
                $ref: '#/components/schemas/GETDebitMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/collect:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        This API operation provides an easy way to let the client-side to
        collect an existing posted debit memo.

        It supports the following steps:
          1. Apply unapplied credit memos to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied credit memos.
          2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments.
          3. Process payment to the posted debit memo if there is an open-balance on it.

        **Restrictions**


        Since this API will do lots of works, and some of them are resource
        consuming, we need to restrict the usage of this API by the following
        conditions:
          1. If the target debit memo gets more than 10 debit memo items, the request will be rejected.
          2. If `CreditMemo` is specified in `applicationOrder`, when there are more than 25 credit memos will be used to apply to the debit memo, the request will be rejected.
          3. If `CreditMemo` is specified in `applicationOrder`, when there are more than 100 credit memo items will be used to apply to the debit memo, the request will be rejected.
          4. If `UnappliedPayment` is specified in `applicationOrder`, when there are more than 25 payments will be used to apply to the debit memo, the request will be rejected.
      operationId: POST_DebitMemoCollect
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of a posted debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DebitMemoCollectRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    debitMemo:
                      id: 8ad0912492f64b9001931936cac36351
                      number: DM00000001
                    appliedCreditMemos: []
                    appliedPayments: []
                    processedPayment:
                      id: 8ad0869992f632860193249dfe1a0ead
                      number: P-00001541
                      status: Processed
                      amount: 10
                      paymentMethodId: 8ad09bce83f1da020183f97e24821c4b
                      gatewayId: 8ad095dd813e750f0181461a8e350ce7
                      gatewayResponse: This transaction has been approved by the gateway.
                      gatewayResponseCode: approve
                    success: true
              schema:
                $ref: '#/components/schemas/DebitMemoCollectResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Collect a posted debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/emails:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Sends a posted debit memo to the specified email addresses manually.




        ### Notes
          - You must activate the **Email Debit Memo | Manually email Debit Memo** notification before emailing debit memos. To include the debit memo PDF in the email, select the **Include Debit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.


          - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Debit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.


          - The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:

            * The `useEmailTemplateSetting` field is set to `false`.
            * The email addresses are not specified in the `emailAddresses` field.
      operationId: POST_EmailDebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of a posted debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDebitMemoEmailType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Email a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/files:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Uploads an externally generated PDF file for a debit memo that is in
        Draft or Posted status.


        To use this operation, you must enable the Modify Debit Memo permission.
        See [Billing
        Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.


        This operation has the following restrictions:

        - Only the PDF file format is supported.

        - The maximum size of the PDF file to upload is 4 MB.

        - A maximum of 50 PDF files can be uploaded for one debit memo.
      operationId: POST_UploadFileForDebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The ID or number of the debit memo that you want to upload a PDF
            file for. For example, 402890555a87d7f5015a8919e4fe002e or
            DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: |
                    The PDF file to upload for the debit memo.
                  format: binary
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fileId: 40289f466463d683016463ef8b7301a3
                    success: true
              schema:
                $ref: '#/components/schemas/POSTUploadFileResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Upload a file for a debit memo
      tags:
        - Debit Memos
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1" -F "file=@DebitMemoFile.pdf"
            "https://rest.zuora.com/v1/debit-memos/402890555a87d7f5015a8919e4fe002e/files"
    get:
      description: >
        Retrieves the information about all PDF files of a specified debit
        memo. 


        Debit Memo PDF files are returned in reverse chronological order by the
        value of the `versionNumber` field.

        **Note**: This API only retrieves the PDF files that have been
        generated. If the latest PDF file is being generated, it will not be
        included in the response.
      operationId: GET_DebitMemoFiles
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: >
            The unique ID or number of an debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    debitMemoFiles:
                      - id: 8a90a24f8e128020018e12ebcd010470
                        pdfFileUrl: /v1/files/8a90a24f8e128020018e12ebccfa046f
                        versionNumber: 1709714426109
                      - id: 8a90b5148c6d127b018c6d1e46160230
                        pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e4610022f
                        versionNumber: 1702637741618
                    success: true
              schema:
                $ref: '#/components/schemas/GETDebitMemoFilesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all files of a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/items:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all items of a debit memo. A debit memo
        item is a single line item in a debit memo. 


        ### Filtering


        You can use query parameters to restrict the data returned in the
        response. Each query parameter corresponds to one field in the response
        body.


        If the value of a filterable field is string, you can set the
        corresponding query parameter to `null` when filtering. Then, you can
        get the response data with this field value being `null`. 


        Examples:


        - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100


        -
        /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate
      operationId: GET_DebitMemoItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: |
            This parameter filters the response based on the `amount` field.
          in: query
          name: amount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `beAppliedAmount`
            field.
          in: query
          name: beAppliedAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `createdById`
            field.
          in: query
          name: createdById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `createdDate`
            field.
          in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            This parameter filters the response based on the `id` field.
          in: query
          name: id
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `serviceEndDate`
            field.
          in: query
          name: serviceEndDate
          required: false
          schema:
            format: date
            type: string
        - description: >
            This parameter filters the response based on the `serviceStartDate`
            field.
          in: query
          name: serviceStartDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `sku` field.
          in: query
          name: sku
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `skuName` field.
          in: query
          name: skuName
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `sourceItemId`
            field.
          in: query
          name: sourceItemId
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `subscriptionId`
            field.
          in: query
          name: subscriptionId
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedById`
            field.
          in: query
          name: updatedById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedDate`
            field.
          in: query
          name: updatedDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by this
            field.

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            By default, the response data is displayed in descending order by
            updated date.


            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - id
              - amount
              - beAppliedAmount
              - sku
              - skuName
              - serviceStartDate
              - serviceEndDate
              - sourceItemId
              - createdDate
              - createdById
              - updatedDate
              - updatedById
              - subscriptionId

              
            Examples:


            -
            /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate


            -
            /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate
          in: query
          name: sort
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    items:
                      - amount: 1
                        amountWithoutTax: 1
                        appliedToItemId: 402890555a7d4022015a2dadb3b700a6
                        balance: 1
                        beAppliedAmount: 0
                        comment: This is comment!
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 17:13:15'
                        excludeItemBillingFromRevenueAccounting: true
                        financeInformation:
                          deferredRevenueAccountingCode: Subscription Revenue
                          deferredRevenueAccountingCodeType: SalesRevenue
                          recognizedRevenueAccountingCode: Subscription Revenue
                          recognizedRevenueAccountingCodeType: SalesRevenue
                        id: 402890555a87d7f5015a89251ede0046
                        processingType: Charge
                        quantity: 1
                        serviceEndDate: '2017-11-30'
                        serviceStartDate: '2017-11-01'
                        sku: SKU-00000002
                        skuName: SKU-30
                        soldToContactId: 402881e522cf4f9b0122cf5d82860003
                        soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                        sourceItemId: 402890555a7d4022015a7dadb3b700a6
                        sourceItemType: InvoiceDetail
                        subscriptionId: null
                        taxMode: TaxExclusive
                        taxationItems:
                          data:
                            - balance: 0.01
                              creditAmount: 0
                              exemptAmount: 0
                              financeInformation:
                                salesTaxPayableAccountingCode: Check
                                salesTaxPayableAccountingCodeType: Cash
                              id: 402890555a87d7f5015a89251ef10047
                              jurisdiction: CALIFORNIA
                              locationCode: '06'
                              name: STATE TAX
                              paymentAmount: 0
                              sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1
                              taxAmount: 0.01
                              taxCode: ZtaxCode
                              taxCodeDescription: ''
                              taxDate: '2017-11-30'
                              taxRate: 0.0625
                              taxRateDescription: This is tax rate description!
                              taxRateType: Percentage
                        unitOfMeasure: Each
                        unitPrice: 1
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 17:13:15'
                    success: true
              schema:
                $ref: '#/components/schemas/GETDebitMemoItemCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List debit memo items
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/items/{dmitemid}:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Retrieves information about a specific item of a debit memo. A debit
        memo item is a single line item in a debit memo.
      operationId: GET_DebitMemoItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a debit memo item. You can get the debit memo item
            ID from the response of [List debit memo
            items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems).
          in: path
          name: dmitemid
          required: true
          schema:
            type: string
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 1
                    amountWithoutTax: 1
                    appliedToItemId: 402890555a7d4022015a2dadb3b700a6
                    balance: 1
                    beAppliedAmount: 0
                    comment: aa
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 17:01:00'
                    excludeItemBillingFromRevenueAccounting: true
                    financeInformation:
                      deferredRevenueAccountingCode: Subscription Revenue
                      deferredRevenueAccountingCodeType: SalesRevenue
                      recognizedRevenueAccountingCode: Subscription Revenue
                      recognizedRevenueAccountingCodeType: SalesRevenue
                    id: 402890555a87d7f5015a8919e500002f
                    processingType: Charge
                    quantity: 1
                    serviceEndDate: '2017-03-26'
                    serviceStartDate: '2017-02-27'
                    sku: SKU-00000002
                    skuName: ZTax Component
                    soldToContactId: 402881e522cf4f9b0122cf5d82860003
                    soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                    sourceItemId: 402890555a7d4022015a7dadb3b700a6
                    sourceItemType: InvoiceDetail
                    subscriptionId: null
                    success: true
                    taxMode: TaxExclusive
                    taxationItems:
                      data:
                        - balance: 5
                          creditAmount: 0
                          exemptAmount: 0
                          financeInformation:
                            salesTaxPayableAccountingCode: Check
                            salesTaxPayableAccountingCodeType: Cash
                          id: 402890555a87d7f5015a8919e8450031
                          jurisdiction: USA
                          locationCode: ''
                          name: my tax
                          paymentAmount: 0
                          sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1
                          taxAmount: 5
                          taxCode: ZtaxCode
                          taxCodeDescription: ''
                          taxDate: '2017-02-27'
                          taxRate: 5
                          taxRateDescription: desc3
                          taxRateType: FlatFee
                    unitOfMeasure: Each
                    unitPrice: 1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 17:01:00'
              schema:
                $ref: '#/components/schemas/GETDebitMemoItemType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a debit memo item
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/pdfs:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Creates a PDF file for a specified debit memo. To access the generated
        PDF file, you can download it by clicking **View PDF** on the detailed
        debit memo page through the Zuora UI.


        This REST API operation can be used only if you have the billing
        document file generation feature and the Billing user permission
        "Regenerate PDF" enabled.
      operationId: POST_DebitMemoPDF
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the debit memo that you want to create a
            PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or
            DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/POSTMemoPdfResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate a debit memo PDF file
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/post:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Posts a debit memo to activate it. You can post debit memos only if you
        have the [Billing
        permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).
      operationId: PUT_PostDebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028ab1f87121698018722fa86dc4823
                    accountNumber: AN_Test11679919056161
                    amount: 100
                    autoPay: true
                    balance: 100
                    beAppliedAmount: 0
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: null
                    cancelledOn: null
                    comment: This is a comment
                    createdById: e758a64e80f54439913241f9aa537127
                    createdDate: '2023-03-27 17:40:58'
                    currency: USD
                    debitMemoDate: '2023-03-27'
                    dueDate: '2023-03-27'
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    id: 4028ab1f87121698018722fa8d73483a
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: ac1ebc24569sd
                    number: DM00000001
                    organizationLabel: MS US
                    paymentTerm: null
                    postedById: e758a64e80f54439913241f9aa537127
                    postedOn: '2023-03-27 17:41:03'
                    reasonCode: Correcting invoice error
                    referredCreditMemoId: 1a2b3c4d5e6f
                    referredInvoiceId: null
                    sequenceSetId: null
                    sourceType: Standalone
                    status: Posted
                    success: true
                    targetDate: null
                    taxAmount: 0
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    updatedById: e758a64e80f54439913241f9aa537127
                    updatedDate: '2023-03-27 17:41:03'
              schema:
                $ref: '#/components/schemas/GETDebitMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Post a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/taxation-items:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Creates taxation items for a debit memo.
      operationId: POST_DM_TaxationItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTTaxationItemListForDMType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    taxationItems:
                      - createdById: 8ad084a67f9c7138017fab8a8b511b5a
                        createdDate: '2024-11-18 11:32:56'
                        exemptAmount: 0
                        id: 8ad0980c93300db701933d549f355262
                        memoItemId: 8ad093f793300daf01933d50a548781f
                        invoiceItemId: null
                        sourceTaxItemId: null
                        jurisdiction: CALIFORNIA
                        locationCode: null
                        name: STATE TAX
                        taxAmount: 0.5
                        applicableTaxUnRounded: 0.5
                        country: null
                        taxCode: ServiceTaxCode
                        taxCodeDescription: null
                        taxDate: '2024-11-18'
                        taxRate: 0.05
                        taxMode: TaxExclusive
                        taxRateDescription: null
                        taxRateType: Percentage
                        updatedById: 8ad084a67f9c7138017fab8a8b511b5a
                        updatedDate: '2024-11-18 11:32:56'
                        financeInformation:
                          onAccountAccountingCode: null
                          onAccountAccountingCodeType: null
                          salesTaxPayableAccountingCode: Sales Tax Payable
                          salesTaxPayableAccountingCodeType: SalesTaxPayable
                          accountsReceivableAccountingCode: Accounts Receivable
                          accountsReceivableAccountingCodeType: AccountsReceivable
                    success: true
              schema:
                $ref: '#/components/schemas/GETTaxationItemListType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create taxation items for a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/unpost:
    put:
      description: >-
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Unposts a debit memo that is in Posted status. If any credit memo or
        payment has been applied to a debit memo, you are not allowed to unpost
        the debit memo. After a debit memo is unposted, its status becomes
        Draft.


        You can unpost debit memos only if you have the [Billing
        permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). 


        You can prevent  an unpost operation by configuring the  'Do not allow
        unposting invoices and memos if their revenue is already recognized in a
        closed accounting period' accounting  rule. The default value of this
        rule is set to 'disabled.' 

         For more information,  see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period).
      operationId: PUT_UnpostDebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a debit memo. For example,
            8a8082e65b27f6c3015ba419f3c2644e or DM00000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028ab1f87121698018722f3af193744
                    accountNumber: AN_Test11679918607694
                    amount: 100
                    autoPay: true
                    balance: 100
                    beAppliedAmount: 0
                    billToContactId: null
                    billToContactSnapshotId: null
                    cancelledById: null
                    cancelledOn: null
                    comment: This is a comment
                    createdById: c24f12918d5b45d0b7f9da297b8b7a9d
                    createdDate: '2023-03-27 17:33:29'
                    currency: USD
                    debitMemoDate: '2023-03-27'
                    dueDate: '2023-03-27'
                    einvoiceErrorCode: null
                    einvoiceErrorMessage: null
                    einvoiceFileId: null
                    einvoiceStatus: Processing
                    id: 4028ab1f87121698018722f3b60c375b
                    invoiceGroupNumber: N-0001
                    latestPDFFileId: 4028ab1f87121698018722f3bb0b376b
                    number: DM00000001
                    organizationLabel: MS US
                    paymentTerm: null
                    postedById: null
                    postedOn: null
                    reasonCode: Correcting invoice error
                    referredCreditMemoId: 1a2b3c4d5e6f
                    referredInvoiceId: null
                    sequenceSetId: null
                    sourceType: Standalone
                    status: Draft
                    success: true
                    targetDate: null
                    taxAmount: 0
                    taxMessage: null
                    taxStatus: Complete
                    totalTaxExemptAmount: 0
                    transferredToAccounting: 'No'
                    updatedById: c24f12918d5b45d0b7f9da297b8b7a9d
                    updatedDate: '2023-03-27 17:33:42'
              schema:
                $ref: '#/components/schemas/GETDebitMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Unpost a debit memo
      tags:
        - Debit Memos
  /v1/debit-memos/invoice/{invoiceKey}:
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Creates an ad-hoc debit memo from an invoice.


        You can create a debit memo from an invoice only if you have the user
        permission. See [Billing
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)
        for more information.
      operationId: POST_DebitMemoFromInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of an invoice that you want to create a debit memo
            from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DebitMemoFromInvoiceRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90a19d9310bb3c0193197cb4700501
                    number: DM00000045
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    accountNumber: A00000370
                    debitMemoDate: '2024-11-11'
                    currency: USD
                    targetDate: null
                    dueDate: '2024-12-11'
                    postedOn: null
                    postedById: null
                    status: Draft
                    amount: 10
                    taxAmount: 0
                    totalTaxExemptAmount: 0
                    balance: 10
                    beAppliedAmount: 0
                    autoPay: true
                    comment: null
                    referredInvoiceId: 8a90cc5c9301541f01930186636b1400
                    transferredToAccounting: false
                    reasonCode: Correcting invoice error
                    createdDate: '2024-11-11 12:30:23'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-11-11 12:30:23'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    cancelledOn: null
                    cancelledById: null
                    referredCreditMemoId: null
                    latestPDFFileId: null
                    taxStatus: null
                    sourceType: Invoice
                    taxMessage: null
                    billToContactId: 8a90b4488e7d5c0f018e7db3896100b4
                    billToContactSnapshotId: null
                    soldToContactId: null
                    soldToContactSnapshotId: null
                    paymentTerm: Net 30
                    eInvoiceStatus: null
                    eInvoiceErrorCode: null
                    eInvoiceErrorMessage: null
                    eInvoiceFileId: null
                    sequenceSetId: acd16fac492111e9a0d70cc47a32b062
                    invoiceGroupNumber: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETDebitMemoType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a debit memo from an invoice
      tags:
        - Debit Memos
  /v1/debit-memos/{debitMemoKey}/write-off:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Writes off a debit memo. 


        By writing off a debit memo,  a credit memo is automatically created and
        applied to the debit memo. The generated  credit memo items and credit
        memo taxation items are applied to the corresponding  debit memo items
        and debit memo taxation items respectively.


        **Note**: 

        * This API operation  is available only if you have enabled the enhanced
        write-off permission for your tenant.  Contact <a
        href="http://support.zuora.com/" target="_blank">Zuora Global
        Support</a>  to enable this permission.

        * The total amount must be equal to the amount entered at the invoice
        item level.

        * If the non revenue impact value  is set to Yes, then the non revenue
        write off accounting code must be specified.
      operationId: PUT_WriteOffDebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTWriteOffDebitMemoRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    creditMemo:
                      id: 402890555a40ca7f015a5b099b0e307a
                    success: true
              schema:
                $ref: '#/components/schemas/PUTWriteOffDebitMemoResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Write off a debit memo
      tags:
        - Debit Memos
  /v1/einvoice/service-providers:
    get:
      description: >
        Lists information about e-invoicing service providers.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: GET_EInvoicingServiceProviders
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    serviceProviders:
                      - id: 4028948972a2bf990172bc9b27724eef
                        name: Sovos e-invoice service
                        provider: Sovos
                        serviceProviderNumber: EISP-00000001
                        test: 'false'
                        companyIdentifier: CompanySample1
              schema:
                $ref: '#/components/schemas/ListEInvoicingServiceProvidersResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List e-invoicing service providers
      tags:
        - E-Invoicing
    post:
      description: >
        Creates an e-invoicing service provider.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: POST_EInvoicingServiceProvider
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEInvoicingServiceProviderRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 4028948972a2bf990172bc9b27724eef
                    name: Sovos e-invoice service
                    provider: Sovos
                    serviceProviderNumber: EISP-00000001
                    test: 'false'
                    companyIdentifier: CompanySample1
                    apiKey: SampleApiKey
                    use_certificate: false
                    clientCertificate: U3dhZ2dlciByb2Nrcw==
                    clientCertificateType: PKCS12
              schema:
                $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an e-invoicing service provider
      tags:
        - E-Invoicing
  /v1/einvoice/service-providers/{key}:
    delete:
      description: >
        Deletes an e-invoicing service privider.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: DELETE_EInvoicingServiceProvider
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the e-invoicing service provider that you
            want to 
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an e-invoicing service provider
      tags:
        - E-Invoicing
    get:
      description: >
        Retrieves information about an e-invoicing service privider.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: GET_EInvoicingServiceProvider
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the e-invoicing service provider that you
            want to retrieve information about.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 4028948972a2bf990172bc9b27724eef
                    name: Sovos e-invoice service
                    provider: Sovos
                    serviceProviderNumber: EISP-00000001
                    test: 'false'
                    companyIdentifier: CompanySample1
              schema:
                $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an e-invoicing service provider
      tags:
        - E-Invoicing
    put:
      description: >
        Updates information about an e-invoicing service privider.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: PUT_UpdateEInvoicingServiceProvider
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the e-invoicing service provider that you
            want to update.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEInvoicingServiceProviderRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 4028948972a2bf990172bc9b27724eef
                    name: Sovos e-invoice service
                    provider: Sovos
                    serviceProviderNumber: EISP-00000001
                    test: 'true'
                    companyIdentifier: CompanySample1
                    apiKey: SampleApiKey
                    use_certificate: false
                    clientCertificate: U3dhZ2dlciByb2Nrcw==
                    clientCertificateType: PKCS12
              schema:
                $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an e-invoicing service provider
      tags:
        - E-Invoicing
  /v1/einvoice/business-regions:
    get:
      description: >
        Lists information about e-invoicing business regions.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: GET_EInvoicingBusinessRegions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    regions:
                      - id: 8ad083528ee62fe1018eea6c5dd11e01
                        country: AU
                        businessName: Avalara Inc.
                        businessNumber: '74004085818'
                        businessNumberSchemeId: '0151'
                        tradeName: Test trade
                        endpointId: '74004085818'
                        endpointSchemeId: '0151'
                        taxRegisterNumber: '1577240348'
                        state: ''
                        city: ''
                        postalCode: ''
                        addressLine1: ''
                        addressLine2: ''
                        contactName: ''
                        phoneNumber: ''
                        email: ''
                        serviceProviderId: 8ad093788ea359ca018ea75fb12a6348
                        businessRegionNumber: EIBR-00000010
                        digitalSignatureEnable: 'false'
                        digitalSignatureBoxEnable: 'false'
                        digitalSignatureBoxPosX: '0'
                        digitalSignatureBoxPosY: '0'
                        responseMapping: '{}'
                        processType: PEPPOLNetwork
                        invoiceEnabled: 'true'
                        creditMemoEnabled: 'true'
                        debitMemoEnabled: 'true'
                        invoiceFilters: 'null'
                        creditMemoFilters: 'null'
                        debitMemoFilters: 'null'
                        fileFormat:
                          B2B:
                            - XML
                          B2C:
                            - ''
                          B2G:
                            - XML
                      - id: 8ad081dd8f7c5447018f7fdff3a75823
                        country: BR
                        businessName: Seller business name
                        businessNumber: '02593165000140'
                        businessNumberSchemeId: ''
                        tradeName: Seller trade name
                        endpointId: Seller end point id 08992
                        endpointSchemeId: '099'
                        taxRegisterNumber: TAX393982838
                        state: ''
                        city: ''
                        postalCode: '1'
                        addressLine1: ''
                        addressLine2: ''
                        contactName: ''
                        phoneNumber: ''
                        email: ''
                        serviceProviderId: 8ad097b4905a5adf01907433df216e37
                        businessRegionNumber: EIBR-00000012
                        digitalSignatureEnable: false
                        digitalSignatureBoxEnable: false
                        digitalSignatureBoxPosX: 0
                        digitalSignatureBoxPosY: 0
                        responseMapping: {}
                        processType: ClearanceWithCancellation
                        invoiceEnabled: true
                        creditMemoEnabled: false
                        debitMemoEnabled: false
                        invoiceFilters: null
                        creditMemoFilters: null
                        debitMemoFilters: null
                        fileFormat: null
                    success: true
              schema:
                $ref: '#/components/schemas/ListEInvoicingBusinessRegionsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List e-invoicing business regions
      tags:
        - E-Invoicing
    post:
      description: >
        Creates an e-invoicing business region.


        You must create business regions to store the business detail
        information as a seller. If you have multiple GSTINs for different
        states, you can create multiple business region objects for India.


        The business region objects can be looked up according to the country
        and state, and its related fields can be mapped accordingly within the
        e-invoice file template.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: POST_CreateEInvoicingBusinessRegion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEInvoicingBusinessRegionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    addressLine1: ''
                    addressLine2: ''
                    businessName: legal business name
                    businessNumber: '20002039'
                    businessNumberSchemaId: '88'
                    businessRegionNumber: EIBR-00000002
                    city: Tokyo
                    contactName: ''
                    country: JP
                    digitalSignatureEnable: false
                    digitalSignatureBoxEnable: false
                    digitalSignatureBoxPosX: 0
                    digitalSignatureBoxPosY: 0
                    email: ''
                    id: 4028b2aa8890c524018890c7e9ef3826
                    invoiceFilters:
                      - objectType: Invoice
                        condition:
                          field: SoldToContact.Country
                          operator: eq
                          value: India
                    phoneNumber: ''
                    postalCode: '368779'
                    responseMapping: {}
                    serviceProviderId: 4028948972a2bf990172bc9b27724ddc
                    state: ''
                    taxRegisterNumber: TAX393999
                    tradeName: Zuora
                    fileFormat:
                      B2B:
                        - XML
                      B2C:
                        - ''
                      B2G:
                        - XML
              schema:
                $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an e-invoicing business region
      tags:
        - E-Invoicing
  /v1/einvoice/business-regions/{key}:
    delete:
      description: >
        Deletes an e-invoicing business region by key. The key can be the unique
        ID or number of an e-invoicing business region.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: DELETE_EInvoicingBusinessRegion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unqiue ID or number of the e-invoicing business region that you
            want to delete.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an e-invoicing business region
      tags:
        - E-Invoicing
    get:
      description: >
        Retrieves information about an e-invoicing business region.


        You can search for an e-invoicing business region by key. The key can be
        the unique ID or number of an e-invoicing business region.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: GET_EInvoicingBusinessRegion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unqiue ID or number of the e-invoicing business region that you
            want to retrieve information about.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    - id: 8ad083528ee62fe1018eea6c5dd11e01
                      country: AU
                      businessName: Avalara Inc.
                      businessNumber: '74004085818'
                      businessNumberSchemeId: '0151'
                      tradeName: Test trade
                      endpointId: '74004085818'
                      endpointSchemeId: '0151'
                      taxRegisterNumber: '1577240348'
                      state: ''
                      city: ''
                      postalCode: ''
                      addressLine1: ''
                      addressLine2: ''
                      contactName: ''
                      phoneNumber: ''
                      email: ''
                      serviceProviderId: 8ad093788ea359ca018ea75fb12a6348
                      businessRegionNumber: EIBR-00000010
                      digitalSignatureEnable: 'false'
                      digitalSignatureBoxEnable: 'false'
                      digitalSignatureBoxPosX: '0'
                      digitalSignatureBoxPosY: '0'
                      responseMapping: '{}'
                      processType: PEPPOLNetwork
                      invoiceEnabled: 'true'
                      creditMemoEnabled: 'true'
                      debitMemoEnabled: 'true'
                      invoiceFilters: 'null'
                      creditMemoFilters: 'null'
                      debitMemoFilters: 'null'
                      fileFormat:
                        B2B:
                          - XML
                        B2C:
                          - ''
                        B2G:
                          - XML
              schema:
                $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an e-invoicing business region
      tags:
        - E-Invoicing
    put:
      description: >
        Updates an e-invoicing business region by key. The key can be the unique
        ID or number of an e-invoicing business region.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled. 
      operationId: PUT_UpdateEInvoicingBusinessRegion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unqiue ID or number of the e-invoicing business region that you
            want to update.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEInvoicingBusinessRegionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    addressLine1: null
                    addressLine2: null
                    businessName: legal business name
                    businessNumber: '20002039'
                    businessNumberSchemaId: '88'
                    businessRegionNumber: EIBR-00000002
                    city: Tokyo
                    contactName: null
                    country: JP
                    digitalSignatureEnable: false
                    digitalSignatureBoxEnable: false
                    digitalSignatureBoxPosX: 0
                    digitalSignatureBoxPosY: 0
                    email: null
                    endpointId: '8992'
                    endpointSchemeId: '88'
                    phoneNumber: null
                    postalCode: '368779'
                    responseMapping: {}
                    serviceProviderId: 4028948972a2bf990172bc9b27724ddc
                    state: null
                    taxRegisterNumber: TAX393999
                    tradeName: Zuora
                    fileFormat:
                      B2B:
                        - XML
                      B2C:
                        - ''
                      B2G:
                        - XML
              schema:
                $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an e-invoicing business region
      tags:
        - E-Invoicing
  /v1/e-invoice/mandates:
    get:
      description: >
        Fetches mandates for downloading files based on the country code,
        category, and process type selection. 

        This API operation returns the the list of file formats in which the
        document can be downloaded.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"

        target="_blank">E-Invoicing</a> feature for Avalara in **Early
        Availabiltiy** phase enabled.
      operationId: getEinvoiceMandates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            2-digit country code.
          in: query
          name: countryCode
          schema:
            type: string
            example: AU
        - description: >
            The process type of the e-invoicing business region.

            - If the service provider is Sovos, the process type is `Clearance`
            or `ClearanceWithCancellation`.

            - If the service provider is Avalara, the process type is
            `Clearance` or `PEPPOLNetwork`.

            - If the service provider is PEPPOL, the process type is `Unknown`.
          in: query
          name: processType
          schema:
            type: string
            example: PEPPOLNetwork
            enum:
              - Clearance
              - ClearanceWithCancellation
              - PEPPOLNetwork
              - Unknown
        - description: >-
            The service provider that is associated with the country and process
            type.
          in: query
          name: provider
          schema:
            type: string
            example: 8ad093788ea359ca018ea75fb12a6348
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  value:
                    data:
                      - countryCode: AU
                        fileFormats:
                          - OASIS_UBL_XML
                          - XML
                        category: B2B
                        processType: PEPPOLNetwork
                        defaultFileFormats: 'null'
                      - countryCode: AU
                        fileFormats:
                          - OASIS_UBL_XML
                          - XML
                        category: B2G
                        processType: PEPPOLNetwork
                        defaultFileFormats: 'null'
                    success: true
                Validation Error#1:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        Mandate details are available only if Avalara is
                        Integrated as service provider
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
              schema:
                $ref: '#/components/schemas/EinvoiceFetchMandates'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List mandates for downloading files
      tags:
        - E-Invoicing
  /v1/invoices/{invoiceKey}/e-invoice/mandate:
    get:
      description: >
        Fetches mandates for downloading e-invoice based on the country code,
        category, and process type selection. 


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"

        target="_blank">E-Invoicing</a> feature for Avalara in **Early
        Availabiltiy** phase enabled.
      operationId: getEinvoiceMandateOnInvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique number or ID of the invoice.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  value:
                    countryCode: AU
                    fileFormats:
                      - XML
                      - OASIS_UBL_XM
                    category: B2G
                    defaultFileFormats:
                      - XML
                    processType: PEPPOLNetwork
                    success: true
                Validation Error#1:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        E-Invoice for the document [<document-key>] is not
                        submitted to Avalara and hence this request cannot be
                        accepted
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
              schema:
                $ref: '#/components/schemas/EinvoiceInvoiceFetchMandate'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a mandate for downloading a file
      tags:
        - E-Invoicing
  /v1/credit-memos/{creditMemoKey}/e-invoice/mandate:
    get:
      description: >
        Fetches mandates for downloading a Credit Memo file based on the country
        code, category, and process type selection. 


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"

        target="_blank">E-Invoicing</a> feature for Avalara in **Early
        Availabiltiy** phase enabled.
      operationId: getEinvoiceCreditMemoMandate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique number or ID of the Credit Memo.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  value:
                    countryCode: AU
                    fileFormats:
                      - XML
                      - OASIS_UBL_XML
                    category: B2G
                    defaultFileFormats:
                      - XML
                    processType: PEPPOLNetwork
                    success: true
                Validation Error#1:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        E-Invoice for the document [<document-key>] is not
                        submitted to Avalara and hence this request cannot be
                        accepted
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
              schema:
                $ref: '#/components/schemas/CreditMemosEinvoiceMandate'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a mandate for downloading a credit memo
      tags:
        - E-Invoicing
  /v1/debit-memos/{debitMemoKey}/e-invoice/mandate:
    get:
      description: >
        Fetches mandates for downloading a Debit Memo file based on the country
        code, category, and process type selection. 


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"

        target="_blank">E-Invoicing</a> feature for Avalara in **Early
        Availabiltiy** phase enabled.
      operationId: getEinvoiceDebitMemoMandate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique number or ID of the Debit Memo.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  value:
                    countryCode: AU
                    fileFormats:
                      - XML
                      - OASIS_UBL_XML
                    category: B2G
                    defaultFileFormats:
                      - XML
                    processType: PEPPOLNetwork
                    success: true
                Validation Error#1:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        E-Invoice for the document [<document-key>] is not
                        submitted to Avalara and hence this request cannot be
                        accepted
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
              schema:
                $ref: '#/components/schemas/DebitMemosEinvoiceMandate'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a mandate for downloading a debit memo
      tags:
        - E-Invoicing
  /v1/invoices/{invoiceKey}/e-invoice/download:
    get:
      description: >
        Downloads the e-invoice based on the selected file format. 

        The system supports XML, UBL, PNG, or QR codes formats that each country
        requires or supports.  
      operationId: downloadEinvoiceOfSpecifiedFormat
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            This parameter is exclusively accessible for documents submitted via
            the Avalara E-Invoice integration. 

            When an invoice is processed through Sovos or PEPPOL, this parameter
            cannot be specified, and the document can only be downloaded in its
            default file format.
             
            Following mapping will be used for user representation of file
            formats:

              - XML: `application/xml`
              - PDF: `application/pdf` 
              - ZIP: `application/zip` 
              - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml`  
          in: query
          name: fileFormat
          schema:
            type: string
            enum:
              - XML
              - PDF
              - ZIP
              - OASIS_Universal_Business_Language_XML
        - description: |
            The unique number or ID of the e-invoice.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  value: {}
                Validation Error#1:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        File Format 'application/pdf' is not supported by
                        Avalara for the document [<document-number>]. Supported
                        values are [application/vnd.oasis.ubl+xml,
                        application/xml]
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
                Validation Error#2:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        File download operation is supported only if the
                        E-Invoice status is Success
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
                Validation Error#3:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        Avalara Service is down at the moment. Please try again
                        later
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
              schema:
                $ref: '#/components/schemas/EinvoiceDownload'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Download a file in the specified file format
      tags:
        - E-Invoicing
  /v1/credit-memos/{creditMemoKey}/e-invoice/download:
    get:
      description: >
        Downloads the credit memo based on the specified file format. 

        The system supports XML, UBL, PNG, or QR codes formats that each country
        requires or supports. 
      operationId: downloadCreditMemoEinvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            This parameter is exclusively accessible for documents submitted via
            the Avalara E-Invoice integration. 

            When an invoice is processed through Sovos or PEPPOL, this parameter
            cannot be specified, and the document can only be downloaded in its
            default file format.


            Following mapping will be used for user representation of file
            formats:

              - XML: `application/xml`
              - PDF: `application/pdf`    
              - ZIP: `application/zip` 
              - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml`  
          in: query
          name: fileFormat
          schema:
            type: string
            enum:
              - XML
              - PDF
              - ZIP
              - OASIS_Universal_Business_Language_XML
        - description: |
            The unique number or ID of Credit Memo.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  value: {}
                Validation Error#1:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        File Format 'application/pdf' is not supported by
                        Avalara for the document [<document-number>]. Supported
                        values are [application/vnd.oasis.ubl+xml,
                        application/xml]
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
                Validation Error#2:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        File download operation is supported only if the
                        E-Invoice status is Success
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
                Validation Error#3:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        Avalara Service is down at the moment. Please try again
                        later
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
              schema:
                $ref: '#/components/schemas/CreditMemosEinvoiceDownload'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Download a credit memo in the specified file format
      tags:
        - E-Invoicing
  /v1/debit-memos/{debitMemoKey}/e-invoice/download:
    get:
      description: >
        Downloads the debit memo based on the specified file format. 

        The system supports XML, UBL, PNG, or QR codes formats that each country
        requires or supports. 
      operationId: downloadDebitMemoEinvoice
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            This parameter is exclusively accessible for documents submitted via
            the Avalara E-Invoice integration. 

            When an invoice is processed through Sovos or PEPPOL, this parameter
            cannot be specified, and the document can only be downloaded in its
            default file format.


            Following mapping will be used for user representation of file
            formats:

              - XML: `application/xml`
              - PDF: `application/pdf` 
              - ZIP: `application/zip` 
              - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml`  
          in: query
          name: fileFormat
          schema:
            type: string
            enum:
              - XML
              - PDF
              - ZIP
              - OASIS_Universal_Business_Language_XML
        - description: The unique number or ID of Debit Memo.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                Success:
                  value: {}
                Validation Error#1:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        File Format 'application/pdf' is not supported by
                        Avalara for the document [<document-number>]. Supported
                        values are [application/vnd.oasis.ubl+xml,
                        application/xml]
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
                Validation Error#2:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        File download operation is supported only if the
                        E-Invoice status is Success
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
                Validation Error#3:
                  value:
                    success: false
                    processId: A214477BE49D98ED
                    reasons:
                      code: '50000020'
                      message: >-
                        Avalara Service is down at the moment. Please try again
                        later
                    requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c
              schema:
                $ref: '#/components/schemas/DebitMemosEinvoiceDownload'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Download a debit memo in the specified file format
      tags:
        - E-Invoicing
  /v1/invoices/{invoiceKey}/e-invoice/cancel:
    put:
      description: Cancels the E-Invoice for the given billing document
      operationId: cancelEInvoiceByInvoiceKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: Invoice Id or Number
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutCancelEInvoiceRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel the e-invoice file for an invoice
      tags:
        - E-Invoicing
  /v1/einvoice/templates:
    get:
      description: >
        Lists information about e-invoice file templates.


        You can query e-invoice file templates by conditions. For example, if
        your service provider is Sovos, you can use the following example URL to
        retrieve information about a list of e-invoice file templates for
        invoices in India:

        `/v1/einvoice/templates?country=IN&documentType=Invoice&provider=Sovos`


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: GET_EInvoiceFileTemplates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The short name of a country or region where you must comply with
            e-invoicing requirements. For example, `IN` for India. For the full
            list of country names and codes, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a>.
          in: query
          name: country
          required: true
          schema:
            type: string
        - description: >
            The type of billing documents for which the e-invoice file template
            is intended.
          in: query
          name: documentType
          required: true
          schema:
            enum:
              - Invoice
              - CreditMemo
              - DebitMemo
            type: string
        - description: >
            The name of the e-invoicing service provider that assists in
            generating e-invoice files. 
          in: query
          name: provider
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    templates:
                      - country: SA
                        documentType: Invoice
                        id: 402833ec89d46b390189d51402d937b0
                        name: EInvoice Template Name
                        provider: Sovos
                        templateNumber: EITEMP-00000006
                      - country: SA
                        documentType: CreditMemo
                        id: 402833ec89d46b390189d514030537b2
                        name: EInvoice Template Name
                        provider: Sovos
                        templateNumber: EITEMP-00000008
                      - country: SA
                        documentType: DebitMemo
                        id: 402833ec89d46b390189d514032037b4
                        name: EInvoice Template Name
                        provider: Sovos
                        templateNumber: EITEMP-00000009
              schema:
                $ref: '#/components/schemas/ListEInvoiceFileTemplatesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List e-invoice file templates
      tags:
        - E-Invoicing
    post:
      description: >
        Creates an e-invoice file templates for your billing documents,
        including invoices, credit memos, and debit memos. 


        Zuora provides default e-invoice file templates, so you can just
        customize them as needed. For example, some country specific fields like
        HSN (Harmonized System of Nomenclature) might be stored on product rate
        plan charges.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: POST_CreateEInvoiceFileTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEInvoiceFileTemplateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    content: base64 encoded content
                    country: IN
                    documentType: Invoice
                    id: 4028818484f483d20184f5006b97003f
                    name: Sovos e-invoice service
                    provider: Sovos
                    success: true
                    templateNumber: EITEMP-00000003
              schema:
                $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an e-invoice file template
      tags:
        - E-Invoicing
  /v1/einvoice/templates/{key}:
    delete:
      description: >
        Deletes an e-invoice file template by key. The key can be the unique ID
        or number of an e-invoice file template.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: DELETE_EInvoiceFileTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the e-invoice file template that you want
            to delete.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an e-invoice file template
      tags:
        - E-Invoicing
    get:
      description: >
        Retrieves information about an e-invoice file template.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: GET_EInvoiceFileTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique number or ID of the e-invoice file template that you want
            to retrieve information about.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    content: base64 encoded content
                    country: IN
                    documentType: Invoice
                    id: 4028818484f483d20184f5006b97003f
                    name: Sovos e-invoice service
                    provider: Sovos
                    success: true
                    templateNumber: EITEMP-00000003
              schema:
                $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an e-invoice file template
      tags:
        - E-Invoicing
    put:
      description: >
        Updates information about an e-invoice file template.


        **Note**: This operation is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      operationId: PUT_EInvoiceFileTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique number or ID of the e-invoice file template that you want
            to update.
          in: path
          name: key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEInvoiceFileTemplateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    content: base64 encoded content
                    country: IN
                    documentType: Invoice
                    id: 4028818484f483d20184f5006b97003f
                    name: Sovos e-invoice service
                    provider: Sovos
                    success: true
                    templateNumber: EITEMP-00000003
              schema:
                $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an e-invoice file template
      tags:
        - E-Invoicing
  /v1/invoices/{invoiceKey}/e-invoice/sync-status:
    put:
      description: >
        Initiates a background polling process to retrieve the latest
        notification response from the configured e-Invoicing provider and
        update the e-Invoice status of the e-Invoice.


        **Note**: This API can only be invoked when the current e-Invoice status
        is one of:  `Processing`, `ApprovedByAuthority`, `RetrieveTimeout`, or
        `Failed`. If the status is different, the request will be rejected.
      operationId: updateInvoiceInvokeSyncStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: ' The e-Invoice ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of an e-Invoice.'
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - name: shouldIncludeAcknowledged
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Controls how Zuora pulls e-invoice notifications from the
            e-invoicing service provider

            when resyncing the e-invoice status.


            - If `false` (default), Zuora refreshes only the latest
            notifications that have not yet been
              acknowledged.
            - If `true`, Zuora performs a full re-sync and reprocesses all
            notifications from the beginning,
              which is useful if incremental requests return incomplete results (for example, after
              recreating notifications in Sovos).

            **Note:** This parameter is primarily applicable to Sovos. For other
            providers, Zuora may ignore this

            parameter and apply the provider’s default resync behavior.
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          description: Unauthorized
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ProxyUnauthorizedResponse'
                  - $ref: '#/components/schemas/CommonResponse'
              examples:
                UnauthorizedExample:
                  value:
                    message: Authentication error
                PermissionErrorExample:
                  value:
                    code: 71012514
                    message: User does not have permission to delete custom objects.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            WWW-Authenticate:
              description: >-
                The value of this header is: ``` Basic realm=Zuora API, ZSession
                realm=Zuora API, Bearer realm=Zuora API ``` 
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Sync the e-Invoice status of an invoice
      tags:
        - E-Invoicing
  /v1/debit-memos/{debitMemoKey}/e-invoice/sync-status:
    put:
      description: >
        Initiates a background polling process to retrieve the latest
        notification response from the configured e-Invoicing provider and
        update the e-Invoice status of the debit memo.


        **Note**: This API can only be invoked when the current e-Invoice status
        is one of:  `Processing`, `ApprovedByAuthority`, `RetrieveTimeout`, or
        `Failed`. If the status is different, the request will be rejected.
      operationId: updateDebitMemoInvokeSyncStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: ' The debit memo ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of the debit memo.'
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - name: shouldIncludeAcknowledged
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Controls how Zuora pulls e-invoice notifications from the
            e-invoicing service provider

            when resyncing the e-invoice status.


            - If `false` (default), Zuora refreshes only the latest
            notifications that have not yet been
              acknowledged.
            - If `true`, Zuora performs a full re-sync and reprocesses all
            notifications from the beginning,
              which is useful if incremental requests return incomplete results (for example, after
              recreating notifications in Sovos).

            **Note:** This parameter is primarily applicable to Sovos. For other
            providers, Zuora may ignore this

            parameter and apply the provider’s default resync behavior.
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          description: Unauthorized
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ProxyUnauthorizedResponse'
                  - $ref: '#/components/schemas/CommonResponse'
              examples:
                UnauthorizedExample:
                  value:
                    message: Authentication error
                PermissionErrorExample:
                  value:
                    code: 71012514
                    message: User does not have permission to delete custom objects.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            WWW-Authenticate:
              description: >-
                The value of this header is: ``` Basic realm=Zuora API, ZSession
                realm=Zuora API, Bearer realm=Zuora API ``` 
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Sync the e-Invoice status of a debit memo
      tags:
        - E-Invoicing
  /v1/credit-memos/{creditMemoKey}/e-invoice/sync-status:
    put:
      description: >
        Initiates a background polling process to retrieve the latest
        notification response from the configured e-Invoicing provider and
        update the e-Invoice status of the credit memo.


        **Note**: This API can only be invoked when the current e-Invoice status
        is one of:  `Processing`, `ApprovedByAuthority`, `RetrieveTimeout`, or
        `Failed`. If the status is different, the request will be rejected.
      operationId: updateCreditMemoInvokeSyncStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: ' The credit memo ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of the credit memo.'
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - name: shouldIncludeAcknowledged
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Controls how Zuora pulls e-invoice notifications from the
            e-invoicing service provider

            when resyncing the e-invoice status.


            - If `false` (default), Zuora refreshes only the latest
            notifications that have not yet been
              acknowledged.
            - If `true`, Zuora performs a full re-sync and reprocesses all
            notifications from the beginning,
              which is useful if incremental requests return incomplete results (for example, after
              recreating notifications in Sovos).

            **Note:** This parameter is primarily applicable to Sovos. For other
            providers, Zuora may ignore this

            parameter and apply the provider’s default resync behavior.
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          description: Unauthorized
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ProxyUnauthorizedResponse'
                  - $ref: '#/components/schemas/CommonResponse'
              examples:
                UnauthorizedExample:
                  value:
                    message: Authentication error
                PermissionErrorExample:
                  value:
                    code: 71012514
                    message: User does not have permission to delete custom objects.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            WWW-Authenticate:
              description: >-
                The value of this header is: ``` Basic realm=Zuora API, ZSession
                realm=Zuora API, Bearer realm=Zuora API ``` 
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Sync the e-Invoice status of a credit memo
      tags:
        - E-Invoicing
  /v1/invoices/{invoiceKey}/einvoice/generate:
    put:
      description: >
        Generates an e-invoice file for an invoice. 

        If the invoice status is **Failed** during e-invoice generation, you can
        use  **Regenerate E-Invoice**. Once you fix the errors and trigger the
        regeneration,  the system will resubmit the document to the e-invoicing
        service provider,  and its status will update to **Processing**.


        **Note**:


        - <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-sovos"
        target="_blank">E-invoicing with Sovos</a> and <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-peppol-extract"
        target="_blank">E-invoicing with PEPPOL Extract</a> are generally
        available. 

        - <a
        href=https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-avalara
        target="_blank">E-invoicing with Avalara</a> is in the **Early
        Availability** phase. We are actively soliciting feedback from a small
        set of early availability users before releasing this feature as
        generally available.  If you want to join this early availability
        program, submit a request at <a
        href="https://zuora.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fsupport.zuora.com%2Fhc%2Fen-us&theme=hc&locale=en-us&brand_id=825826&auth_origin=825826%2Ctrue%2Ctrue"
        target="_blank">Zuora Global Support</a>. 


        The **Regenerate E-Invoice** action is available in the **Generated**
        status for the PEPPOL service provider. 
      operationId: PUT_GenerationEInvoiceGenerationForInvoices
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the invoice. For example,
            2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.
          in: path
          name: invoiceKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate an e-invoice file for an invoice
      tags:
        - E-Invoicing
  /v1/credit-memos/{creditMemoKey}/e-invoice/generate:
    put:
      description: >
        Generates an e-invoice file for a credit memo.  If the Credit Memo
        status is **Failed** during e-invoice generation, you can use 
        **Regenerate E-Invoice**. Once you fix the errors and trigger the
        regeneration,  the system will resubmit the document to the e-invoicing
        service provider,  and its status will update to **Processing**.


        **Note**:


        - <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-sovos"
        target="_blank">E-invoicing with Sovos</a> and <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-peppol-extract"
        target="_blank">E-invoicing with PEPPOL Extract</a> are generally
        available. 

        - <a
        href=https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-avalara
        target="_blank">E-invoicing with Avalara</a> is in the **Early
        Availability** phase. We are actively soliciting feedback from a small
        set of early availability users before releasing this feature as
        generally available.  If you want to join this early availability
        program, submit a request at <a
        href="https://zuora.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fsupport.zuora.com%2Fhc%2Fen-us&theme=hc&locale=en-us&brand_id=825826&auth_origin=825826%2Ctrue%2Ctrue"
        target="_blank">Zuora Global Support</a>. 


        The **Regenerate E-Invoice** action is available in the **Generated**
        status for the PEPPOL service provider. 
      operationId: PUT_GenerateEInvoiceFileForCreditMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the credit memo. For example,
            2c92c8955bd63cc1015bd7c151af02ab or CM-0000001.
          in: path
          name: creditMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate an e-invoice file for a credit memo
      tags:
        - E-Invoicing
  /v1/debit-memos/{debitMemoKey}/e-invoice/generate:
    put:
      description: >-
        Generates an e-invoice file for a debit memo.   If the Credit Memo
        status is **Failed** during e-invoice generation, you can use 
        **Regenerate E-Invoice**. Once you fix the errors and trigger the
        regeneration,  the system will resubmit the document to the e-invoicing
        service provider,  and its status will update to **Processing**.


        **Note**: 


        - <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-sovos"
        target="_blank">E-invoicing with Sovos</a> and <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-peppol-extract"
        target="_blank">E-invoicing with PEPPOL Extract</a> are generally
        available. 

        - <a
        href=https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-with-avalara
        target="_blank">E-invoicing with Avalara</a> is in the **Early
        Availability** phase. We are actively soliciting feedback from a small
        set of early availability users before releasing this feature as
        generally available.  If you want to join this early availability
        program, submit a request at <a
        href="https://zuora.zendesk.com/auth/v2/login/signin?return_to=https%3A%2F%2Fsupport.zuora.com%2Fhc%2Fen-us&theme=hc&locale=en-us&brand_id=825826&auth_origin=825826%2Ctrue%2Ctrue"
        target="_blank">Zuora Global Support</a>.  


        The **Regenerate E-Invoice** action is available in the **Generated**
        status for the PEPPOL service provider.  
      operationId: PUT_GenerateEInvoiceFileForDebitMemo
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the debit memo. For example,
            2c92c8955bd63cc1015bd7c151af02ab or DM-0000001.
          in: path
          name: debitMemoKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate an e-invoice file for a debit memo
      tags:
        - E-Invoicing
  /v1/invoice-schedules:
    post:
      description: >
        Creates an invoice schedule.


        ### Limitations


        This API operation has the following limitations:


        * You can create at most 50 invoice schedule items in one request.


        * You can associate at most 10 orders with an invoice schedule in one
        request.


        * You can associate at most 300 subscriptions with an invoice schedule
        in one

        request, including those contained in orders and separate subscriptions.


        **Note**: This operation is available only if you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Schedule/Billing_Schedule_overview"
        target="_blank">Billing Schedule</a> feature enabled.
      operationId: POST_CreateInvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTCreateInvoiceScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    actualAmount: 70200
                    additionalSubscriptionsToBill:
                      - S-00000001
                      - S-00000002
                    billedAmount: 0
                    currency: USD
                    id: e2441b3e24eb42859194be7da2403b38
                    invoiceSeparately: false
                    nextRunDate: '2022-02-24'
                    notes: 2022 Billing Schedule
                    number: IS-00000004
                    orders:
                      - O-00000007
                      - O-00000008
                    scheduleItems:
                      - actualAmount: 50000
                        amount: 50000
                        id: 8a8881aa82118bec018211daf9f01680
                        percentage: null
                        runDate: '2022-02-24'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-02-24'
                      - actualAmount: 14000
                        amount: 14000
                        id: 8a8881aa82118bec018211daf9f11681
                        percentage: null
                        runDate: '2022-10-17'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-10-17'
                      - actualAmount: 6200
                        amount: 6200
                        id: 8a8881aa82118bec018211daf9f11682
                        percentage: null
                        runDate: '2022-11-14'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-11-14'
                    specificSubscriptions:
                      - orderKey: O-00000008
                        subscriptionKey: S-00000008
                    status: Pending
                    success: true
                    totalAmount: 70200
                    unbilledAmount: 70200
              schema:
                $ref: '#/components/schemas/InvoiceScheduleResponses'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an invoice schedule
      tags:
        - Invoice Schedules
  /v1/invoice-schedules/{scheduleKey}:
    delete:
      description: >
        Deletes an invoice schedule in Pending status. The status of the invoice

        schedule to be deleted must be `Pending`.


        **Note**: This operation is available only if you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Schedule/Billing_Schedule_overview"
        target="_blank">Billing Schedule</a> feature enabled.
      operationId: DELETE_InvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the invoice schedule to be deleted. For
            example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an invoice schedule
      tags:
        - Invoice Schedules
    get:
      description: >
        Retrieves detailed information about an invoice schedule.


        **Note**: This operation is available only if you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Schedule/Billing_Schedule_overview"
        target="_blank">Billing Schedule</a> feature enabled.
      operationId: GET_InvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID or number of the invoice schedule to be retrieved. For
            example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    actualAmount: 20200
                    additionalSubscriptionsToBill:
                      - S-00000001
                      - S-00000002
                    billedAmount: 50000
                    currency: USD
                    id: e2441b3e24eb42859194be7da2403b38
                    invoiceSeparately: false
                    nextRunDate: '2022-10-17'
                    notes: 2022 Billing Schedule
                    number: IS-00000004
                    orders:
                      - O-00000007
                      - O-00000008
                    scheduleItems:
                      - actualAmount: 0
                        amount: 50000
                        id: 8a8881aa82118bec018211daf9f01680
                        invoiceId: 8a8881aa82118bec018211dafc1e1695
                        percentage: null
                        runDate: '2022-02-24'
                        status: Processed
                        targetDateForAdditionalSubscriptions: '2022-02-24'
                      - actualAmount: 14000
                        amount: 14000
                        id: 8a8881aa82118bec018211daf9f11681
                        percentage: null
                        runDate: '2022-10-17'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-10-17'
                      - actualAmount: 6200
                        amount: 6200
                        id: 8a8881aa82118bec018211daf9f11682
                        percentage: null
                        runDate: '2022-11-14'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-11-14'
                    specificSubscriptions:
                      - orderKey: O-00000008
                        subscriptionKey: S-00000008
                    status: PartiallyProcessed
                    success: true
                    totalAmount: 70200
                    unbilledAmount: 20200
              schema:
                $ref: '#/components/schemas/InvoiceScheduleResponses'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an invoice schedule
      tags:
        - Invoice Schedules
    put:
      description: >
        Updates a pending invoice schedule. You can use this API operation to
        update invoice schedules in the following aspects:
          - Update notes and pending invoice schedule items
          - Update orders associated with invoice schedules
          - Remove or add invoice schedule items
        For more samples, see <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Edit_invoice_schedules"
        target="_blank">Edit invoice schedules</a>


        ### Restrictions and limitations

        When updating invoice schedules through the REST API, keep the following
        restrictions and limitations in mind:
          - You can only update invoice schedule items in `Pending` status.
          - You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules.
          - For the invoice schedule items that you want to update, you must include the new values for these items in the request.
          - For the invoice schedule items that you want to keep unchanged, you must include all the existing information about these items in the request. Otherwise, the existing invoice schedule items that you do not include in the request are deleted.
          - For the orders that you want to keep unchanged for an invoice schedule, you must include all the existing order numbers associated with the invoice schedule in the request. Otherwise, the existing orders that you do not include in the request are removed.

        **Note**: This operation is available only if you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Schedule/Billing_Schedule_overview"
        target="_blank">Billing Schedule</a> feature enabled.
      operationId: PUT_UpdateInvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the invoice schedule to be updated. For
            example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTUpdateInvoiceScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    actualAmount: 70200
                    additionalSubscriptionsToBill:
                      - S-00000001
                      - S-00000002
                    billedAmount: 0
                    currency: USD
                    id: e2441b3e24eb42859194be7da2403b38
                    invoiceSeparately: false
                    nextRunDate: '2022-02-24'
                    notes: 2022 Billing Schedule
                    number: IS-00000004
                    orders:
                      - O-00000007
                      - O-00000008
                    scheduleItems:
                      - actualAmount: 54000
                        amount: 54000
                        id: 8a8881aa82118bec018211daf9f01680
                        percentage: null
                        runDate: '2022-02-24'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-02-24'
                      - actualAmount: 10000
                        amount: 10000
                        id: 8a8881aa82118bec018211daf9f11681
                        percentage: null
                        runDate: '2022-10-17'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-10-17'
                      - actualAmount: 6200
                        amount: 6200
                        id: 8a8881aa82118bec018211daf9f11682
                        percentage: null
                        runDate: '2022-11-14'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-11-14'
                    specificSubscriptions:
                      - orderKey: O-00000008
                        subscriptionKey: S-00000008
                    status: Pending
                    success: true
                    totalAmount: 70200
                    unbilledAmount: 70200
              schema:
                $ref: '#/components/schemas/InvoiceScheduleResponses'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an invoice schedule
      tags:
        - Invoice Schedules
  /v1/invoice-schedules/{scheduleKey}/execute:
    post:
      description: >
        Executes an invoice schedule immediately. During the execution, a bill
        run is created and generates an invoice or a credit memo
        asynchronously. 


        When you use this API operation to execute an invoice schedule item, you
        have the flexibility to decide whether to specify a specific item ID.

        - If you specify the unique ID of an invoice schedule item to be
        executed in the request, the corresponding invoice schedule item is
        executed.

        - If you do not specify the ID of any invoice schedule item in the
        request, the subscription end date is used as the target date to
        determine the next pending schedule item to be executed. 


        A paused invoice schedule and charges inside cannot be automatically
        executed by Zuora Scheduler or by this "Execute an invoice schedule" API
        operation. In this case, you can do one of the following:

        - Use the <a
        href="https://developer.zuora.com/v1-api-reference/api/operation/POST_GenerateBillingDocuments/"
        target="_blank">Generate billing documents by account ID</a> API
        operation

        - Create a bill run with the target date greater than the next run date
        of the invoice schedule through UI or API


        For more samples, see [Execute invoice
        schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Execute_invoice_schedules).


        **Note**: This operation is available only if you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Schedule/Billing_Schedule_overview"
        target="_blank">Billing Schedule</a> feature enabled.
      operationId: POST_ExecuteInvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the schedule to be executed. For example,
            2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTExecuteInvoiceScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteInvoiceScheduleBillRunResponse'
            autoEmail:
              examples:
                response:
                  value: false
            autoPost:
              examples:
                response:
                  value: false
            autoRenewal:
              examples:
                response:
                  value: false
            billRunFilters:
              examples:
                response:
                  value:
                    - accountId: 8ad09c4b82b5c6330182c5ccab3570e6
                      filterType: InvoiceSchedule
            billRunNumber:
              examples:
                response:
                  value: BR-00001017
            createdById:
              examples:
                response:
                  value: 2c92c0f84298ac5901429dea196212be
            createdDate:
              examples:
                response:
                  value: '2022-08-22 06:47:18'
            id:
              examples:
                response:
                  value: 8ad0823f82b5b2520182c5cec5fe40fb
            invoiceDate:
              examples:
                response:
                  value: '2022-02-24'
            noEmailForZeroAmountInvoice:
              examples:
                response:
                  value: false
            status:
              examples:
                response:
                  value: Pending
            success:
              examples:
                response:
                  value: true
            targetDate:
              examples:
                response:
                  value: '2022-02-24'
            updatedById:
              examples:
                response:
                  value: 2c92c0f84298ac5901429dea196212be
            updatedDate:
              examples:
                response:
                  value: '2022-08-22 06:47:18'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Execute an invoice schedule
      tags:
        - Invoice Schedules
  /v1/invoice-schedules/{scheduleKey}/pause:
    put:
      description: >
        Pauses an invoice schedule immediately.


        A paused invoice schedule and charges inside cannot be automatically
        executed by Zuora

        Scheduler or by the <a
        href="https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/"
        target="_blank">Execute an invoice schedule</a>

        API operation. In this case, you can do one of the following:

        - Use the <a
        href="https://developer.zuora.com/v1-api-reference/api/operation/POST_GenerateBillingDocuments/"
        target="_blank">Generate billing documents by account ID</a> API
        operation

        - Create a bill run with the target date greater than the next run date
        of the invoice schedule through UI or API


        **Note**: This operation is available only if you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Schedule/Billing_Schedule_overview"
        target="_blank">Billing Schedule</a> feature enabled.
      operationId: PUT_PauseInvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the schedule to be paused. For example,
            2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    actualAmount: 20200
                    billedAmount: 50000
                    currency: USD
                    id: e2441b3e24eb42859194be7da2403b38
                    nextRunDate: '2022-10-17'
                    notes: 2022 Billing Schedule
                    number: IS-00000004
                    orders:
                      - O-00000007
                      - O-00000008
                    scheduleItems:
                      - actualAmount: 0
                        amount: 50000
                        id: 8a8881aa82118bec018211daf9f01680
                        invoiceId: 8a8881aa82118bec018211dafc1e1695
                        percentage: null
                        runDate: '2022-02-24'
                        status: Processed
                        targetDateForAdditionalSubscriptions: '2022-02-24'
                      - actualAmount: 14000
                        amount: 14000
                        id: 8a8881aa82118bec018211daf9f11681
                        percentage: null
                        runDate: '2022-10-17'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-10-17'
                      - actualAmount: 6200
                        amount: 6200
                        id: 8a8881aa82118bec018211daf9f11682
                        percentage: null
                        runDate: '2022-11-14'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-11-14'
                    specificSubscriptions:
                      - orderKey: O-00000008
                        subscriptionKey: S-00000008
                    status: Paused
                    success: true
                    totalAmount: 70200
                    unbilledAmount: 20200
              schema:
                $ref: '#/components/schemas/InvoiceScheduleResponses'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Pause an invoice schedule
      tags:
        - Invoice Schedules
  /v1/invoice-schedules/{scheduleKey}/resume:
    put:
      description: >
        Resumes an invoice schedule in Paused status immediately.


        After an invoice schedule is resumed, it can continue to be
        automatically executed

        by Zuora Scheduler or by the [Execute an invoice
        schedule](https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/)

        API operation.


        **Note**: This operation is available only if you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Schedule/Billing_Schedule_overview"
        target="_blank">Billing Schedule</a> feature enabled.
      operationId: PUT_ResumeInvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the schedule to be resumed. For example,
            2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    actualAmount: 20200
                    billedAmount: 50000
                    currency: USD
                    id: e2441b3e24eb42859194be7da2403b38
                    nextRunDate: '2022-10-17'
                    notes: 2022 Billing Schedule
                    number: IS-00000004
                    orders:
                      - O-00000007
                      - O-00000008
                    scheduleItems:
                      - actualAmount: 0
                        amount: 50000
                        id: 8a8881aa82118bec018211daf9f01680
                        invoiceId: 8a8881aa82118bec018211dafc1e1695
                        percentage: null
                        runDate: '2022-02-24'
                        status: Processed
                        targetDateForAdditionalSubscriptions: '2022-02-24'
                      - actualAmount: 14000
                        amount: 14000
                        id: 8a8881aa82118bec018211daf9f11681
                        percentage: null
                        runDate: '2022-10-17'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-10-17'
                      - actualAmount: 6200
                        amount: 6200
                        id: 8a8881aa82118bec018211daf9f11682
                        percentage: null
                        runDate: '2022-11-14'
                        status: Pending
                        targetDateForAdditionalSubscriptions: '2022-11-14'
                    specificSubscriptions:
                      - orderKey: O-00000008
                        subscriptionKey: S-00000008
                    status: PartiallyProcessed
                    success: true
                    totalAmount: 70200
                    unbilledAmount: 20200
              schema:
                $ref: '#/components/schemas/InvoiceScheduleResponses'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Resume an invoice schedule
      tags:
        - Invoice Schedules
  /v1/invoice-schedules/{scheduleKey}/detach:
    put:
      description: >
        Detaches charges from an invoice schedule. The invoice schedules you
        want to detach charges from must be in Fully Processed or Partially
        Processed status. Invoice schedules do not bill detached charges.
      operationId: detachChargesFromInvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the invoice schedule to detach charges
            from. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DetachInvoiceScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Detach charges from an invoice schedule
      tags:
        - Invoice Schedules
  /v1/invoice-schedules/{scheduleKey}/attach:
    put:
      description: >
        Attaches charges to an invoice schedule. The invoice schedules you want
        to attach charges to must be in Fully Processed or Partially Processed
        status. 

        You can attach charges only if they were previously detached from the
        same invoice schedule. Invoice schedules will automatically bill
        re-attached charges in the upcoming planned invoice schedule items.
      operationId: attachChargesToInvoiceSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of the invoice schedule to attach charges
            to. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.
          in: path
          name: scheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachInvoiceScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Attach charges to an invoice schedule
      tags:
        - Invoice Schedules
  /v1/object/taxation-item:
    post:
      description: Creates a Taxation Item object.
      operationId: Object_POSTTaxationItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyCreateTaxationItem'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c93808457d787030157e0306f413a96
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyCreateOrModifyResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    Errors:
                      - Code: INVALID_VALUE
                        Message: The account number 123xProxy is invalid.
                    Success: false
              schema:
                $ref: '#/components/schemas/ProxyBadRequestResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Create a taxation item'
      tags:
        - Taxation Items
  /v1/taxation-items/{id}:
    delete:
      description: |
        Deletes a specific taxation item by ID.
      operationId: DELETE_TaxationItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a taxation item.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a taxation item
      tags:
        - Taxation Items
    get:
      description: |
        Retrieves the information about a specific taxation item by ID.
      operationId: GET_TaxationItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a taxation item.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-02-27 11:52:03'
                    exemptAmount: 0
                    financeInformation:
                      onAccountAccountingCode: Check
                      onAccountAccountingCodeType: Cash
                      salesTaxPayableAccountingCode: Check
                      salesTaxPayableAccountingCodeType: Cash
                    id: 402890555a7d4022015a7db254e200c8
                    jurisdiction: null
                    locationCode: null
                    memoItemId: 402890555a7d4022015a7db254d800c7
                    name: my tax
                    sourceTaxItemId: 402890555a7d4022015a7db254e200c1
                    success: true
                    taxAmount: 1
                    taxCode: ZtaxCode
                    taxCodeDescription: ''
                    taxDate: '2017-02-27'
                    taxRate: 5
                    taxRateDescription: null
                    taxRateType: FlatFee
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-02-27 11:52:03'
              schema:
                $ref: '#/components/schemas/GETTaxationItemType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: |
        Retrieve a taxation item
      tags:
        - Taxation Items
    put:
      description: |
        Updates a specific taxation item by ID.
      operationId: PUT_TaxationItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a taxation item.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTTaxationItemType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    createdById: 8ad084a67f9c7138017fab8a8b511b5a
                    createdDate: '2024-11-04 10:53:16'
                    exemptAmount: 0
                    id: 8ad09d9392e0a4430192f51746d121f6
                    memoItemId: null
                    invoiceItemId: 8ad086fa92d66ffe0192dc7e5dd65161
                    sourceTaxItemId: null
                    jurisdiction: CALIFORNIA
                    locationCode: null
                    name: CA TAX
                    taxAmount: 3
                    applicableTaxUnRounded: 3
                    country: null
                    taxCode: null
                    taxCodeDescription: null
                    taxDate: '2024-11-04'
                    taxRate: 3
                    taxMode: TaxExclusive
                    taxRateDescription: Details of the tax rate
                    taxRateType: FlatFee
                    updatedById: 8ad084a67f9c7138017fab8a8b511b5a
                    updatedDate: '2024-11-04 10:57:51'
                    financeInformation:
                      onAccountAccountingCode: null
                      onAccountAccountingCodeType: null
                      salesTaxPayableAccountingCode: Sales Tax Payable
                      salesTaxPayableAccountingCodeType: SalesTaxPayable
                    success: true
              schema:
                $ref: '#/components/schemas/GETTaxationItemType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a taxation item
      tags:
        - Taxation Items
  /v1/sequence-sets:
    get:
      description: >
        Retrieves information about all sequence sets configured for billing
        documents, payments, and refunds. Billing documents include invoices,
        credit memos, and debit memos.


        You can use query parameters to restrict the data returned in the
        response.


        **Note**: The Credit and Debit Memos feature is only available if you
        have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: GET_SequenceSets
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - description: |
            The name or number of a specific sequence set.
          in: query
          name: name
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    sequenceSets:
                      - creditMemo:
                          prefix: CM
                          startNumber: 11
                        debitMemo:
                          prefix: DM
                          startNumber: 12
                        id: 2c98906c69be199c0169be74ed210afd
                        invoice:
                          prefix: INV
                          startNumber: 10
                        name: DEFAULT
                        payment:
                          prefix: P-
                          startNumber: 13
                        refund:
                          prefix: R-
                          startNumber: 14
                      - creditMemo:
                          prefix: FCM
                          startNumber: 11
                        debitMemo:
                          prefix: FDM
                          startNumber: 12
                        id: 2c98906c69be199c0169be74ed211afd
                        invoice:
                          prefix: FINV
                          startNumber: 10
                        name: FR
                        payment:
                          prefix: FP-
                          startNumber: 13
                        refund:
                          prefix: FR-
                          startNumber: 14
                      - creditMemo:
                          prefix: ITACM
                          startNumber: 11
                        debitMemo:
                          prefix: ITADM
                          startNumber: 12
                        id: 2c98906c69be199c0169be74ed212afd
                        invoice:
                          prefix: ITAINV
                          startNumber: 10
                        name: ITA
                        payment:
                          prefix: ITAP-
                          startNumber: 13
                        refund:
                          prefix: ITAR-
                          startNumber: 14
                    success: true
              schema:
                $ref: '#/components/schemas/GETSequenceSetsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List sequence sets
      tags:
        - Sequence Sets
    post:
      description: >
        Creates sequence sets, allowing distinct numbering sequences for billing
        documents, payments, and refunds. Billing documents include invoices,
        credit memos, and debit memos.


        You can create a maximum of 100 sequence sets in one single request. A
        sequence set comprises a set of custom prefixes and starting numbers
        that are used for billing documents to generate, and payments and
        refunds to create.


        See [Prefix and Numbering Configuration for Billing
        Documents](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Prefix_and_Numbering_Configuration_for_Billing_Documents)
        for more information about limitations.


        **Note**: The Credit and Debit Memos feature is only available if you
        have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: POST_SequenceSets
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTSequenceSetsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    sequenceSets:
                      - id: 402892c74c9193cd014c96bbe7c101f9
                        name: FR
                        creditMemo:
                          prefix: FCM
                          startNumber: 10
                        debitMemo:
                          prefix: FDM
                          startNumber: 10
                        invoice:
                          prefix: FINV
                          startNumber: 10
                        payment:
                          prefix: FP-
                          startNumber: 10
                        refund:
                          prefix: FR-
                          startNumber: 10
                    success: true
              schema:
                $ref: '#/components/schemas/POSTSequenceSetsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create sequence sets
      tags:
        - Sequence Sets
  /v1/sequence-sets/{id}:
    delete:
      description: >
        Deletes a specific sequence set configured for billing documents,
        payments, and refunds. Billing documents include invoices, credit memos,
        and debit memos.


        **Note**: The Credit and Debit Memos feature is only available if you
        have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: DELETE_SequenceSet
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID or number of the sequence set to delete.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a sequence set
      tags:
        - Sequence Sets
    get:
      description: >
        Retrieves information about a specific sequence set configured for
        billing documents, payments, and refunds. Billing documents include
        invoices, credit memos, and debit memos


        **Note**: The Credit and Debit Memos feature is only available if you
        have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: GET_SequenceSet
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID or number of the sequence set to retrieve information about.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    creditMemo:
                      prefix: FCM
                      startNumber: 11
                    debitMemo:
                      prefix: FDM
                      startNumber: 12
                    invoice:
                      prefix: FINV
                      startNumber: 10
                    name: FR
                    payment:
                      prefix: FP-
                      startNumber: 13
                    refund:
                      prefix: FR-
                      startNumber: 14
                    success: true
              schema:
                $ref: '#/components/schemas/GETSequenceSetResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a sequence set
      tags:
        - Sequence Sets
    put:
      description: >
        Updates a specific sequence set configured for billing documents,
        payments, and refunds. Billing documents include invoices, credit memos,
        and debit memos.


        **Note**: The Credit and Debit Memos feature is only available if you
        have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: PUT_SequenceSet
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID or number of the sequence set to update.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTSequenceSetRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/PUTSequenceSetResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a sequence set
      tags:
        - Sequence Sets
  /v1/operations/billing-preview:
    post:
      description: >

        Generates a preview of future invoice items for one customer account.
        Use the BillingPreview call to calculate how much a single customer will
        be invoiced from the most recent invoice to a specific end of term date
        in the future.


        Additionally, you can use the BillingPreview service to access real-time
        data on an individual customer's usage consumption. 


        The BillingPreview call only calculates taxes for charges in the
        subscription if you use [Zuora
        Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax) and
        the product rate plan charge associated with the invoice item uses the
        [tax inclusive
        mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode);
        otherwise, this call does not calculate taxes.


        If you have the Invoice Settlement feature enabled, you can also
        generate a preview of future credit memo items for one customer account.
        The Invoice Settlement feature is generally available as of Zuora
        Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: POST_BillingPreview
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBillingPreviewParam'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 8ad09bce83f1da020183f97e245c1c47
                    invoiceItems:
                      - id: d573746814a14da0a0a0abda2a41d65a
                        subscriptionName: A-S00000346
                        subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c
                        subscriptionNumber: A-S00000346
                        serviceStartDate: '2024-08-01'
                        serviceEndDate: '2024-08-31'
                        chargeAmount: 10
                        chargeDescription: ''
                        chargeName: Monthly Fee
                        chargeNumber: C-00000950
                        chargeId: 8ad08ad58e35d490018e36a0f2252aa5
                        productName: Music service
                        quantity: 1
                        taxAmount: 0
                        unitOfMeasure: ''
                        chargeDate: '2024-07-09 17:06:58'
                        chargeType: Recurring
                        processingType: Charge
                        appliedToItemId: null
                        numberOfDeliveries: 0
                      - id: c86c42ee4f5b42bd86351f4a99bf230e
                        subscriptionName: A-S00000346
                        subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c
                        subscriptionNumber: A-S00000346
                        serviceStartDate: '2024-09-01'
                        serviceEndDate: '2024-09-30'
                        chargeAmount: 10
                        chargeDescription: ''
                        chargeName: Monthly Fee
                        chargeNumber: C-00000950
                        chargeId: 8ad08ad58e35d490018e36a0f2252aa5
                        productName: Music service
                        quantity: 1
                        taxAmount: 0
                        unitOfMeasure: ''
                        chargeDate: '2024-07-09 17:06:58'
                        chargeType: Recurring
                        processingType: Charge
                        appliedToItemId: null
                        numberOfDeliveries: 0
                    success: true
              schema:
                $ref: '#/components/schemas/BillingPreviewResult'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate a billing preview
      tags:
        - Operations
  /v1/operations/invoice-collect:
    post:
      description: >
        Generates and posts invoices and credit memos and collects payments for
        posted invoices. Credit memos are only available if you have the Invoice
        Settlement feature enabled and negative charges exist. Credit memos will
        not be applied to invoices. If draft invoices and credit memos exist
        when you run this operation, this operation will post the invoices and
        credit memos. Note that draft credit memos created from an invoice or a
        product rate plan charge will not be posted.


        You can use this operation to generate invoices and collect payments on
        the posted invoices,
         or else simply collect payment on a specified existing
        invoice. The customer's default payment method is used, and the full

        amount due is collected. The operation depends on the parameters you

        specify.


        - To generate one or more new invoices for that customer and collect

        payment on the generated and other unpaid invoice(s), leave the
        **invoiceId** field empty. 


        - To collect payment on an existing invoice, specify the invoice ID. 



        The operation is atomic; if any part is unsuccessful, the entire

        operation is rolled back.


        When an error occurs, gateway reason codes and error messages are
        returned the error response of this operation. The following items are
        some gateway response code examples.


        - Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number`

        - Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card`  

        - CyberSource2: `202 Expired card`; `231 Invalid account number`


        For more reason code information, see the corresponding payment gateway
        documentation. 



        ### Notes


        Timeouts may occur when using this method on an account that

        has an extremely high number of subscriptions.
      operationId: POST_TransactionInvoicePayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTInvoiceCollectType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amountCollected: 801.73
                    creditMemos:
                      - id: 402890555a7e9791015a879f064a0054
                        totalAmount: 801.73
                        memoNumber: CM00000012
                    invoices:
                      - invoiceAmount: 801.73
                        invoiceId: 4028925a4cb74ec9014cb7540988002e
                        invoiceNumber: INV00000091
                    paymentId: 402892053e100406013e1024ab7c00e3
                    success: true
              schema:
                $ref: '#/components/schemas/POSTInvoiceCollectResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Invoice and collect
      tags:
        - Operations
  /v1/operations/jobs/{jobId}:
    get:
      description: >
        Retrieves information about a specific operation job.


        Currently, you can only use this API operation to retrieve the status
        information about invoice deletion and reversal operation jobs.
      operationId: GET_OperationJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID of the operation job to retrieve information about. For
            example, 2c92c8955bd63cc1015bd7c151af02ab.
          in: path
          name: jobId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 4028818484a949680184a95174cb0019
                    objectId: 4028818484a949680184a9510c960009
                    objectType: Invoice
                    operationType: Delete
                    status: Completed
                    success: true
              schema:
                $ref: '#/components/schemas/GetOperationJobResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an operation job
      tags:
        - Operations
  /v1/operations/bulk-pdf:
    post:
      description: >
        The background job that compresses large number of PDF(s) into ZIP
        files. For answers to frequently asked questions regarding exporting
        bulk PDF files, see <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/export-bulk-pdf-files/faqs"
        target="_blank">Export Bulk PDF Files FAQs</a>.

        **Note**: Do not include multiple objectIds with the same PDF file names
        in a single bulk PDF upload request.
      operationId: Create_BulkPDFToZIPGeneration
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTBulkPdfGenerationJobRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                jobId: 402880de8ce7edc3018ce7f18404312a
                jobName: BulkPDFGenerationJobV1
                status: Completed
                stepStatus: PostProcessing
                fileUrls: <s3-url>
                skippedDocuments:
                  - docType: Invoice
                    objectIds:
                      - 8a90a04d8e323748018e327b4a0825a0
                  - docType: CreditMemo
                    objectIds:
                      - 402880de8ce7edc3018ce7f18404315a
                createdBy: 2c92c8fb7a2d26b6017a2eaa64c72dea
                createdOn: '2024-04-19 05:19:32'
                success: true
              schema:
                $ref: '#/components/schemas/POSTBulkPdfGenerationJobResponseType'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              example:
                processId: processId
                reasons:
                  - code: '51580020'
                    message: >-
                      All Document IDs provided in this request were either
                      invalid or the billing document is not available.
                success: false
                requestId: d4b8c683-04ff-407d-964a-a63ae7917483
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Export bulk PDF files
      tags:
        - Operations
      x-accepts: application/json
      x-codegen-request-body-name: Request
      x-content-type: application/json
  /v1/operations/bulk-pdf/{jobId}:
    get:
      description: >-
        Retrieves information about the job which includes its status, message,
        and downloadable ZIP file URL link.
      operationId: Get_BulkPDFToZIPGeneration
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - description: >-
            The ID of the job for which information needs to be retrieved. For
            example, 2c92c8955bd63cc1015bd7c151af02ab
          in: path
          name: jobId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              example:
                jobId: 2c92c8955bd63cc1015bd7c151af02ab
                jobName: BulkPDFGenerationJobV1
                status: Completed
                stepStatus: PostProcessing
                fileUrls:
                  - >-
                    https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99
                  - >-
                    https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99
                createdOn: '2024-01-08 12:52:05'
                createdBy: caf630704a6f4100818601625ecffe0b
                success: true
              schema:
                $ref: '#/components/schemas/GETBulkpdfGenerationJobResponseType'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve information of a bulk PDF file generation job
      tags:
        - Operations
      x-accepts: application/json
  /v1/bill-runs:
    post:
      description: >
        Creates an ad-hoc bill run or a scheduled bill run. Support the
        following:
         - Create ad-hoc or scheduled bill runs by batch
         - Create ad-hoc or scheduled bill runs by account
         - Create a bill run by subscription
         - Create ad-hoc or scheduled bill runs by custom filter combining the Account, Subscription, and Rate Plan objects.
         
         To use this operation, you must have the <a href="https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles" target="_blank">Create Bill Runs billing permission</a>.

        **Notes**


        When using this operation to create bill runs, keep the following notes
        in mind:
          - When creating bill runs by batch, you must specify the `batches` field and do not specify `billRunFilters` field. When creating bill runs by account, subscription, or custom filter, you must specify the `billRunFilters` field and do not specify the `batches` field.
          - When creating bill runs by account, only one single account is allowed. All subscription under the account are picked up.
          - When creating a bill run by subscription, all subscriptions must belong to the same account. At most 50 subscriptions are allowed. 
          - If more than 500 bill runs created through this operation are in `Pending` status, you cannot use this operation to create any more bill runs.
      operationId: POST_CreateBillRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTCreateBillRunRequestType'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBillRunResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a bill run
      tags:
        - Bill Run
  /v1/bill-runs/{billRunId}:
    delete:
      description: >
        Deletes a bill run. You can only delete bill runs in `Canceled` or
        `Error` status. 
      operationId: DELETE_DeleteBillRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a bill run.
          in: path
          name: billRunId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBillRunResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a bill run
      tags:
        - Bill Run
    get:
      description: |
        Retrieves the information about a specific bill run.
      operationId: GET_BillRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a bill run.
          in: path
          name: billRunId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBillRunResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a bill run
      tags:
        - Bill Run
  /v1/bill-runs/{billRunId}/cancel:
    put:
      description: >
        Cancels a bill run in Draft status.


        When cancelling a scheduled bill run, keep the following information in
        mind:

        - If you set `cancelOnce` to `true`, only the current bill run is
        cancelled. The other future scheduled bill runs will be automatically
        executed based on the schedule.

        - If you set `cancelOnce` to `false`, all future recurring bill runs are
        cancelled.
      operationId: PUT_CancelBillRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a bill run.
          in: path
          name: billRunId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              example:
                cancelOnce: true
              properties:
                cancelOnce:
                  default: true
                  description: >
                    Whether to cancel the current bill run or cancel all future
                    recurring bill runs, only valid for a scheduled bill run.
                  type: boolean
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelBillRunResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a bill run
      tags:
        - Bill Run
  /v1/bill-runs/{billRunId}/post:
    put:
      description: >
        Posts a bill run asynchronously. To post a bill run, the current bill
        run must be in `Completed` status.


        When a bill run is being posted, its status is changed to
        `PostInProgress`. After all invoices for this bill run are posted, its
        status is changed to `Posted`.
      operationId: PUT_PostBillRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a bill run.
          in: path
          name: billRunId
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              example:
                invoiceDate: '2022-01-01'
              properties:
                invoiceDate:
                  description: >
                    The date that appears on the invoice being created, in
                    `yyyy-mm-dd` format. 


                    The value cannot fall in a closed accounting period.
                  format: date
                  type: string
              required:
                - invoiceDate
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBillRunResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Post a bill run
      tags:
        - Bill Run
  /v1/bill-runs/{billRunKey}/emails:
    post:
      description: >
        Manually emails all the billing documents that are generated from a
        specified bill run to your customers. 



        Bill runs can generate invoices and credit memos based on your [invoice
        and credit memo generation
        rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).
        Credit memos are only available if you have the Invoice Settlement
        feature enabled.



        Using this API operation, the billing documents are sent to the email
        addresses specified in the **To Email** field of the email templates.
        The email template used for each billing document is set in the
        **Delivery Options** panel of the **Edit notification** dialog from the
        Zuora UI. See [Edit Email
        Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)
        for more information about how to edit the **To Email** field in the
        email template.






        ### Notes
          - Even though no field is required in the Request body, you still need to specify `{}` in the request. Otherwise, an error will be returned.


          - You can only email posted billing documents.


          - You must activate the following notifications before emailing invoices and credit memos:
            - **Manual Email For Invoice | Manual Email For Invoice** 
            - **Email Credit Memo | Manually email Credit Memo**


          - To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.



          - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the following templates are used for billing documents:
            - Invoices: **Invoice Posted Default Email Template**
            - Credit memos: **Manual Email for Credit Memo Default Template**  

            See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.
      operationId: POST_EmailBillingDocumentsfromBillRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID or number of the bill run. For example,
            2c92c8f95d0c886e015d11287a8f0f8b or BR-00000001.
          in: path
          name: billRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTEmailBillingDocfromBillRunType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Email billing documents generated from a bill run
      tags:
        - Bill Run
  /v1/billing-preview-runs:
    post:
      description: >
        Creates a billing preview run for single and multiple customer accounts.


        The maximum supported preview duration is 20 years, calculated from the
        current date to the target date.


        You can run up to 20 billing preview runs in batches concurrently. A
        single batch of customer accounts can only have one billing preview run
        at a time. So you can have up to 20 batches running at the same time. If
        you create a billing preview run for all customer batches, you cannot
        create another billing preview run until this preview run is completed.


        **Note:** The preview results for each billing preview run will be
        stored in the system for 180 days; after that they will be purged.
      operationId: POST_BillingPreviewRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostBillingPreviewRunParam'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    billingPreviewRunId: 402890b757d1ec1b0157d5aa3d6802aa
                    success: true
              schema:
                properties:
                  billingPreviewRunId:
                    description: |
                      Id of the billing preview run.
                    type: string
                  success:
                    description: |
                      Returns `true` if the request was processed successfully.
                    type: boolean
                type: object
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a billing preview run
      tags:
        - Billing Preview Run
  /v1/billing-preview-runs/{billingPreviewRunId}:
    get:
      description: >
        Retrieves a preview of future invoice items for multiple customer
        accounts through a billing preview run. If you have the Invoice
        Settlement feature enabled,  you can also retrieve a preview of future
        credit memo items. The Invoice Settlement feature is generally available
        as of Zuora Billing Release 296 (March 2021). This feature includes
        Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.
        If you want to enable Invoice Settlement, see [Invoice Settlement
        Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        A billing preview run asynchronously generates a downloadable CSV file
        containing a preview of invoice item data and credit memo item data for
        a batch of customer accounts. Note that if you set `storageOption` to
        `Database`, no CSV file is generate; instead, you can have a record in
        the billing preview result. You can use data source to query <a
        href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference/Billing_Preview_Run_Result_data_source"
        target="_blank">Billing Preview Run Result</a>. 
      operationId: GET_BillingPreviewRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: |
            Id of the billing preview run.
          in: path
          name: billingPreviewRunId
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    assumeRenewal: Autorenew
                    batches: ''
                    chargeTypeToExclude: OneTime
                    createdById: 4028906d58240f960158241132be0003
                    createdDate: '2016-11-04 16:18:56'
                    endDate: '2016-11-04 16:19:00'
                    errorMessage: null
                    includingDraftItems: false
                    includingEvergreenSubscription: true
                    resultFileUrl: >-
                      https://rest.zuora.com/v1/files/4028906d582d21a101582e6b663c0a65
                    runNumber: BPR-00000010
                    startDate: '2016-11-04 16:19:00'
                    status: Completed
                    succeededAccounts: 7
                    success: true
                    targetDate: '2016-12-01'
                    totalAccounts: 7
                    updatedById: 4028906d58240f960158241132be0003
                    updatedDate: '2016-11-04 16:19:00'
              schema:
                $ref: '#/components/schemas/GetBillingPreviewRunResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a billing preview run
      tags:
        - Billing Preview Run
  /v1/payment-methods:
    post:
      description: >
        You can use this operation to create either a payment method associated 

        with a specific customer account, or an orphan payment method that is
        not associated

        with any customer account.


        To view the applicable fields for each payment method type, select the
        payment method type from the `type` list.

        The following types of the payment methods are supported:

          * `CreditCard` - Credit card payment method.

          * `CreditCardReferenceTransaction` - Credit Card Reference
          Transaction. See [Supported payment
          methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods)
          for payment gateways that support this type of payment method.

          * `ACH` - ACH payment method.

          * `SEPA` - Single Euro Payments Area.

          * `Betalingsservice` - Direct Debit DK.

          * `Autogiro` - Direct Debit SE.

          * `Bacs` - Direct Debit UK.

          * `Becs` - Direct Entry AU.

          * `Becsnz` - Direct Debit NZ.

          * `PAD` - Pre-Authorized Debit.

          * `PayPalCP` - PayPal Commerce Platform payment method. Use this type
          if you are using a [PayPal Commerce Platform
          Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway)
          instance.

          * `PayPalEC` - PayPal Express Checkout payment method. Use this type
          if you are using a [PayPal Payflow Pro
          Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway)
          instance.

          * `PayPalNativeEC` - PayPal Native Express Checkout payment method.
          Use this type if you are using a [PayPal Express Checkout
          Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway)
          instance.

          * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if
          you are using a [PayPal Adaptive Payment
          Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway)
          instance.

          * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up
          Adyen Apple
          Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay)
          for details.

          * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up
          Adyen Google
          Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay)
          for details.

          * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway
          integration. See [Set up Google Pay on
          Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase)
          for details. 

         * `AmazonPay` - Amazon Pay integration. 

        The fields marked as `required` must be specified when creating
        non-tokenized payment methods. 

        For more information about the required fields for the tokenization of
        payment methods, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
        target="_blank">Create tokenized payment methods with existing tokens or
        account information</a>.
      operationId: POST_PaymentMethods
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c92a09650a7a80a0150ab50a5b746bd
                    success: true
              schema:
                $ref: '#/components/schemas/POSTPaymentMethodResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a payment method
      tags:
        - Payment Methods
  /v1/payment-methods/decryption:
    post:
      description: >
        The decryption API endpoint can conditionally perform 4 tasks in one
        atomic call:
          * Decrypt Apple Pay Payment token
          * Create Credit Card Payment Method in Zuora with decrypted Apple Pay information
          * Create a stored credential profile within the Apple Pay payment method
          * Process Payment on a specified Invoice (optional)
      operationId: POST_PaymentMethodsDecryption
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPaymentMethodDecryption'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    paymentMethodId: 2c92c8f83dcbd8b1013dcce1d6a600ce
                    success: true
              schema:
                $ref: '#/components/schemas/POSTPaymentMethodResponseDecryption'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an Apple Pay payment method
      tags:
        - Payment Methods
  /v1/payment-methods/{payment-method-id}:
    delete:
      description: |
        Deletes a credit card payment method.

        If the specified payment method is the account's default payment
        method, the request will fail.  In that case, you must first designate a
        different payment method for that customer to be the default.
      operationId: DELETE_PaymentMethods
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            Unique identifier of a payment method. (Since this ID is unique, and
            linked to a customer account in the system, no customer identifier
            is needed.)
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a payment method
      tags:
        - Payment Methods
    get:
      description: >
        Use this operation to get the detailed information of an electronic
        payment method. To retrieve information of both electronic and
        non-electronic payment methods, use the [Object
        Query](https://developer.zuora.com/v1-api-reference/api/operation/queryPaymentMethodByKey/)
        operation.


        **Note:** This operation also supports retrieving the custom payment
        method created through the [Open Payment
        Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
        service.
      operationId: GET_PaymentMethod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Unique ID of the payment method to update.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    AA_PICKLIST__c: null
                    accountHolderInfo:
                      accountHolderName: John Smith
                      addressLine1: ABC
                      addressLine2: EFT
                      city: Example City
                      country: United States
                      email: example@google.com
                      phone: '86123456789'
                      state: Example State
                      zipCode: '844000'
                    accountKey: 4028839f7ca29000017ca29c1ce8003f
                    bankIdentificationNumber: '411111'
                    cardBinInfo:
                      brand: Visa
                      cardClass: Credit
                      productType: Consumer_Card
                      issuer: JPMORGAN CHASE BANK N.A.
                      issuingCountryCode: US
                    cardNumber: '************1111'
                    createdBy: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2021-11-15 18:59:08'
                    creditCardType: Visa
                    deviceSessionId: null
                    existingMandate: null
                    expirationMonth: 11
                    expirationYear: 2027
                    id: 4028839f7d26a155017d26af16ef0001
                    identityNumber: '97370192024'
                    ipAddress: null
                    isDefault: true
                    lastFailedSaleTransactionDate: null
                    lastTransaction: Approved
                    lastTransactionDateTime: '2021-11-15 18:59:08'
                    lastTransactionStatus: Approved
                    mandateInfo:
                      mitConsentAgreementRef: null
                      mitConsentAgreementSrc: null
                      mitProfileAction: null
                      mitProfileAgreedOn: null
                      mitProfileType: null
                      mitTransactionId: null
                    maxConsecutivePaymentFailures: null
                    numConsecutiveFailures: 0
                    paymentRetryWindow: null
                    status: Active
                    success: true
                    totalNumberOfErrorPayments: 0
                    totalNumberOfProcessedPayments: 0
                    type: CreditCard
                    updatedBy: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2021-11-15 18:59:08'
                    useDefaultRetryRule: true
              schema:
                $ref: '#/components/schemas/GETPaymentMethodResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a payment method
      tags:
        - Payment Methods
    put:
      description: >
        This operation allows you to update an existing payment method.


        The following fields in the request body can be updated for any payment
        method types:
          - `maxConsecutivePaymentFailures`
          - `paymentRetryWindow`
          - `useDefaultRetryRule`


        The following fields in the request body can be updated for any payment
        method types 

        except for Credit Card Reference Transaction payment methods:
          - `authGateway`
          - `accountHolderInfo`
          - `gatewayOptions`
          - `ipAddress`
          - Custom fields

        The following fields in the request body can be updated only for Credit
        Card payment methods:
          - `expirationMonth`
          - `expirationYear`
          - `securityCode`

        The following field in the request body can be updated for Credit Card,
        Credit Card Reference Transaction, ACH, and

        Bank Transfer payment methods:
          - `mandateInfo`
      operationId: PUT_PaymentMethod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Unique ID of the payment method to update.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPaymentMethodRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 2c92c0f86c99b4eb016cae1ee301728f
                    success: true
              schema:
                $ref: '#/components/schemas/PUTPaymentMethodResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a payment method
      tags:
        - Payment Methods
  /v1/payment-methods/{payment-method-id}/verify:
    put:
      description: >
        Sends an authorization request to the corresponding payment gateway to
        verify the payment method, even though no changes are made for the
        payment method. Supported payment methods are Credit Cards and Paypal.


        Zuora now supports performing a standalone zero dollar verification or
        one dollar authorization for credit cards. It also supports a billing
        agreement status check on PayPal payment methods.


        If a payment method is created by Hosted Payment Pages and is not
        assigned to any billing account, the payment method cannot be verified
        through this operation.
      operationId: PUT_VerifyPaymentMethods
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID of the payment method to be verified.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTVerifyPaymentMethodType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    paymentMethodId: 402890765d9ce329015da18034ee0057
                    success: true
              schema:
                $ref: '#/components/schemas/PUTVerifyPaymentMethodResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Verify a payment method
      tags:
        - Payment Methods
  /v1/payment-methods/{payment-method-id}/scrub:
    put:
      description: >

        This operation enables you to replace all sensitive data in a payment
        method, related payment method snapshot table, and four related log
        tables with dummy values that will be stored in Zuora databases. 


        This operation will scrub the sensitive data and soft-delete the
        specified payment method at the same time. 


        If you want to delete or anonymize personal data in Zuora, you must
        scrub the payment method before anonymizing the associated account and
        contact. See [Delete or anonymize personal
        data](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Responding_to_individual_requests_for_access%2C_correction%2C_and_deletion_of_data_under_applicable_privacy_laws#Edit_and_correct_personal_data)
        for more information.


        **Note:** In order to use this operation, you must ensure that the
        **Scrub Sensitive Data of Specific Payment Method payments** permission
        is enabled in your user role. Contact your tenant administrator if you
        want to enable this permission. See [Scrub Payment
        Methods](https://knowledgecenter.zuora.com/CB_Billing/L_Payment_Methods/Scrub_Payment_Methods)
        for more information.
      operationId: PUT_ScrubPaymentMethods
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID of the payment method where you want to scrub the sensitive
            data.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Scrub a payment method
      tags:
        - Payment Methods
  /v1/payment-methods/{payment-method-id}/balance:
    get:
      summary: Retrieve the balance of a bank account
      tags:
        - Payment Methods
      description: >
        Zuora supports Plaid's Auth and Balance products for ACH transactions. 

        Auth authenticates account details before sending requests to the
        gateway, 

        while Balance checks the real-time account balance before transactions. 

        Use this API operation to implement the integration with Plaid Balance
        manually.


        Before you use this API operation, ensure that the support for Plaid
        Auth and Balance is enabled. 

        For more information, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/Enable_the_support_for_Plaid_account_validation_solution"
        target="_blank">Enable the support for Plaid account validation
        solution</a>.
      operationId: getBankAccountBalance
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            The unique ID of the payment method, such as
            `40289f3291d2587b0191d280fa20012g`.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    currency: USD
                    availableBalance: 100
                    currentBalance: 110.55
              schema:
                $ref: '#/components/schemas/GetBankAccountBalanceResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: Only ACH payment method is supported to check balance.
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /v1/payment-methods/{payment-method-id}/profiles:
    get:
      description: |
        Retrieves the stored credential profiles within a payment method.
      operationId: GET_StoredCredentialProfiles
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            ID of a payment method.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - description: >
            Specifies whether to retrieve all the stored credential profiles
            within the payment method.


            By default, Zuora returns only the stored credential profiles with
            `Agreed` or `Active` status. If you set this parameter to `true`,
            Zuora returns all the stored credential profiles.
          in: query
          name: includeAll
          schema:
            default: false
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    profiles:
                      - activatedOn: '2019-03-06 07:45:55'
                        agreedOn: '2019-03-06 07:45:55'
                        brand: Visa
                        cancelledOn: '2019-03-13 07:52:16'
                        consentAgreementRef: ACCT1338AgreementV1.pdf
                        consentAgreementSrc: External
                        expiredOn: null
                        number: 1
                        paymentMethodId: 402881836953a3c7016953aec290000d
                        status: Cancelled
                        type: Recurring
                      - activatedOn: '2019-03-13 07:55:08'
                        agreedOn: '2019-03-13 07:55:08'
                        brand: Visa
                        cancelledOn: null
                        consentAgreementRef: ACCT1338AgreementV2.pdf
                        consentAgreementSrc: External
                        expiredOn: null
                        number: 2
                        paymentMethodId: 402881836953a3c7016953aec290000d
                        status: Active
                        type: Recurring
                    success: true
              schema:
                $ref: '#/components/schemas/GetStoredCredentialProfilesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List stored credential profiles of a payment method
      tags:
        - Payment Methods
    post:
      description: >
        Creates a stored credential profile within a payment method.


        The stored credential profile represents a consent agreement that you
        have established with a customer. When you use the payment method in a
        transaction, Zuora may include information from the stored credential
        profile to inform the payment processor that the transaction is related
        to your pre-existing consent agreement with the customer.
      operationId: POST_CreateStoredCredentialProfile
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            ID of a payment method.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStoredCredentialProfileRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    number: 3
                    paymentMethodId: 402881836953a3c7016953aec290000d
                    success: true
              schema:
                $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a stored credential profile
      tags:
        - Payment Methods
  /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel:
    post:
      description: >
        Cancels a stored credential profile within a payment method.


        Cancelling the stored credential profile indicates that the stored
        credentials are no longer valid, per a customer request. You cannot
        reactivate the stored credential profile after you have cancelled it.
      operationId: POST_CancelStoredCredentialProfile
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            ID of a payment method.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - description: >
            Number that identifies a stored credential profile within the
            payment method.
          in: path
          name: profile-number
          required: true
          schema:
            type: integer
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    number: 1
                    paymentMethodId: 402881836953a3c7016953aec290000d
                    success: true
              schema:
                $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a stored credential profile
      tags:
        - Payment Methods
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            6d151216ef504f65b8ff6e9e9e8356d3"
            "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel"
  /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire:
    post:
      description: >
        Expires a stored credential profile within a payment method.


        Expiring the stored credential profile indicates that the stored
        credentials are no longer valid, per an expiration policy in the stored
        credential transaction framework. You cannot reactivate the stored
        credential profile after you have expired it.
      operationId: POST_ExpireStoredCredentialProfile
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            ID of a payment method.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - description: >
            Number that identifies a stored credential profile within the
            payment method.
          in: path
          name: profile-number
          required: true
          schema:
            type: integer
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    number: 2
                    paymentMethodId: 402881836953a3c7016953aec290000d
                    success: true
              schema:
                $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Expire a stored credential profile
      tags:
        - Payment Methods
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            6d151216ef504f65b8ff6e9e9e8356d3"
            "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire"
  /v1/payment-methods/apple-pay/domains:
    get:
      description: >
        Use this operation to retrieve details of your domains that are already
        registered with Apple for Apple Pay button integration implemented
        through Zuora's JavaScript SDK.


        You can use `domainName` as the query parameter to restrict domains
        returned in the response. Specify a domain name and the registered
        domains containing the specified domain name will be returned.


        For more information about Zuora's JavaScript SDK for Apple Pay
        integration, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for_gateway_integrations_other_than_Adyen_Integration_v2.0"
        target="_blank">Set up Apple Pay through the JavaScript SDK
        approach</a>.
      operationId: GET_ListApplePayDomains
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Specifies a domain name such as `zuora.com` and the registered
            domains containing the specified domain name will be returned. 


            For example, `test1.zuora.com` and `test2.zuora.com` are two
            registered domains, but `zuora.com` is not registered. If you
            specify `zuora.com` in this query field, the data of
            `test1.zuora.com` and `test2.zuora.com` will be returned.
          in: query
          name: domainName
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    domains:
                      - createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdOn: '2023-07-05 00:44:51'
                        domainName: testapplepay.zuora.com
                        domainVerified: true
                        id: 402881a38924ff1001892502da090021
                        updatedBy: 402881e522cf4f9b0122cf5d82860002
                        updatedOn: '2023-07-05 00:44:51'
                      - createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdOn: '2023-07-04 01:02:12'
                        domainName: test1.zuora.com
                        domainVerified: false
                        id: 402881a3891fe7b401891fec61d40036
                        updatedBy: 402881e522cf4f9b0122cf5d82860002
                        updatedOn: '2023-07-04 01:02:12'
                    success: true
              schema:
                $ref: '#/components/schemas/GETListApplePayDomainsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List registered Apple Pay domains
      tags:
        - Payment Methods
    post:
      description: >
        Before adding Apple Pay to your checkout flow by integrating with the
        JavaScript SDK provided by Zuora, your domains that will show the Apple
        Pay button must be registered with Apple. Use this operation to register
        a domain. 


        For more information about Zuora's JavaScript SDK for Apple Pay
        integration, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for_gateway_integrations_other_than_Adyen_Integration_v2.0"
        target="_blank">Set up Apple Pay through the JavaScript SDK
        approach</a>.
      operationId: POST_RegisterApplePayDomain
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTRegisterApplePayDomainRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    domainName: testapplepay.zuora.com
                    domainVerified: true
                    id: 402881a38924ff1001892502da090021
                    success: true
              schema:
                $ref: '#/components/schemas/POSTRegisterApplePayDomainResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Register an Apple Pay domain
      tags:
        - Payment Methods
  /v1/payment-methods/apple-pay/domains/{id}:
    delete:
      description: >
        Use this operation to unregister a domain with Apple for Apple Pay
        button integration implemented through Zuora's JavaScript SDK.


        For more information about Zuora's JavaScript SDK for Apple Pay
        integration, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B_Define_Payment_Methods/Set_up_Apple_Pay_for_gateway_integrations_other_than_Adyen_Integration_v2.0"
        target="_blank">Set up Apple Pay through the JavaScript SDK
        approach</a>.
      operationId: DELETE_UnregisterApplePayDomain
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the domain, such as `402881a38924ff1001892502da090021`.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/DELETEUnresigerApplePayDomainResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Unregister an Apple Pay domain
      tags:
        - Payment Methods
  /web-payments/sessions:
    post:
      description: >
        Use this operation to create a payment session on your server side. 

        The response contains a token for the payment session data. 


        In addition to the required `accountId` and `currency` fields, you can
        specify the following fields 

        to define the payment flow mode as one of the following:
          - Create and save a payment method:
              - `processPayment`: `false`
              - `storePaymentMethod`: `true`
              - `amount`
          - Process a one-time payment without saving the payment method:
              - `processPayment`: `true`
              - `storePaymentMethod`: `false`
              - `amount` or `invoices` + `amount`
          - Process the first payment and save the payment method for subsequent recurring payments:
              - `processPayment`: `true`
              - `storePaymentMethod`: `true`
              - `amount` or `invoices` + `amount`

        For more information, see the following articles:
          - <a href="https://developer.zuora.com/docs/get-started/tutorials/payment-form/" target="_blank">Payment Form Implementation Guide</a>
          - <a href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B1_Define_Payment_Methods#Set_up_a_payment_method_through_JavaScript_SDK_integration" target="_blank">Set up a payment method through JavaScript SDK integration</a>
          - <a href="https://knowledgecenter.zuora.com/Zuora_Payments/Manage_payment_gateway_integrations_and_payment_methods/Set_up_payment_gateway_integrations/Alipay_Payment_Gateway/Set_up_Alipay_payment_methods_with_Zuora_JavaScript_SDK" target="_blank">Set up Alipay payment methods with Zuora JavaScript SDK</a>
      operationId: POST_CreatePaymentSession
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTCreatePaymentSessionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    token: LTljuuLaDQnHxeVpWaX6zq2xY2FJ6sSE
              schema:
                $ref: '#/components/schemas/POSTCreatePaymentSessionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a payment session
      tags:
        - Payment Methods
  /v1/object/payment-method-snapshot/{id}:
    get:
      description: >
        This REST API reference describes how to retrieve a Payment Method
        Snapshot.


        A Payment Method Snapshot is a copy of the particular Payment Method
        used in a transaction. If the Payment Method is deleted, the Payment
        Method Snapshot continues to retain the data used in each of the past
        transactions.


        ### Notes

        The following Payment Method fields are not available in Payment Method
        Snapshots:


        * `Active`

        * `AchAddress1`

        * `AchAddress2`

        * `CreatedById`

        * `CreatedDate`

        * `UpdatedById`

        * `UpdatedDate`


        The Payment Method Snapshot field `PaymentMethodId` is not available in
        Payment Methods.
      operationId: Object_GETPaymentMethodSnapshot
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    AccountId: 2c93808457d787030157e0314c0945d4
                    BankIdentificationNumber: '411111'
                    CompanyName: ''
                    CreditCardAddress1: 312 2nd Ave W
                    CreditCardCity: Seattle
                    CreditCardCountry: United States
                    CreditCardExpirationMonth: 12
                    CreditCardExpirationYear: 2020
                    CreditCardHolderName: Somebody
                    CreditCardMaskNumber: '************1111'
                    CreditCardPostalCode: '98119'
                    CreditCardState: Washington
                    CreditCardType: Visa
                    Id: 2c93808457d787030157e0314f2245d8
                    IdentityNumber: ''
                    IsCompany: false
                    NumConsecutiveFailures: 0
                    PaymentMethodId: 2c93808457d787030157e0314e8145d7
                    PaymentMethodStatus: Active
                    TotalNumberOfErrorPayments: 0
                    TotalNumberOfProcessedPayments: 0
                    Type: CreditCard
                    UseDefaultRetryRule: true
              schema:
                $ref: '#/components/schemas/ProxyGetPaymentMethodSnapshot'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a payment method snapshot'
      tags:
        - Payment Method Snapshots
  /v1/object/payment-method-transaction-log/{id}:
    get:
      description: Retrieves a Payment Method Transaction Log object.
      operationId: Object_GETPaymentMethodTransactionLog
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyGetPaymentMethodTransactionLog'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a payment method transaction log'
      tags:
        - Payment Method Transaction Logs
  /v1/payment-method-updaters:
    get:
      description: >
        Retrieves the detailed information of all Payment Method Updater (PMU)
        instances on your tenant, except for American Express (AMEX).
      operationId: GET_PaymentMethodUpdaterInstances
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    updaters:
                      - daysToUpdateBeforeBcd: 7
                        id: 418734b01fbb11ee821f0e4e5eec84cf
                        isActive: true
                        isDefault: true
                        isTest: true
                        processAssociatedGwOnly: true
                        processAutopayDefaultPmOnly: true
                        processMastercard: true
                        processVisa: true
                        updaterGatewayType: CyberSource
                        updaterName: CyberSourceUpdater
                      - daysToUpdateBeforeBcd: 8
                        id: 418739741fbb11ee821f0e4e5eec84cf
                        isActive: true
                        isDefault: false
                        isTest: true
                        processAssociatedGwOnly: true
                        processAutopayDefaultPmOnly: true
                        processMastercard: true
                        processVisa: true
                        updaterGatewayType: WorldPay
                        updaterName: WorldPayUpdater
              schema:
                $ref: '#/components/schemas/GETPaymentMethodUpdaterInstancesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List Payment Method Updater instances
      tags:
        - Payment Method Updater
  /v1/payment-method-updaters/batches:
    post:
      description: >
        Creates a Payment Method Updater (PMU) batch asynchronously. PMU for
        American Express (AMEX) is not supported.
      operationId: POST_PaymentMethodUpdaterBatch
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPaymentMethodUpdaterBatchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/POSTPaymentMethodUpdaterResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a Payment Method Updater batch asynchronously
      tags:
        - Payment Method Updater
  /v1/rsa-signatures:
    post:
      description: >
        The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource
        Sharing) enabled and therefore requires a digital signature. The POST
        rsa_signatures call generates and returns the required digital signature
        and token for a Payment Pages 2.0 form. You need to pass the generated
        signature to your client for it to access Payment Pages 2.0. 
            
        This REST service should be used only when you implement Payment Pages
        2.0. 


        **Note:** To avoid potential credit card fraud attacks, you should
        secure your Payment Pages from being accessed by fraudulent users before
        you issue client-side digital signatures and tokens. See [Manage Token
        Issuance](https://knowledgecenter.zuora.com/CB_Billing/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Manage_Token_Issuance)
        for more information.


        **Troubleshooting tip:** After you use this operation to generate an RSA
        signature, if `signature` returns `null` but `token` is successfully
        returned, please limit the number of the fields in your request to make
        sure that the maximum length supported by the RSA signature algorithm is
        not exceeded. The calculation of the request length is determined by the
        number of the parameters, and the length of each of the parameter name
        and its value.
      operationId: POST_RSASignatures
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTRSASignatureType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    key: >-
                      MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB
                    signature: >-
                      VpCAFL2hHC2irxbhWYGLJmdBigjARsCStwHZiQ78z5LyVuBCFr2lkie0db/7E8n38MXaq12Ng5As5Qj+9Nhz6RBsSEWLod7c7hvwNI28OcgBZtcV/wscbWU69EP/+/XrQnF3ZUbHbqmcmhE8C/zNnc2zvHckfArroDW2HxxmATfMJS0xKUm5TrHi4tiILZVMYY1KIUqQTyuXV6uRWYzkqMkFkZDNCxSxf0XwzuBI/VOgTCmFZb0c3+bk/q6+7d/azFCrrg8C3dquCNJRfUeaBou+SLUa4TW3hV4rGd2zpvSrD/425x4qFNGV6JQ7wvIleIdrXU4qbh9nCmYoApMODA==
                    success: true
                    tenantId: '12270'
                    token: E2BJEle7YrAlw93SjkaKthTmzMvXF341
              schema:
                $ref: '#/components/schemas/POSTRSASignatureResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Generate an RSA signature
      tags:
        - RSA Signatures
  /v1/rsa-signatures/decrypt:
    post:
      description: >
        The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource
        Sharing) enabled and therefore requires a digital signature. You use
        rsa_signatures to generate the required digital signature and token for
        a Payment Pages 2.0 form, and then you use the decrypt REST service to
        decrypt the signature to validate the signature and key.


        This REST service should be used only when you implement Payment Pages
        2.0. 
      operationId: POST_DecryptRSASignatures
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTDecryptionType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    decryptedSignature: >-
                      /apps/publichostedpagelite.do#12270#tpyeSbjfUdpZpY4EMSCy7CrupvuhIdvM#1473658419005#2c92c0f855e2b4630155ec9e6a1b6eec
                    publicKey: >-
                      MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB
                    signature: >-
                      BeNYuHFkp/sbfm3clYyCkKEqd7XVTRDOJ1/5rL0tpkqxiSq+maqYkDz5kA+lN64ipoefQuJ7Rdm5TpICErufeJfa2sfTmGARDJ0hr+StXfLsIxHmDoNH5dqcXv3W6MR4kaljEqPVuhzGQ0We98DG52JcHWqqN53oHwTyuZuXocQqnmiE23IPm8UrU3g4hX/OLat0R81wDQ1SslZ+4pnqlncpTpopCK4FxeG3B0gYMhZcYd17Cmf0N3tEHVXHDlJIm4rOx0OVT+YBnjbKYLM0jxYu7PRKRis+yzN1BoappOEB0gmPjznIeiYF0u/fJdZWoEwK7d9mrfJeOBbpFyRoHA==
                    success: true
              schema:
                $ref: '#/components/schemas/POSTDecryptResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Decrypt an RSA signature
      tags:
        - RSA Signatures
  /v1/hostedpages:
    get:
      description: >
        Returns the Payment Pages configuration metadata,

        specifically, page ID, page version, payment method type.


        The following are the version-specific and general REST requests for
        Payment Pages:


        * The request for Payment Pages 2.0 configuration information: `GET
        <BaseURL>/hostedpages?version=2`

        * The request for all versions of Payment Pages configuration
        information: `GET <BaseURL>/hostedpages`


        ### Notes

        If you do not have the corresponding tenant setting enabled, such as
        specifying the request `version` parameter to 2 but disabliing Payment
        Pages 2.0, you will receive an error.
      operationId: Get_HostedPages
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Version of the Payment Pages for which you want to retrieve the
            configuration information. Specify 2 for Payment Pages 2.0.
          in: query
          name: versionNumber
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    hostedpages:
                      - pageId: 8a85858f49a3f2230149abccaa2e004a
                        pageType: ACH
                        pageVersion: 2
                      - pageId: 8a85858f49a3f2230149abcd99090057
                        pageType: Bank Transfer
                        pageVersion: 2
                      - pageId: 8a85858f49a3f2230149a71083d40019
                        pageType: Credit Card
                        pageVersion: 2
                    success: true
              schema:
                $ref: '#/components/schemas/GetHostedPagesType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List hosted pages
      tags:
        - Hosted Pages
  /open-payment-method-types:
    post:
      description: >
        Creates a draft version of a custom payment method type. Revision number
        1 is assigned to this version. You can update your draft version through
        the [Update a custom payment method
        type](https://developer.zuora.com/api-references/api/operation/PUT_UpdateOpenPaymentMethodType/)
        operation. You must publish your draft version through the [Publish a
        custom payment method
        type](https://developer.zuora.com/api-references/api/operation/PUT_PublishOpenPaymentMethodType/)
        operation before your custom payment method type goes live.
      operationId: POST_CreateDraftOpenPaymentMethodType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTCreateOpenPaymentMethodTypeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    paymentMethodType: AmazonPay__C_12368
                    publishDate: ''
                    revision: 1
                    status: Draft
              schema:
                $ref: '#/components/schemas/POSTCreateOpenPaymentMethodTypeResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a draft custom payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/publish/{paymentMethodTypeName}:
    put:
      description: >
        Publish the latest draft revision of a specific custom payment method
        type.
      operationId: PUT_PublishOpenPaymentMethodType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The API name of the custom payment method type, such as
            `AmazonPay__c_12368`.
          in: path
          name: paymentMethodTypeName
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    entityId: ''
                    fields:
                      - checksum: true
                        defaultValue: null
                        description: The Token value
                        editable: true
                        index: 1
                        label: AmazonToken
                        maxLength: 100
                        minLength: 1
                        name: AmazonToken
                        representer: true
                        required: true
                        type: string
                        visible: true
                      - checksum: true
                        defaultValue: null
                        description: The Type of Token, e.g. GoCardlessToken
                        editable: true
                        index: 2
                        label: Amazon TokenType
                        maxLength: 100
                        minLength: 1
                        name: AmazonTokenType
                        representer: true
                        required: true
                        type: string
                        visible: true
                    internalName: AmazonPay
                    label: ZuoraQA Amazon Pay
                    methodReferenceIdField: AmazonToken
                    revision: 1
                    status: Published
                    subTypeField: AmazonTokenType
                    tenantId: '9'
                    userReferenceIdField: AmazonAccount
                    version: '2021-11-22'
              schema:
                $ref: '#/components/schemas/PUTPublishOpenPaymentMethodTypeResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Publish a custom payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/{paymentMethodTypeName}:
    put:
      description: >
        Update the latest draft version of your custom payment method type. If
        the latest draft version has been published, the revision number is
        increased by 1 after the draft version is updated. You must publish your
        latest revision again through the [Publish a custom payment method
        type](https://developer.zuora.com/api-references/api/operation/PUT_PublishOpenPaymentMethodType/)
        operation before your updated custom payment method type goes live.


        **Note**: In the request body, provide all the fields that define this
        custom payment method type including fields to be updated and the
        unchanged fields.
      operationId: PUT_UpdateOpenPaymentMethodType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The API name of the custom payment method type, such as
            `AmazonPay__c_12368`.
          in: path
          name: paymentMethodTypeName
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTUpdateOpenPaymentMethodTypeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    paymentMethodType: AmazonPay__c_12368
                    publishDate: ''
                    revision: 2
                    status: Draft
              schema:
                $ref: '#/components/schemas/PUTUpdateOpenPaymentMethodTypeResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a custom payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}:
    get:
      description: |
        Retrieves a specific draft revision of a custom payment method type.
      operationId: GET_OpenPaymentMethodTypeRevision
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The API name of the custom payment method type, such as
            `AmazonPay__c_12368`.
          in: path
          name: paymentMethodTypeName
          required: true
          schema:
            type: string
        - description: |
            The revision number of the draft revision to be retrieved.
          in: path
          name: revisionNumber
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    entityId: f707d981-3ad2-4484-9c24-a93bf6b83411
                    fields:
                      - checksum: true
                        defaultValue: null
                        description: The Token value
                        editable: true
                        index: 1
                        label: AmazonToken
                        maxLength: 100
                        minLength: 1
                        name: AmazonToken
                        representer: true
                        required: true
                        type: string
                        visible: true
                      - checksum: true
                        defaultValue: null
                        description: The Type of Token, e.g. GoCardlessToken
                        editable: true
                        index: 2
                        label: Amazon TokenType
                        maxLength: 100
                        minLength: 1
                        name: AmazonTokenType
                        representer: true
                        required: true
                        type: string
                        visible: true
                    internalName: AmazonPay
                    label: ZuoraQA Amazon Pay
                    methodReferenceIdField: AmazonToken
                    revision: 1
                    status: Published
                    subTypeField: AmazonTokenType
                    tenantId: '9'
                    userReferenceIdField: AmazonAccount
                    version: '2021-11-22'
              schema:
                $ref: '#/components/schemas/GETOpenPaymentMethodTypeRevisionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a specific draft revision of a custom payment method type
      tags:
        - Custom Payment Method Types
  /open-payment-method-types/{paymentMethodTypeName}/published:
    get:
      description: |
        Retrieves a published custom payment method type.
      operationId: GET_OpenPaymentMethodTypePublish
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The API name of the custom payment method type, such as
            `AmazonPay__c_12368`.
          in: path
          name: paymentMethodTypeName
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    entityId: f707d981-3ad2-4484-9c24-a93bf6b83411
                    fields:
                      - checksum: true
                        defaultValue: null
                        description: The Token value
                        editable: true
                        index: 1
                        label: AmazonToken
                        maxLength: 100
                        minLength: 1
                        name: AmazonToken
                        representer: true
                        required: true
                        type: string
                        visible: true
                      - checksum: true
                        defaultValue: null
                        description: The Type of Token, e.g. GoCardlessToken
                        editable: true
                        index: 2
                        label: Amazon TokenType
                        maxLength: 100
                        minLength: 1
                        name: AmazonTokenType
                        representer: true
                        required: true
                        type: string
                        visible: true
                    internalName: AmazonPay
                    label: ZuoraQA Amazon Pay
                    methodReferenceIdField: AmazonToken
                    revision: 1
                    status: Published
                    subTypeField: AmazonTokenType
                    tenantId: '9'
                    userReferenceIdField: AmazonAccount
                    version: '2021-11-22'
              schema:
                $ref: '#/components/schemas/GETOpenPaymentMethodTypeRevisionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a published custom payment method type
      tags:
        - Custom Payment Method Types
  /v1/payment-methods/{payment-method-id}/authorize:
    post:
      description: >
        Enables you to authorize the availability of funds for a transaction but
        delay the capture of funds until a later time. Subsequently, use [Create
        a
        payment](https://developer.zuora.com/api-references/api/operation/POST_CreatePayment)
        or [Create an
        order](https://developer.zuora.com/api-references/api/operation/POST_Order/)
        to capture the authorized funds, or use [Cancel
        authorization](https://developer.zuora.com/api-references/api/operation/POST_CancelAuthorization)
        to cancel the authorization. 


        For gateway integrations that support this operation, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DB_Delayed_Capture"
        target="_blank">Delayed Capture</a>.
              
      operationId: POST_CreateAuthorization
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of the payment method where the authorization is
            created.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTDelayAuthorizeCapture'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTAuthorizeResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create authorization
      tags:
        - Payment Authorization
  /v1/payment-methods/{payment-method-id}/voidAuthorize:
    post:
      description: >
        Allows you to cancel an authorization. For gateway integrations that
        support this operation, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DB_Delayed_Capture"
        target="_blank">Delayed Capture</a>.
      operationId: POST_CancelAuthorization
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of the payment method where the authorization is
            cancelled.
          in: path
          name: payment-method-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTVoidAuthorize'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTVoidAuthorizeResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel authorization
      tags:
        - Payment Authorization
  /v1/paymentgateways:
    get:
      description: |
        Retrieves the basic information about all the payment gateways.
      operationId: GET_Paymentgateways
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    paymentgateways:
                      - id: 4028905f5702783601570291e14c0015
                        isActive: true
                        isDefault: true
                        name: Test Gateway Adapter
                        type: Test Gateway
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentGatwaysResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all payment gateways
      tags:
        - Payment Gateways
  /v1/payment-gateways/pre-debit-notification:
    post:
      description: >
        To support processing recurring UPI payments through Adyen Integration
        v2.0, 

        a pre-debit notification for each posted invoice must be sent to the UPI
        users 

        before collecting the recurring payments. Use this operation to send
        pre-debit notification requests 

        to the gateway for invoices that meet the requirements. 

        See <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Payment_Gateway/I1_Implement_UPI_on_Adyen_Integration_v2.0#Recurring_payments_flow"
        target="_blank">Implement UPI on Adyen Integration v2.0</a> for more
        information.


        Before using this operation, ensure the following prerequisites are met:
          - <a href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Payment_Gateway/I1_Implement_UPI_on_Adyen_Integration_v2.0" target="_blank">Support for UPI transactions on Adyen</a> has been enabled. This is a feature that can be requested through the Specialized Payment Connections service at an additional cost.
          - Ensure the <a href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Payment_Gateway/I1_Implement_UPI_on_Adyen_Integration_v2.0#Recurring_payments_flow" target="_blank">conditions for triggering pre-debit notification requests</a> are met.
      operationId: triggerPreDebitNotification
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTriggerPreDebitNotificationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTriggerPreDebitNotificationResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 98F4A32E685BABCD
                    reasons:
                      - code: '52307120'
                        message: >-
                          Pre debit notification has already been sent for the
                          invoice with ID:c2289d0a8d3af0f2018d3b2b1fdb00b2
                    requestId: b74fe34e-083c-4386-8284-ce1685a00000
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Trigger a pre-debit notification
      tags:
        - Payment Gateways
  /v1/gateway-settlement/payments/{payment-key}/chargeback:
    post:
      description: >
        If the <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow"

        target="_blank">Asynchronous Payment Statuses</a> feature is not
        enabled, this

        API operation sets the Gateway State field of the payment to `Settled`,
        creates

        a refund for the amount specified in the request, and returns the Refund
        object

        as response.



        If the Asynchronous Payment Statuses feature is enabled, for ACH and
        Bank Transfer

        payments that are reversed before they are settled, this API operation
        sets the

        Payment Status field to `Processed`, sets the Gateway State field of the
        payment

        to `Settled`, creates an external refund for the amount specified in the
        request,

        and returns the Refund object as response.


        If the reason code "Payment Reversal" is active in the <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/Reason_Codes_for_Payment_Operations/B_Creating_and_Editing_Reason_Codes"

        target="_blank">Reason Codes</a> list, the reason code of the external
        refund is set to "Payment Reversal". Otherwise, the default reason code
        in the list is used.
      operationId: POST_ReversePayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The payment number starting with "P-" or the unique payment ID.
          in: path
          name: payment-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTReversePaymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad0987e92f64ccb01931a35c06b46d6
                    number: R-00000027
                    status: Processed
                    type: External
                    methodType: CreditCard
                    accountId: 8ad09bce83f1da020183f97e245c1c47
                    amount: 10
                    refundDate: '2024-11-11'
                    comment: null
                    paymentMethodId: 8ad09bce83f1da020183f97e24821c4b
                    paymentMethodSnapshotId: null
                    paymentId: 8ad0943792d670bc0192dc396bac151f
                    paymentNumber: P-00001538
                    creditMemoId: null
                    reasonCode: Payment Reversal
                    gatewayId: null
                    paymentGatewayNumber: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: Settled
                    markedForSubmissionOn: null
                    referenceId: null
                    secondRefundReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: null
                    settledOn: '2024-11-11 15:52:30'
                    cancelledOn: null
                    createdDate: '2024-11-11 15:52:30'
                    createdById: 8ad084a67f9c7138017fab8a8b511b5a
                    updatedDate: '2024-11-11 15:52:30'
                    updatedById: 8ad084a67f9c7138017fab8a8b511b5a
                    refundTransactionTime: null
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: Accounts Receivable
                      unappliedPaymentAccountingCodeType: AccountsReceivable
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/POSTReversePaymentResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Reverse a payment
      tags:
        - Payment Gateway Reconciliation
  /v1/gateway-settlement/payments/{payment-key}/reject:
    post:
      description: >
        If the <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow"

        target="_blank">Asynchronous Payment Statuses</a> feature is not
        enabled, this

        API operation sets the Gateway State field of the payment to
        `FailedToSettle`,

        creates a refund for the payment amount, and returns the Refund object
        as response.



        If the Asynchronous Payment Statuses feature is enabled, for ACH and
        Bank Transfer

        payments, this API operation sets the Payment Status field to `Error`
        and the

        Gateway State field to `FailedToSettle`, and unapply the payment if it
        is already

        applied.


        If the reason code "Payment Rejection" is active in the <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/Reason_Codes_for_Payment_Operations/B_Creating_and_Editing_Reason_Codes"

        target="_blank">Reason Codes</a> list, the reason code of the external
        refund is set to "Payment Rejection". Otherwise, the default reason code
        in the list is used.
      operationId: POST_RejectPayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The payment number starting with "P-" or the unique payment ID.
          in: path
          name: payment-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTRejectPaymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad0875992e093310192e70ccaa0589b
                    number: R-00000026
                    status: Processed
                    type: External
                    methodType: CreditCard
                    accountId: 8ad09bce83f1da020183f97e245c1c47
                    amount: 10
                    refundDate: '2024-11-01'
                    comment: null
                    paymentMethodId: 8ad09bce83f1da020183f97e24821c4b
                    paymentMethodSnapshotId: null
                    paymentId: 8ad0987e92e0a44a0192e646f4de27b1
                    paymentNumber: P-00001539
                    creditMemoId: null
                    reasonCode: Payment Rejection
                    gatewayId: null
                    paymentGatewayNumber: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: Settled
                    markedForSubmissionOn: null
                    referenceId: null
                    secondRefundReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: null
                    settledOn: '2024-11-01 17:27:08'
                    cancelledOn: null
                    createdDate: '2024-11-01 17:27:08'
                    createdById: 8ad084a67f9c7138017fab8a8b511b5a
                    updatedDate: '2024-11-01 17:27:08'
                    updatedById: 8ad084a67f9c7138017fab8a8b511b5a
                    refundTransactionTime: null
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: Accounts Receivable
                      unappliedPaymentAccountingCodeType: AccountsReceivable
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/POSTRejectPaymentResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Reject a payment
      tags:
        - Payment Gateway Reconciliation
  /v1/gateway-settlement/payments/{payment-key}/settle:
    post:
      description: >
        If the <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow"
        target="_blank">Asynchronous Payment Statuses</a> feature is not
        enabled, this API operation sets the Gateway State field of the payment
        to `Settled` and returns the Payment object as response.


        If the Asynchronous Payment Statuses feature is enabled, for ACH and
        Bank Transfer payments, this API operation sets the Payment Status field
        to `Processed` and the Gateway State field to `Settled`.
      operationId: POST_SettlePayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The payment number starting with "P-" or the unique payment ID.
          in: path
          name: payment-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTSettlePaymentRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad097b490c4e5aa0190d937784723b5
                    number: P-00000020
                    status: Processed
                    type: Electronic
                    accountId: 8ad09be48db5aba7018db604776d4854
                    accountNumber: A00000097
                    amount: 110.5
                    appliedAmount: 110.5
                    unappliedAmount: 0
                    refundAmount: 0
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2024-07-21'
                    comment: ''
                    paymentMethodId: 8ad084db90a5e73b0190c02783f552fa
                    paymentMethodSnapshotId: 8ad097b490c4e5aa0190d937783e23b4
                    authTransactionId: null
                    bankIdentificationNumber: '411111'
                    gatewayId: 2c92c0f972bc6aa90172bc77ccaf379a
                    paymentGatewayNumber: null
                    gatewayOrderId: null
                    gatewayResponse: This transaction has been approved by Test gateway.
                    gatewayResponseCode: approve
                    gatewayState: Settled
                    markedForSubmissionOn: null
                    referenceId: '7290220.496916332'
                    secondPaymentReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: '2024-07-21 23:53:29'
                    settledOn: '2024-07-21 23:54:38'
                    cancelledOn: null
                    createdDate: '2024-07-21 23:53:29'
                    createdById: 8ad09fc28193c189018194da28be74ba
                    updatedDate: '2024-07-21 23:54:38'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: Accounts Receivable
                      unappliedPaymentAccountingCodeType: AccountsReceivable
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: paid
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/POSTSettlePaymentResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Settle a payment
      tags:
        - Payment Gateway Reconciliation
  /v1/refunds/{refund-key}/reconcile:
    post:
      description: >
        Reconciles a refund when receiving the gateway reconciliation request or
        event.
      operationId: POST_ReconcileRefund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The refund number starting with “R-” or the unique refund ID.
          in: path
          name: refund-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTReconcileRefundRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POSTReconcileRefundResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Reconcile a refund
      tags:
        - Payment Gateway Reconciliation
  /v1/payments:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all payments from all your customer
        accounts.


        ### Filtering


        You can use query parameters to restrict the data returned in the
        response. Each query parameter corresponds to one field in the response
        body.


        The `unappliedAmount` or any other query parameter does not support the
        less than(<) and the greater than(>) operators.


        If the value of a filterable field is string, you can set the
        corresponding query parameter to `null` when filtering. Then, you can
        get the response data with this field value being `null`.


        Examples:


        - /v1/payments?status=Processed


        - /v1/payments?currency=USD&status=Processed


        - /v1/payments?status=Processed&type=External&sort=+number
      operationId: GET_RetrieveAllPayments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: |
            This parameter filters the response based on the `accountId` field.
          in: query
          name: accountId
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `amount` field.
          in: query
          name: amount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `appliedAmount`
            field.
          in: query
          name: appliedAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `createdById`
            field.
          in: query
          name: createdById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `createdDate`
            field.
          in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter filters the response based on the
            `creditBalanceAmount` field.
          in: query
          name: creditBalanceAmount
          required: false
          schema:
            format: double
            type: number
        - description: |
            This parameter filters the response based on the `currency` field.
          in: query
          name: currency
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `effectiveDate`
            field.
          in: query
          name: effectiveDate
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            This parameter filters the response based on the `number` field.
          in: query
          name: number
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `refundAmount`
            field.
          in: query
          name: refundAmount
          required: false
          schema:
            format: double
            type: number
        - description: |
            This parameter filters the response based on the `status` field.
          in: query
          name: status
          required: false
          schema:
            enum:
              - Draft
              - Processing
              - Processed
              - Error
              - Canceled
              - Posted
            type: string
        - description: |
            This parameter filters the response based on the `type` field.
          in: query
          name: type
          required: false
          schema:
            enum:
              - External
              - Electronic
            type: string
        - description: >
            This parameter filters the response based on the `unappliedAmount`
            field.
          in: query
          name: unappliedAmount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `updatedById`
            field.
          in: query
          name: updatedById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedDate`
            field.
          in: query
          name: updatedDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by payment
            effective date.

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            By default, the response data is displayed in descending order by
            payment number.


            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - number
              - accountId
              - amount
              - appliedAmount
              - unappliedAmount
              - refundAmount
              - creditBalanceAmount
              - effectiveDate
              - createdDate
              - createdById
              - updatedDate
              - updatedById

              
            Examples:


            - /v1/payments?sort=+number


            - /v1/payments?status=Processed&sort=-number,+amount
          in: query
          name: sort
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    payments:
                      - accountId: 4028905f5a87c0ff015a87d25ae90025
                        accountNumber: A00000001
                        amount: 44.1
                        appliedAmount: 44.1
                        authTransactionId: null
                        bankIdentificationNumber: null
                        cancelledOn: null
                        comment: normal payment
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 11:30:37'
                        creditBalanceAmount: 0
                        currency: USD
                        effectiveDate: '2017-03-01'
                        financeInformation:
                          bankAccountAccountingCode: null
                          bankAccountAccountingCodeType: null
                          transferredToAccounting: 'No'
                          unappliedPaymentAccountingCode: null
                          unappliedPaymentAccountingCodeType: null
                        gatewayId: null
                        gatewayOrderId: null
                        gatewayReconciliationReason: null
                        gatewayReconciliationStatus: null
                        gatewayResponse: null
                        gatewayResponseCode: null
                        gatewayState: NotSubmitted
                        id: 4028905f5a87c0ff015a87eb6b75007f
                        markedForSubmissionOn: null
                        number: P-00000001
                        paymentGatewayNumber: PG-00000001
                        paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
                        paymentMethodSnapshotId: null
                        payoutId: null
                        referenceId: null
                        refundAmount: 0
                        secondPaymentReferenceId: null
                        settledOn: null
                        softDescriptor: null
                        softDescriptorPhone: null
                        status: Processed
                        submittedOn: null
                        type: External
                        unappliedAmount: 0
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 11:30:37'
                    success: true
              schema:
                $ref: '#/components/schemas/PaymentCollectionResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List payments
      tags:
        - Payments
    post:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Creates a payment in the following scenarios:


        - A full or partial payment on an invoice or a debit memo

        - A full or partial payment on several invoices and debit memos

        - An unapplied payment in the following situations:
          - You do not know which customer account the payment belongs to.
          - You know which customer account the payment belongs to, but you do not know which invoice the payment is applied to.
          - You receive a payment from your customer that exceeds the balance on the invoice.
          - You receive a payment from your customer before the invoice has been created.
          - You intend to create a payment without any invoices or debit memos.
        - A standalone payment. If you only need to create and process an
        electronic payment in Zuora through a Zuora gateway integration but
        settle the payment outside of Zuora, you can create a standalone
        payment. For a standalone payment, you can specify a currency different
        from the payment currency in the customer account settings. When
        Standalone Payment is not enabled, the currency of the standalone
        payment can be different from the payment currency defined in the
        customer account settings if you have the [Multiple
        Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies)
        feature enabled. 

          


        If you do not know to which customer account the payment belongs, you
        can create a payment without specifying a customer account.


        When you create a payment, the total number of invoice items and debit
        memo items that the payment will apply to should be less than or equal
        to 15,000.


        For more information, see [Create
        Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments)
        and [Create Payments Without Specifying Customer
        Accounts](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments_Without_Specifying_Customer_Accounts).
            
      operationId: POST_CreatePayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90a04d914ac24801914b29e47f0777
                    number: P-00000389
                    status: Processed
                    type: External
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    accountNumber: A00000370
                    amount: 14.99
                    appliedAmount: 14.99
                    unappliedAmount: 0
                    refundAmount: 0
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2024-08-13'
                    comment: null
                    paymentMethodId: 2c92c8f95e2d6ebb015e325df7a70356
                    paymentMethodSnapshotId: null
                    authTransactionId: null
                    bankIdentificationNumber: null
                    gatewayId: null
                    paymentGatewayNumber: null
                    gatewayOrderId: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    markedForSubmissionOn: null
                    referenceId: null
                    secondPaymentReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: null
                    settledOn: null
                    cancelledOn: null
                    createdDate: '2024-08-13 17:55:22'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-08-13 17:55:22'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    prepayment: false
                    success: true
              schema:
                $ref: '#/components/schemas/GETARPaymentTypeWithPaymentOption'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a payment
      tags:
        - Payments
  /v1/payments/{paymentKey}:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Updates a payment.
      operationId: PUT_UpdatePayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1` or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePaymentType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028905f5a87c0ff015a88889fe500a8
                    accountNumber: A00000001
                    amount: 44.1
                    appliedAmount: 0
                    authTransactionId: null
                    bankIdentificationNumber: null
                    cancelledOn: null
                    comment: Details about this payment
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 11:30:37'
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2017-03-01'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      transferredToAccounting: 'No'
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                    gatewayId: null
                    gatewayOrderId: null
                    gatewayReconciliationReason: null
                    gatewayReconciliationStatus: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    id: 4028905f5a87c0ff015a87eb6b75007f
                    markedForSubmissionOn: null
                    number: P-00000001
                    paymentGatewayNumber: PG-00000001
                    paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
                    paymentMethodSnapshotId: null
                    payoutId: null
                    referenceId: null
                    refundAmount: 0
                    secondPaymentReferenceId: null
                    settledOn: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    status: Processed
                    submittedOn: null
                    success: true
                    type: External
                    unappliedAmount: 44.1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:25:34'
              schema:
                $ref: '#/components/schemas/GETARPaymentType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a payment
      tags:
        - Payments
    delete:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Deletes a payment. Only payments with the Cancelled status can be
        deleted. 


        If you have the Invoice Settlement feature enabled, overpayments applied
        to credit balance cannot be deleted.
      operationId: DELETE_Payment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a payment
      tags:
        - Payments
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about one specific payment.
      operationId: GET_Payment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028905f5a87c0ff015a87d25ae90025
                    accountNumber: A00000001
                    amount: 44.1
                    appliedAmount: 44.1
                    authTransactionId: null
                    bankIdentificationNumber: null
                    cancelledOn: null
                    comment: normal payment
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 11:30:37'
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2017-03-01'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      transferredToAccounting: 'No'
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                    gatewayId: null
                    gatewayOrderId: null
                    gatewayReconciliationReason: null
                    gatewayReconciliationStatus: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    id: 4028905f5a87c0ff015a87eb6b75007f
                    markedForSubmissionOn: null
                    number: P-00000001
                    paymentGatewayNumber: PG-00000001
                    paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
                    paymentMethodSnapshotId: null
                    payoutId: null
                    referenceId: null
                    refundAmount: 0
                    secondPaymentReferenceId: null
                    settledOn: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    status: Processed
                    submittedOn: null
                    success: true
                    type: External
                    unappliedAmount: 0
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 11:30:37'
              schema:
                $ref: '#/components/schemas/GETARPaymentType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a payment
      tags:
        - Payments
  /v1/payments/{paymentKey}/apply:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Applies an unapplied payment to invoices and debit memos.


        When you apply a payment, the total number of invoice items and debit
        memo items that the payment will apply to must be less than or equal to
        15,000.
                
        If the limit is hit, you can follow the instructions:

        - If you want to apply one payment to multiple invoices or debit memos,
        decrease the number of invoices or debit memos in the request.

        - If you want to apply one payment to a single invoice or debit memo
        with a large volume of items, you have to specify invoice items in the
        request. The maximum number of invoice items that you can specify in the
        request is 1,000.


        For more information, see [Apply Unapplied Payments to Invoices and
        Debit
        Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Apply_Unapplied_Payments_to_Invoices_and_Debit_Memos).
      operationId: PUT_ApplyPayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyPaymentType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad0835290c4bb2f0190c9b5407c52a3
                    number: P-00000018
                    status: Processed
                    type: External
                    accountId: 8ad097b490c4e5aa0190c9612d9c7034
                    accountNumber: A00000122
                    amount: 14.99
                    appliedAmount: 12
                    unappliedAmount: 2.99
                    refundAmount: 0
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2024-07-18'
                    comment: null
                    paymentMethodId: 2c92c0f86cccaa59016cd5e0c41c0e89
                    paymentMethodSnapshotId: null
                    authTransactionId: null
                    bankIdentificationNumber: null
                    gatewayId: null
                    paymentGatewayNumber: null
                    gatewayOrderId: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    markedForSubmissionOn: null
                    referenceId: null
                    secondPaymentReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: null
                    settledOn: null
                    cancelledOn: null
                    createdDate: '2024-07-18 23:36:57'
                    createdById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-18 23:41:55'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: Accounts Receivable
                      unappliedPaymentAccountingCodeType: AccountsReceivable
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETARPaymentType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Apply a payment
      tags:
        - Payments
  /v1/payments/{paymentKey}/cancel:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Cancels a payment. 


        If you have the Invoice Settlement feature enabled, overpayments applied
        to credit balance cannot be cancelled.
      operationId: PUT_CancelPayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028905f5a87c0ff015a88889fe500a8
                    accountNumber: A00000001
                    amount: 44.1
                    appliedAmount: 0
                    authTransactionId: null
                    bankIdentificationNumber: null
                    cancelledOn: null
                    comment: new comment
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 11:30:37'
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2017-03-01'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      transferredToAccounting: 'No'
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                    gatewayId: null
                    gatewayOrderId: null
                    gatewayReconciliationReason: null
                    gatewayReconciliationStatus: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    id: 4028905f5a87c0ff015a87eb6b75007f
                    markedForSubmissionOn: null
                    number: P-00000001
                    paymentGatewayNumber: PG-00000001
                    paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
                    paymentMethodSnapshotId: null
                    payoutId: null
                    referenceId: null
                    refundAmount: 0
                    secondPaymentReferenceId: null
                    settledOn: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    status: Canceled
                    submittedOn: null
                    success: true
                    type: External
                    unappliedAmount: 44.1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:26:57'
              schema:
                $ref: '#/components/schemas/GETARPaymentType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a payment
      tags:
        - Payments
  /v1/payments/{paymentKey}/parts:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all parts of a payment. A payment can
        consist of an unapplied part, and several parts applied to invoices and
        debit memos. You can use this operation to get all the applied and
        unapplied portions of a payment. Note that a fully refunded payment does
        not contain any payment part.
      operationId: GET_PaymentParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    parts:
                      - amount: 4.1
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 11:30:37'
                        debitMemoId: 4028905f5a87c0ff015a87e49e6b0062
                        id: 4028905f5a87c0ff015a87eb6beb008d
                        invoiceId: null
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 11:30:37'
                      - amount: 40
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 11:30:37'
                        debitMemoId: null
                        id: 4028905f5a87c0ff015a87eb6beb008c
                        invoiceId: 4028905f5a87c0ff015a87d3f8f10043
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 11:30:37'
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentPartsCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all parts of a payment
      tags:
        - Payments
  /v1/payments/{paymentKey}/parts/{partid}:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about a specific payment part. A payment can
        consist of an unapplied part, and several parts applied to invoices and
        debit memos.


        A fully refunded payment does not contain any payment part.
      operationId: GET_PaymentPart
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a specific payment part. You can get the payment
            part ID from the response of [List all parts of a
            payment](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts).
          in: path
          name: partid
          required: true
          schema:
            type: string
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 4.1
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 11:30:37'
                    debitMemoId: 4028905f5a87c0ff015a87e49e6b0062
                    id: 4028905f5a87c0ff015a87eb6beb008d
                    invoiceId: null
                    success: true
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 11:30:37'
              schema:
                $ref: '#/components/schemas/GETPaymentPartType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a payment part
      tags:
        - Payments
  /v1/payments/{paymentKey}/parts/{partid}/item-parts:
    get:
      description: >
        **Note:** This operation is only available if you have the [Invoice Item
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
        feature enabled. Invoice Item Settlement must be used together with
        other Invoice Settlement features (Unapplied Payments, and Credit and
        Debit memos).  If you wish to enable Invoice Settlement, see [Invoice
        Settlement Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all items of a payment part. A payment
        part item is a single line item in a payment part. A payment part can
        consist of several different types of items.
      operationId: GET_PaymentItemParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID of a specific payment part. You can get the payment
            part ID from the response of [List all parts of a
            payment](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts).
          in: path
          name: partid
          required: true
          schema:
            type: string
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    itemParts:
                      - amount: 4
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 11:30:37'
                        debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063
                        id: 4028905f5a87c0ff015a87eb6bd8008a
                        invoiceItemId: null
                        taxItemId: null
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 11:30:37'
                      - amount: 0.1
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 11:30:37'
                        debitMemoItemId: null
                        id: 4028905f5a87c0ff015a87eb6bd8008b
                        invoiceItemId: null
                        taxItemId: 4028905f5a87c0ff015a87e49f5e0065
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 11:30:37'
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentItemPartCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all payment part items
      tags:
        - Payments
  /v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}:
    get:
      description: >
        **Note:** This operation is only available if you have the [Invoice Item
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
        feature enabled. Invoice Item Settlement must be used together with
        other Invoice Settlement features (Unapplied Payments, and Credit and
        Debit memos).  If you wish to enable Invoice Settlement, see [Invoice
        Settlement Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Retrieves the information about a specific payment part item. A payment
        part item is a single line item in a payment part. A payment part can
        consist of several different types of items.
      operationId: GET_PaymentItemPart
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a specific payment part. You can get the payment
            part ID from the response of [List all parts of a
            payment](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts).
          in: path
          name: partid
          required: true
          schema:
            type: string
        - description: >
            The unique ID of a specific payment part item. You can get the
            payment part item ID from the response of [List all payment part
            items](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentItemParts).
          in: path
          name: itempartid
          required: true
          schema:
            type: string
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 4
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 11:30:37'
                    debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063
                    id: 4028905f5a87c0ff015a87eb6bd8008a
                    invoiceItemId: null
                    success: true
                    taxItemId: null
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 11:30:37'
              schema:
                $ref: '#/components/schemas/GETPaymentItemPartType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a payment part item
      tags:
        - Payments
  /v1/payments/{paymentKey}/refunds:
    post:
      description: >
        **Note:** This operation is only available if you have <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement"
        target="_blank">Invoice Settlement</a> enabled. The Invoice Settlement
        feature is generally available as of Zuora Billing Release 296 (March
        2021). This feature includes Unapplied Payments, Credit and Debit Memo,
        and Invoice Item Settlement. If you want to enable Invoice Settlement,
        see <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide"
        target="_blank">Invoice Settlement Enablement and Checklist Guide</a>
        for more information. 


        Refunds a full or partial unapplied payment to your customers. To refund
        applied payments, you must unapply the applied payments from the
        invoices or debit memos, and then refund the unapplied payments to
        customers. For more information on the payment refund use case, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Schedules/Payment_schedules_use_cases"
        target="_blank">Payment schedules use cases</a> in the Knowledge Center.


        For more information, see <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Y_Refund_Payments"
        target="_blank">Refund Payments</a>.
      operationId: POST_RefundPayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRefundType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90a04d90de54810190debe8e3b5a2c
                    number: R-00000287
                    status: Processed
                    type: Electronic
                    methodType: CreditCard
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    amount: 10
                    refundDate: '2024-07-23'
                    comment: null
                    paymentMethodId: 8a90e5e490c9ceb80190d8e9df930bf0
                    paymentMethodSnapshotId: 8a90a04d90de54810190debe8e0c5a29
                    paymentId: 8a90e5e490c9ceb80190d91837840c1d
                    paymentNumber: P-00000387
                    creditMemoId: null
                    reasonCode: null
                    gatewayId: 8a90d6128ddbaf39018de2d9fe0d2660
                    paymentGatewayNumber: PG-00000001
                    gatewayResponse: Approved
                    gatewayResponseCode: OK
                    gatewayState: Submitted
                    markedForSubmissionOn: null
                    referenceId: null
                    secondRefundReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: '2024-07-23 16:39:09'
                    settledOn: null
                    cancelledOn: null
                    createdDate: '2024-07-23 16:39:08'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-07-23 16:39:12'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    refundTransactionTime: '2024-07-23 16:39:09'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETRefundPaymentType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Refund a payment
      tags:
        - Payments
  /v1/payments/{paymentKey}/refunds/unapply:
    post:
      description: >-
        **Note:** This operation is only available if you have <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement"
        target="_blank">Invoice Settlement</a> enabled. The Invoice Settlement
        feature is generally available as of Zuora Billing Release 296 (March
        2021). This feature includes Unapplied Payments, Credit and Debit Memo,
        and Invoice Item Settlement. If you want to enable Invoice Settlement,
        see <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide"
        target="_blank">Invoice Settlement Enablement and Checklist Guide</a>
        for more information. 


        Refunds a full or partial unapplied payment to your customers, without
        the need to unapply the payment first, followed by processing the
        refund. To refund applied payments, you can now leverage this API to
        unapply and refund the payment simultaneously. For more information on
        the payment refund use case, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Schedules/Payment_schedules_use_cases"
        target="_blank">Payment schedules use cases</a> in the Knowledge Center.


        For more information, see  <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Unapplied_Payments/Management_of_Unapplied_Payments/Refund_a_payment_with_auto-unapplying"
        target="_blank">Refund a payment with auto-unapplying</a>.
      operationId: POST_RefundPaymentwithAutoUnapply
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRefundwithAutoUnapplyType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90e4a79310d4b00193196d987670fe
                    number: R-00000289
                    status: Processed
                    type: Electronic
                    methodType: CreditCard
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    amount: 10
                    refundDate: '2024-11-11'
                    comment: null
                    paymentMethodId: 8a90b44890c9bb0d0190d960b9191eea
                    paymentMethodSnapshotId: 8a90e4a79310d4b00193196d981370fb
                    paymentId: 8a90f26f92f732c70192fb5323d227ad
                    paymentNumber: P-00000394
                    creditMemoId: null
                    reasonCode: null
                    gatewayId: 8a90d6128ddbaf39018de2d9fe0d2660
                    paymentGatewayNumber: PG-00000001
                    gatewayResponse: Approved
                    gatewayResponseCode: OK
                    gatewayState: Submitted
                    markedForSubmissionOn: null
                    referenceId: ''
                    secondRefundReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: '2024-11-11 12:13:53'
                    settledOn: null
                    cancelledOn: null
                    createdDate: '2024-11-11 12:13:52'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-11-11 12:14:03'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    refundTransactionTime: '2024-11-11 12:13:53'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    writeOff: false
                    writeOffResults: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETRefundPaymentTypeAutoUnapply'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Refund a payment with auto-unapplying
      tags:
        - Payments
  /v1/payments/{paymentKey}/transfer:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Transfers an unapplied payment.


        For more information, see [Transfer Unapplied
        Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Transfer_Unapplied_Payments).
      operationId: PUT_TransferPayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.          
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferPaymentType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028905f5a87c0ff015a88889fe500a8
                    accountNumber: A00000001
                    amount: 44.1
                    appliedAmount: 0
                    authTransactionId: null
                    bankIdentificationNumber: null
                    cancelledOn: null
                    comment: normal payment
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 11:30:37'
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2017-03-01'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      transferredToAccounting: 'No'
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                    gatewayId: null
                    gatewayOrderId: null
                    gatewayReconciliationReason: null
                    gatewayReconciliationStatus: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    id: 4028905f5a87c0ff015a87eb6b75007f
                    markedForSubmissionOn: null
                    number: P-00000001
                    paymentGatewayNumber: PG-00000001
                    paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
                    paymentMethodSnapshotId: null
                    payoutId: null
                    referenceId: null
                    refundAmount: 0
                    secondPaymentReferenceId: null
                    settledOn: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    status: Processed
                    submittedOn: null
                    success: true
                    type: External
                    unappliedAmount: 44.1
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:22:58'
              schema:
                $ref: '#/components/schemas/GETARPaymentType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Transfer a payment
      tags:
        - Payments
  /v1/payments/{paymentKey}/unapply:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Unapplies an applied payment from invoices and debit memos.


        When you unapply a payment, the total number of invoice items and debit
        memo items that the payment will unapply from must be less than or equal
        to 15,000.


        If the limit is hit, you can follow the instructions:

        - If you want to unapply one payment without specifying invoices or
        debit memos, you have to specify the invoices or debit memos in the
        request.

        - If you want to unapply one payment from multiple specified invoices or
        debit memos, decrease the number of invoices or debit memos in the
        request.

        - If you want to unapply one payment from a single invoice or debit memo
        with a large volume of items, you have to specify invoice items in the
        request. The maximum number of invoice items that you can specify in the
        request is 1,000.


        For more information, see [Unapply Payments from Invoices and Debit
        Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Unapply_Payments_from_Invoices_and_Debit_Memos).
      operationId: PUT_UnapplyPayment
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of an unapplied payment. For example,
            `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.
          in: path
          name: paymentKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnapplyPaymentType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad0835290c4bb2f0190c9b5407c52a3
                    number: P-00000018
                    status: Processed
                    type: External
                    accountId: 8ad097b490c4e5aa0190c9612d9c7034
                    accountNumber: A00000122
                    amount: 14.99
                    appliedAmount: 0
                    unappliedAmount: 14.99
                    refundAmount: 0
                    creditBalanceAmount: 0
                    currency: USD
                    effectiveDate: '2024-07-18'
                    comment: null
                    paymentMethodId: 2c92c0f86cccaa59016cd5e0c41c0e89
                    paymentMethodSnapshotId: null
                    authTransactionId: null
                    bankIdentificationNumber: null
                    gatewayId: null
                    paymentGatewayNumber: null
                    gatewayOrderId: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    markedForSubmissionOn: null
                    referenceId: null
                    secondPaymentReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: null
                    settledOn: null
                    cancelledOn: null
                    createdDate: '2024-07-18 23:36:57'
                    createdById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-19 00:03:20'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: Accounts Receivable
                      unappliedPaymentAccountingCodeType: AccountsReceivable
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETARPaymentType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Unapply a payment
      tags:
        - Payments
  /v1/object/payment-transaction-log/{id}:
    get:
      description: |
        Retrieves information about a specific payment transaction log.
      operationId: Object_GETPaymentTransactionLog
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The ID of a payment transaction log.
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Gateway: TEST gateway name1476935063101
                    GatewayReasonCode: approve
                    GatewayReasonCodeDescription: This transaction has been approved by Test gateway.
                    GatewayState: Submitted
                    GatewayTransactionType: Sale
                    Id: 2c93808457d787030157e030b2703dcd
                    PaymentId: 2c93808457d787030157e030b2673dcc
                    TransactionDate: '2016-10-20T05:44:30.000+02:00'
                    TransactionId: '874200.071357285'
              schema:
                $ref: '#/components/schemas/ProxyGetPaymentTransactionLog'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve a payment transaction log'
      tags:
        - Payment Transaction Logs
  /v1/payment-runs:
    get:
      description: >
        Retrieves the information about all payment runs. You can define
        filterable fields to restrict the data returned in the response.


        ### Filtering


        You can use query parameters to restrict the data returned in the
        response. Each query parameter corresponds to one field in the response
        body.


        If the value of a filterable field is string, you can set the
        corresponding query parameter to `null` when filtering. Then, you can
        get the response data with this field value being `null`. 


        Examples:


        - /v1/payment-runs?status=Processed


        - /v1/payment-runs?targetDate=2017-10-10&status=Pending


        - /v1/payment-runs?status=Completed&sort=+updatedDate
      operationId: GET_PaymentRuns
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            This parameter filters the response based on the `createdById`
            field.
          in: query
          name: createdById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `createdDate`
            field.
          in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            This parameter filters the response based on the `status` field.
          in: query
          name: status
          required: false
          schema:
            enum:
              - Pending
              - Processing
              - Completed
              - Error
              - Canceled
            type: string
        - description: |
            This parameter filters the response based on the `targetDate` field.
          in: query
          name: targetDate
          required: false
          schema:
            format: date
            type: string
        - description: >
            This parameter filters the response based on the `updatedById`
            field.
          in: query
          name: updatedById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedDate`
            field.
          in: query
          name: updatedDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by this
            field.

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            By default, the response data is displayed in descending order by
            payment run number.


            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - targetDate
              - status
              - createdDate
              - createdById
              - updatedDate
              - updatedById

            Examples:


            - /v1/payment-runs?sort=+createdDate


            - /v1/payment-runs?status=Processing&sort=-createdById,+targetDate
          in: query
          name: sort
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    nextPage: /payment-runs?page=2
                    paymentRuns:
                      - applyCreditBalance: false
                        collectPayment: true
                        completedOn: '2017-12-28 13:00:00'
                        consolidatedPayment: false
                        createdById: 2c92c0f956bc8fcb0156f8eee04b4d54
                        createdDate: '2017-12-27 13:00:00'
                        executedOn: '2017-12-28 13:00:00'
                        id: 2c92c0856078bbcb016096576ccb75ca
                        number: PR-00002121
                        processPaymentWithClosedPM: false
                        runDate: null
                        status: Completed
                        targetDate: '2017-12-28'
                        updatedById: 2c92c0f956bc8fcb0156f8eee04b4d54
                        updatedDate: '2017-12-28 13:00:00'
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentRunCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: List payment runs
      tags:
        - Payment Runs
    post:
      description: >
        Creates a payment run. You can create a payment run to be executed
        immediately after it is created, or a scheduled payment run to be
        executed in future.


        To filter the payments to be collected for a payment run, you can use
        either of the following methods but not both:

          - Use the `accountId`, `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields to define the billing documents to be collected.
          - Use the `data` field to specify the records of accounts and billing documents to be collected, in a more flexible manner. See [Create custom payment runs through Zuora REST API](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/K_Payment_Operations/CA_Payment_Runs/Create_custom_payment_runs_through_Zuora_REST_API) for more information.

        If no filter criteria are specified in the request body, the payment run
        collects payments for all accounts.
      operationId: POST_PaymentRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPaymentRunRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad0835290e7dcf90190fd37f43e4bd8
                    number: PR-00000006
                    targetDate: '2024-07-24'
                    runDate: null
                    status: Pending
                    accountId: 8ad09be48db5aba7018db604776d4854
                    executedOn: null
                    completedOn: null
                    autoApplyCreditMemo: false
                    autoApplyUnappliedPayment: false
                    consolidatedPayment: false
                    processPaymentWithClosedPM: false
                    collectPayment: true
                    useCustomPaymentMethods: true
                    createdDate: '2024-07-28 23:40:21'
                    createdById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-28 23:40:21'
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentRunType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Create a payment run
      tags:
        - Payment Runs
  /v1/payment-runs/{paymentRunKey}:
    delete:
      description: >
        Deletes a payment run. Only payment runs with the Canceled or Error
        status can be deleted.
      operationId: DELETE_PaymentRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The unique ID of a payment run or the payment run number. For
            example, 402890245f097f39015f0f074a2e0566.
          in: path
          name: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Delete a payment run
      tags:
        - Payment Runs
    get:
      description: |
        Retrives the information about a specific payment run.
      operationId: GET_PaymentRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a payment run or the payment run number. For
            example, 402890245f097f39015f0f074a2e0566.
          in: path
          name: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    applyCreditBalance: false
                    collectPayment: true
                    completedOn: '2017-12-28 09:00:06'
                    consolidatedPayment: false
                    createdById: 2c92c0f958fffd7d015914aeefc71a5d
                    createdDate: '2017-12-27 09:00:02'
                    executedOn: '2017-12-28 09:00:06'
                    id: 2c92c0856078bbcb0160957bbb8f0b32
                    number: PR-00002120
                    processPaymentWithClosedPM: false
                    runDate: null
                    status: Completed
                    success: true
                    targetDate: '2017-12-28'
                    updatedById: 2c92c0f958fffd7d015914aeefc71a5d
                    updatedDate: '2017-12-28 09:00:06'
              schema:
                $ref: '#/components/schemas/GETPaymentRunType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Retrieve a payment run
      tags:
        - Payment Runs
    put:
      description: >
        Updates the information about an unexecuted payment run. Only pending
        payment runs can be updated.


        If none of the **accountId**, **batch**, **billCycleDay**, **currency**,
        **paymentGatewayId**, and **billingRunId** fields is specified in the
        request body, the corresponding payment run collects payments for all
        accounts.
      operationId: PUT_PaymentRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a payment run or the payment run number. For
            example, 402890245f097f39015f0f074a2e0566.
          in: path
          name: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPaymentRunRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402890245f097f39015f0e9fcdd60558
                    autoApplyCreditMemo: true
                    autoApplyUnappliedPayment: true
                    collectPayment: true
                    completedOn: null
                    consolidatedPayment: true
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-09-22 12:37:22'
                    executedOn: null
                    id: 402890245f097f39015f0f074a2e0566
                    number: PR-00000391
                    processPaymentWithClosedPM: true
                    rundate: null
                    status: Pending
                    success: true
                    targetDate: '2017-10-12'
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-09-22 12:37:22'
              schema:
                $ref: '#/components/schemas/GETPaymentRunType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Update a payment run
      tags:
        - Payment Runs
  /v1/payment-runs/{paymentRunKey}/data:
    get:
      description: >
        Retrieves payment run data and the processing result with details, if
        the `data` field was specified in the Create payment run operation.
           
      operationId: GET_PaymentRunData
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The unique ID of a payment run or the payment run number. For
            example, 402890245f097f39015f0f074a2e0566.
          in: path
          name: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - accountId: 402881ed738ddf2001738def8db50058
                        amount: 80
                        amountCollected: 80
                        amountToCollect: 80
                        comment: Comment1
                        customField1__c: cf_value1
                        customField2__c: cf_value2
                        documentId: 402881ed738ddf2001738df388fd009e
                        documentType: Invoice
                        paymentGatewayId: 402881ed738ddf2001738def8b630050
                        paymentMethodId: 402881ed738ddf2001738def8e60005b
                        result: Processed
                        transactions:
                          - amount: 40
                            appliedAmount: 40
                            id: 402881ed738ddf2001738dfafad6012c
                            status: Processed
                            type: Payment
                          - appliedAmount: 10
                            id: 402881ed738ddf2001738df7572400e6
                            type: CreditMemo
                          - appliedAmount: 30
                            id: 402881ed738ddf2001738df715d800dd
                            type: UnappliedPayment
                      - accountId: 402881ed738ddf2001738def8db50058
                        amount: 70
                        amountCollected: 70
                        amountToCollect: 70
                        comment: Comment2
                        customField1__c: cf_value3
                        customField2__c: cf_value4
                        documentId: 402881ed738ddf2001738df5b90a00c0
                        documentType: DebitMemo
                        paymentGatewayId: 402881ed738ddf2001738def8b630050
                        paymentMethodId: 402881ed738ddf2001738df97dbe00fe
                        result: Processed
                        transactions:
                          - amount: 70
                            appliedAmount: 70
                            id: 402881ed738ddf2001738dfafcbd013b
                            status: Processed
                            type: Payment
                      - accountId: c49b85cd8ba742edb5ab4b3da90fc4c0
                        comment: Comment3
                        customField1__c: cf_value5
                        customField2__c: cf_value6
                        documentId: 7dab18d036dc4c94bbec853afb12affb
                        documentType: Invoice
                        errorCode: Invalid_Request_Data
                        errorMessage: Payment method is closed
                        paymentGatewayId: 768929c2f51947e79e73703bfc9bca7d
                        paymentMethodId: 1906df6f56f049c8b7457dc31f62d0ec
                        result: Error
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentRunDataArrayResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Retrieve payment run data
      tags:
        - Payment Runs
  /v1/payment-runs/{paymentRunKey}/summary:
    get:
      description: |
        Retrives the summary of a payment run.
      operationId: GET_PaymentRunSummary
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The unique ID of a payment run or the payment run number. For
            example, 402890245f097f39015f0f074a2e0566.
          in: path
          name: paymentRunKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    numberOfCreditBalanceAdjustments: 0
                    numberOfCreditMemos: 1
                    numberOfDebitMemos: 1
                    numberOfErrors: 0
                    numberOfInvoices: 0
                    numberOfPayments: 1
                    numberOfReceivables: 1
                    numberOfUnappliedPayments: 1
                    numberOfUnprocessedDebitMemos: 0
                    numberOfUnprocessedInvoices: 0
                    numberOfUnprocessedReceivables: 0
                    success: true
                    totalValues:
                      - totalValueOfCreditBalance: 0 USD
                        totalValueOfCreditMemos: 100 USD
                        totalValueOfDebitMemos: 256 USD
                        totalValueOfErrors: 0 USD
                        totalValueOfInvoices: 0 USD
                        totalValueOfPayments: 56 USD
                        totalValueOfReceivables: 256 USD
                        totalValueOfUnappliedPayments: 100 USD
                        totalValueOfUnprocessedDebitMemos: 0 USD
                        totalValueOfUnprocessedInvoices: 0 USD
                        totalValueOfUnprocessedReceivables: 0 USD
              schema:
                $ref: '#/components/schemas/GETPaymentRunSummaryResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Retrieve a payment run summary
      tags:
        - Payment Runs
  /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:**

        - 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.
      operationId: POST_RetryPaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTRetryPaymentScheduleItemRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    items:
                      - amount: null
                        createdById: null
                        createdDate: null
                        currency: null
                        description: null
                        errorMessage: >-
                          Can not retry because payment Processed status is not
                          allowed.
                        id: 402882e97f24bc36017f2986654f0253
                        paymentGatewayId: null
                        paymentId: null
                        paymentMethodId: null
                        paymentScheduleId: string
                        paymentScheduleNumber: string
                        runHour: null
                        scheduledDate: null
                        status: null
                        updatedById: null
                        updatedDate: null
                      - PSIPaymentDate__c: '2022-02-22'
                        PSIPaymentPicklist__c: '1'
                        PSIPaymentText__c: Payment Text From PSI via API Payment Error
                        PSIPicklist__c: '1'
                        PSIText__c: PSI Text Value
                        amount: 2
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2022-02-23 18:19:07'
                        currency: USD
                        description: null
                        errorMessage: null
                        id: 402882e97f24bc36017f298665570254
                        paymentGatewayId: 402883827d097a28017d09b41f690261
                        paymentId: 402882e97f24bc36017f298efb360277
                        paymentMethodId: 402882e97f24bc36017f258c2ff20076
                        paymentScheduleId: string
                        paymentScheduleNumber: string
                        runHour: 0
                        scheduledDate: '2022-02-22'
                        status: Processed
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2022-02-23 18:28:30'
                    success: true
              schema:
                $ref: '#/components/schemas/POSTRetryPaymentScheduleItemResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retry failed payment schedule items
      tags:
        - Payment Schedules
  /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.
      operationId: PUT_CancelPaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: The unique ID of a payment schedule item.
          in: path
          name: item-id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 30
                    billingDocument:
                      id: 8a90a2fd819503b50181959525e5205d
                      number: INV00000001
                      type: Invoice
                    cancellationReason: Skip Payment
                    createdById: 8a90e082802185b901802199e15902d1
                    createdDate: '2022-07-22 00:43:42'
                    currency: USD
                    description: ''
                    errorMessage: null
                    id: 8a90857b822459cd018224dcb9ec13bf
                    number: 1
                    paymentGatewayId: 8a90a2fd807499580180781775c452a8
                    paymentId: null
                    paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                    paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                    paymentScheduleNumber: PS-00000007
                    runHour: 23
                    scheduledDate: '2022-11-01'
                    standalone: false
                    status: Canceled
                    success: true
                    updatedById: 8a90e082802185b901802199e15902d1
                    updatedDate: '2022-07-29 02:54:54'
              schema:
                $ref: '#/components/schemas/PUTPaymentScheduleItemResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a payment schedule item
      tags:
        - Payment Schedules
  /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.
      operationId: PUT_SkipPaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: |
            The unique ID of a payment schedule item.   
          in: path
          name: item-id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 30
                    billingDocument: null
                    cancellationReason: Skip Payment
                    cf1__c: null
                    cf2__c: null
                    createdById: 402892f9423062950142306f2f530002
                    createdDate: '2022-09-22 00:59:17'
                    currency: USD
                    description: ''
                    errorMessage: null
                    id: 402881a683642cff018364354abf12b6
                    number: 7
                    paymentGatewayId: null
                    paymentMethodId: 402892f9423062950142306f326c0056
                    paymentScheduleId: 402881a68361af72018361d4be120047
                    paymentScheduleNumber: PS-00000004
                    runHour: 3
                    scheduledDate: '2022-11-04'
                    standalone: true
                    status: Pending
                    success: true
                    updatedById: 402892f9423062950142306f2f530002
                    updatedDate: '2022-09-22 00:59:17'
              schema:
                $ref: '#/components/schemas/PUTSkipPaymentScheduleItemResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Skip a payment schedule item
      tags:
        - Payment Schedules
  /v1/payment-schedule-items/{psi-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.
      operationId: GET_PaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: |
            The unique ID of a payment schedule item.
          in: path
          name: psi-id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 30
                    billingDocument:
                      id: 8a90a2fd819503b50181959525e5205d
                      number: INV00000001
                      type: Invoice
                    cancellationReason: null
                    cancelledById: null
                    cancelledOn: null
                    createdById: 8a90e082802185b901802199e15902d1
                    createdDate: '2022-07-22 00:43:42'
                    currency: USD
                    description: ''
                    errorMessage: null
                    id: 8a90857b822459cd018224dcb9ec13bf
                    number: 1
                    paymentGatewayId: 8a90a2fd807499580180781775c452a8
                    paymentId: null
                    paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                    paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                    paymentScheduleNumber: PS-00000007
                    runHour: 23
                    scheduledDate: '2022-07-31'
                    standalone: false
                    status: Pending
                    success: true
                    updatedById: 8a90e082802185b901802199e15902d1
                    updatedDate: '2022-07-22 00:43:42'
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleItemResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a payment schedule item
      tags:
        - Payment Schedules
    put:
      description: >
        Updates 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
        manag](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features).

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

        - To link or unlink multiple payments with the item, specify the
        `linkPayments` and `unlinkPayments` field in the request body. 

        - When the Multi-currency and Standalone Payments features are not
        enabled, you can create and update a payment schedule and payment
        schedule item in a currency other than the account currency.

        - The maximum number of payments that are allowed to be linked to a
        payment schedule item is `10`.

        - 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.
      operationId: PUT_PaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: |
            The unique ID of a payment schedule item.
          in: path
          name: psi-id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPaymentScheduleItemRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90d61290c9ceb60190d8eac80e125a
                    number: 1
                    paymentScheduleId: 8a90d61290c9ceb60190d8eac80b1259
                    paymentScheduleNumber: PS-00000001
                    scheduledDate: '2024-07-31'
                    runHour: 0
                    paymentMethodId: 8a90b44890c9bb0d0190d960b9191eea
                    paymentGatewayId: null
                    paymentGatewayNumber: null
                    amount: 14.99
                    balance: 14.99
                    currency: USD
                    status: Pending
                    errorMessage: null
                    paymentId: null
                    billingDocument:
                      id: 8a90b44890c9bb0d0190d8c048a90da6
                      number: INV00001823
                      type: Invoice
                    description: null
                    cancellationReason: null
                    cancelledById: null
                    cancelledOn: null
                    createdDate: '2024-07-22 13:29:43'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-07-22 15:40:21'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    success: true
              schema:
                $ref: '#/components/schemas/PUTPaymentScheduleItemResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a payment schedule item
      tags:
        - Payment Schedules
    delete:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Deletes a payment schedule item. You can delete a payment schedule item
        with the `Canceled` status.
      operationId: deletePaymentScheduleItem
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a payment schedule item.
          in: path
          name: psi-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a payment schedule item
      tags:
        - Payment Schedules
  /v1/payment-schedules:
    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.
      operationId: GET_PaymentSchedules
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >
            Number of the most recent processed payment schedules dispalyed in
            the response body.
          in: query
          name: lastProcessedItems
          required: false
          schema:
            type: integer
        - description: >
            Number of next pending payment schedule items displayed in the
            response body.
          in: query
          name: nextPendingItems
          required: false
          schema:
            type: integer
        - description: >
            The ID of the customer account. If neither `accountId` nor
            `accountNumber` is specified, all payment schedules will be
            returned. 
          in: query
          name: accountId
          required: false
          schema:
            type: string
        - description: >
            The number of the customer account. If neither `accountId` nor
            `accountNumber` is specified, all payment schedules will be
            returned. 
          in: query
          name: accountNumber
          required: false
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    - accountId: 8a90a2fd8074995801807816dbac52a4
                      accountNumber: A00000002
                      billingDocument: null
                      billingDocuments:
                        - id: 8a26e082802185b201976199e1991521
                          number: INV-001
                          type: Invoice
                        - id: 8a11e082802185b901126e34713407d2
                          number: INV-002
                          type: Invoice
                      createdById: 8a90e082802185b901802199e15902d1
                      createdDate: '2022-07-22 00:43:42'
                      description: ''
                      id: 8a90857b822459cd018224dcb9eb13be
                      isCustom: true
                      items:
                        - amount: 30
                          billingDocument:
                            id: 8a90a2fd819503b50181959525e5205d
                            number: INV00000001
                            type: Invoice
                          createdById: 8a90e082802185b901802199e15902d1
                          createdDate: '2022-07-22 00:43:42'
                          currency: USD
                          description: ''
                          errorMessage: null
                          id: 8a90857b822459cd018224dcb9ec13bf
                          number: 1
                          paymentGatewayId: 8a90a2fd807499580180781775c452a8
                          paymentId: null
                          paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                          paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                          paymentScheduleNumber: PS-00000007
                          runHour: 23
                          scheduledDate: '2022-07-31'
                          standalone: false
                          status: Pending
                          updatedById: 8a90e082802185b901802199e15902d1
                          updatedDate: '2022-07-22 00:43:42'
                        - amount: 10
                          billingDocument:
                            id: 8a90a2fd819503b50181959525e5205d
                            number: INV00000001
                            type: Invoice
                          createdById: 8a90e082802185b901802199e15902d1
                          createdDate: '2022-07-22 00:45:35'
                          currency: USD
                          description: ''
                          errorMessage: null
                          id: 8a90a2fd822459ec018224de77a0359d
                          number: 2
                          paymentGatewayId: 8a90a2fd807499580180781775c452a8
                          paymentId: null
                          paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                          paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                          paymentScheduleNumber: PS-00000007
                          runHour: 20
                          scheduledDate: '2022-08-31'
                          standalone: false
                          status: Pending
                          updatedById: 8a90e082802185b901802199e15902d1
                          updatedDate: '2022-07-22 00:45:35'
                      nextPaymentDate: '2022-07-31'
                      occurrences: 2
                      paymentScheduleNumber: PS-00000007
                      period: null
                      recentPaymentDate: null
                      runHour: 0
                      standalone: false
                      startDate: '2022-07-31'
                      status: Active
                      totalAmount: 50
                      totalPaymentsErrored: 0
                      totalPaymentsProcessed: 0
                      updatedById: 8a90e082802185b901802199e15902d1
                      updatedDate: '2022-07-22 00:45:36'
                    - accountId: 8a90a2fd8074995801807816dbac52a4
                      accountNumber: A00000002
                      billingDocument: null
                      createdById: 8a90e082802185b901802199e15902d1
                      createdDate: '2022-07-20 21:24:40'
                      description: test update ps Xiaokai
                      id: 8a90e0828219a57101821f00287a3abd
                      isCustom: false
                      items:
                        - amount: 10
                          billingDocument:
                            id: 8a90a2fd819503b50181959525e5205d
                            number: INV00000001
                            type: Invoice
                          createdById: 8a90e082802185b901802199e15902d1
                          createdDate: '2022-07-20 21:24:40'
                          currency: USD
                          description: test update ps
                          errorMessage: null
                          id: 8a90e0828219a57101821f00287a3abf
                          number: 1
                          paymentGatewayId: 8a90a2fd807499580180781775c452a8
                          paymentId: 8a90e86d821fd6d1018221eae795158b
                          paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                          paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                          paymentScheduleNumber: PS-00000006
                          runHour: 11
                          scheduledDate: '2022-07-21'
                          standalone: false
                          status: Processed
                          updatedById: '3'
                          updatedDate: '2022-07-21 11:00:19'
                        - amount: 10
                          billingDocument:
                            id: 8a90a2fd819503b50181959525e5205d
                            number: INV00000001
                            type: Invoice
                          createdById: 8a90e082802185b901802199e15902d1
                          createdDate: '2022-07-20 21:24:40'
                          currency: USD
                          description: test update ps
                          errorMessage: null
                          id: 8a90e0828219a57101821f00287b3ac0
                          number: 2
                          paymentGatewayId: 8a90a2fd807499580180781775c452a8
                          paymentId: null
                          paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                          paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                          paymentScheduleNumber: PS-00000006
                          runHour: 11
                          scheduledDate: '2022-08-04'
                          standalone: false
                          status: Pending
                          updatedById: 8a90e082802185b901802199e15902d1
                          updatedDate: '2022-07-20 21:26:26'
                        - amount: 10
                          billingDocument:
                            id: 8a90a2fd819503b50181959525e5205d
                            number: INV00000001
                            type: Invoice
                          createdById: 8a90e082802185b901802199e15902d1
                          createdDate: '2022-07-20 21:24:40'
                          currency: USD
                          description: test update ps
                          errorMessage: null
                          id: 8a90e0828219a57101821f00287b3ac1
                          number: 3
                          paymentGatewayId: 8a90a2fd807499580180781775c452a8
                          paymentId: null
                          paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                          paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                          paymentScheduleNumber: PS-00000006
                          runHour: 11
                          scheduledDate: '2022-08-18'
                          standalone: false
                          status: Pending
                          updatedById: 8a90e082802185b901802199e15902d1
                          updatedDate: '2022-07-20 21:26:26'
                        - amount: 10
                          billingDocument:
                            id: 8a90a2fd819503b50181959525e5205d
                            number: INV00000001
                            type: Invoice
                          createdById: 8a90e082802185b901802199e15902d1
                          createdDate: '2022-07-20 21:26:26'
                          currency: USD
                          description: test update ps
                          errorMessage: null
                          id: 8a90e0828219a57101821f01c5447f04
                          number: 4
                          paymentGatewayId: 8a90a2fd807499580180781775c452a8
                          paymentId: null
                          paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                          paymentScheduleId: 8a90e0828219a57101821f00287a3abd
                          paymentScheduleNumber: PS-00000006
                          runHour: 11
                          scheduledDate: '2022-09-01'
                          standalone: false
                          status: Pending
                          updatedById: 8a90e082802185b901802199e15902d1
                          updatedDate: '2022-07-20 21:26:26'
                      nextPaymentDate: '2022-08-04'
                      occurrences: 4
                      paymentScheduleNumber: PS-00000006
                      period: BiWeekly
                      recentPaymentDate: '2022-07-21'
                      runHour: 11
                      standalone: false
                      startDate: '2022-07-21'
                      status: Active
                      totalAmount: 40
                      totalPaymentsErrored: 0
                      totalPaymentsProcessed: 1
                      updatedById: '3'
                      updatedDate: '2022-07-21 11:00:21'
              schema:
                $ref: '#/components/schemas/GETPaymentSchedulesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List payment schedules by customer account
      tags:
        - 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.

        - If multiple billing documents are associated to a payment schedule,
        when collecting the payment schedule item, the payment belongs to the
        payment schedule item will be applied to billing documents based on the
        due date of the billing document, in the ascending order.

        - When the Multi-currency and Standalone Payments features are not
        enabled, you can create and update a payment schedule and payment
        schedule item in a currency other than the account currency.

        - 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` or a later available
        version, 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` or a later version.
      operationId: POST_PaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90d61290c9ceb60190d8eac80b1259
                    paymentScheduleNumber: PS-00000001
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    accountNumber: A00000370
                    startDate: '2024-07-31'
                    runHour: 0
                    period: null
                    occurrences: 1
                    status: Active
                    totalAmount: 14.99
                    nextPaymentDate: '2024-07-31'
                    recentPaymentDate: null
                    totalPaymentsProcessed: 0
                    totalPaymentsErrored: 0
                    description: null
                    isCustom: true
                    prepayment: false
                    billingDocument:
                      id: 8a90b44890c9bb0d0190d8c048a90da6
                      number: INV00001823
                      type: Invoice
                    billingDocuments:
                      - id: 8a90b44890c9bb0d0190d8c048a90da6
                        number: INV00001823
                        type: Invoice
                    createdDate: '2024-07-22 13:29:43'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-07-22 13:29:43'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    cancelledById: null
                    cancelledOn: null
                    cancelDate: null
                    items:
                      - id: 8a90d61290c9ceb60190d8eac80e125a
                        number: 1
                        paymentScheduleId: 8a90d61290c9ceb60190d8eac80b1259
                        paymentScheduleNumber: PS-00000001
                        scheduledDate: '2024-07-31'
                        runHour: 0
                        paymentMethodId: null
                        paymentGatewayId: null
                        paymentGatewayNumber: null
                        amount: 14.99
                        balance: 14.99
                        currency: USD
                        status: Pending
                        errorMessage: null
                        paymentId: null
                        billingDocument:
                          id: 8a90b44890c9bb0d0190d8c048a90da6
                          number: INV00001823
                          type: Invoice
                        description: null
                        cancellationReason: null
                        cancelledById: null
                        cancelledOn: null
                        createdDate: '2024-07-22 13:29:43'
                        createdById: 2c92c8f95e2d6ebb015e325df48e02da
                        updatedDate: '2024-07-22 13:29:43'
                        updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    success: true
              schema:
                $ref: '#/components/schemas/POSTPaymentScheduleResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a payment schedule
      tags:
        - Payment Schedules
  /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:**

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

        - If multiple billing documents are associated to a payment schedule,
        when collecting the payment schedule item, the payment belongs to the
        payment schedule item will be applied to billing documents based on the
        due date of the billing document, in the ascending order.


        - 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.
      operationId: POST_PaymentSchedules
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPaymentSchedulesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    paymentSchedules:
                      - id: 402880e741112b310149b7343ef81234
                        paymentScheduleNumber: PS-00311401
                      - id: 402880e741112b310149b7343ef81234
                        paymentScheduleNumber: PS-00311402
              schema:
                $ref: '#/components/schemas/POSTPaymentSchedulesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create multiple payment schedules at once
      tags:
        - Payment Schedules
  /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.
      operationId: GET_PaymentScheduleStatistic
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Specifies the date of the payment schedule statistic you want to
            view. 
          in: path
          name: yyyy-mm-dd
          required: true
          schema:
            format: date
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    date: '2022-07-29'
                    paymentRuns: []
                    paymentScheduleItems:
                      error: 0
                      pending: 0
                      processed: 0
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleStatisticResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve payment schedule statistic of a date
      tags:
        - Payment Schedules
  /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.
      operationId: GET_PaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >
            Number of next pending payment schedule items displayed in the
            response body.
          in: query
          name: nextPendingItems
          required: false
          schema:
            type: integer
        - description: >
            Number of the most recent processed payment schedule items dispalyed
            in the response body.
          in: query
          name: lastProcessedItems
          required: false
          schema:
            type: integer
        - description: >
            The unique ID or number of a payment schedule. For example,
            `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.
          in: path
          name: paymentScheduleKey
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 8a90a2fd8074995801807816dbac52a4
                    accountNumber: A00000002
                    billingDocument:
                      id: 8a90a2fd819503b50181959525e5205d
                      number: INV00000001
                      type: Invoice
                    billingDocuments:
                      - id: 8a26e082802185b201976199e1991521
                        number: INV-001
                        type: Invoice
                      - id: 8a11e082802185b901126e34713407d2
                        number: INV-002
                        type: Invoice
                    createdById: 8a90e082802185b901802199e15902d1
                    createdDate: '2022-07-22 00:43:42'
                    description: ''
                    id: 8a90857b822459cd018224dcb9eb13be
                    isCustom: true
                    items:
                      - amount: 30
                        billingDocument:
                          id: 8a90a2fd819503b50181959525e5205d
                          number: INV00000001
                          type: Invoice
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-22 00:43:42'
                        currency: USD
                        description: ''
                        errorMessage: null
                        id: 8a90857b822459cd018224dcb9ec13bf
                        number: 1
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                        paymentScheduleNumber: PS-00000007
                        runHour: 23
                        scheduledDate: '2022-07-31'
                        standalone: false
                        status: Pending
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-22 00:43:42'
                        cancelledById: null
                        cancelledOn: null
                      - amount: 10
                        billingDocument:
                          id: 8a90a2fd819503b50181959525e5205d
                          number: INV00000001
                          type: Invoice
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-22 00:45:35'
                        currency: USD
                        description: ''
                        errorMessage: null
                        id: 8a90a2fd822459ec018224de77a0359d
                        number: 2
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90857b822459cd018224dcb9eb13be
                        paymentScheduleNumber: PS-00000007
                        runHour: 20
                        scheduledDate: '2022-08-31'
                        standalone: false
                        status: Pending
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-22 00:45:35'
                        cancelledById: null
                        cancelledOn: null
                    nextPaymentDate: '2022-07-31'
                    occurrences: 2
                    paymentScheduleNumber: PS-00000007
                    period: null
                    recentPaymentDate: null
                    runHour: 0
                    standalone: false
                    startDate: '2022-07-31'
                    status: Active
                    success: true
                    totalAmount: 40
                    totalPaymentsErrored: 0
                    totalPaymentsProcessed: 0
                    updatedById: 8a90e082802185b901802199e15902d1
                    updatedDate: '2022-07-22 00:45:36'
                    cancellationReason: null
                    cancelledById: null
                    cancelledOn: null
                    cancelDate: '2022-07-28 00:00:00'
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a payment schedule
      tags:
        - Payment Schedules
    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](https://developer.zuora.com/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.

        - When the Multi-currency and Standalone Payments features are not
        enabled, you can create and update a payment schedule and payment
        schedule item in a currency other than the account currency.
      operationId: PUT_PaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >
            The unique ID or number of a payment schedule. For example,
            `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.
          in: path
          name: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 8a90a2fd8074995801807816dbac52a4
                    accountNumber: A00000002
                    billingDocument: null
                    createdById: 8a90e082802185b901802199e15902d1
                    createdDate: '2022-07-10 01:46:33'
                    description: Details of this payment schedule
                    id: 8a90e08281e10bb00181e749f4db01b8
                    isCustom: false
                    items:
                      - amount: 100
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-10 01:46:33'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e08281e10bb00181e749f4dd01b9
                        number: 1
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 12
                        scheduledDate: '2022-07-10'
                        standalone: true
                        status: Canceled
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 100
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-10 01:46:33'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e08281e10bb00181e749f4e501ba
                        number: 2
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 12
                        scheduledDate: '2022-08-10'
                        standalone: true
                        status: Canceled
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 10
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-10 01:46:33'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e08281e10bb00181e749f4e601bb
                        number: 3
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 23
                        scheduledDate: '2022-11-01'
                        standalone: true
                        status: Pending
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 10
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-24 20:07:12'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a908de6822b2e1501823352ac745b53
                        number: 4
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 23
                        scheduledDate: '2022-12-01'
                        standalone: true
                        status: Pending
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 10
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-28 06:12:39'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e082824456ae018244f00e0317eb
                        number: 5
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 23
                        scheduledDate: '2023-01-01'
                        standalone: true
                        status: Pending
                        updatedById: 8a90e082802185b901802199e159021d
                        updatedDate: '2022-07-28 06:12:39'
                    nextPaymentDate: '2022-11-01'
                    occurrences: 5
                    paymentScheduleNumber: PS-00000002
                    period: Monthly
                    recentPaymentDate: null
                    runHour: 23
                    standalone: true
                    startDate: '2022-07-10'
                    status: Active
                    success: true
                    totalAmount: 230
                    totalPaymentsErrored: 0
                    totalPaymentsProcessed: 0
                    updatedById: 8a90e082802185b901802199e15902d1
                    updatedDate: '2022-07-28 06:12:39'
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a payment schedule
      tags:
        - Payment Schedules
    delete:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Deletes a payment schedule. You can delete a payment schedule with the
        `Canceled` status.
      operationId: deletePaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a payment schedule. For example,
            `8a90857b822459cd018224dcb9eb13be` or `PS-00000007`.
          in: path
          name: paymentScheduleKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a payment schedule
      tags:
        - Payment Schedules
  /v1/payment-schedules/{paymentScheduleKey}/cancel:
    put:
      description: >
        Cancels a payment schedule.


        **Note:**

        - All pending payment schedule items will be canceled, effective from
        `cancelDate`. 

        - 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  <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features"
        target="_blank">Manage Features</a> in the Knowledge Center.

        - This operation is only available if you have <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement"
        target="_blank">Invoice Settlement</a> enabled.

        - For more information on the payment schedule cancellation use case,
        see <a
        href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Schedules/Payment_schedules_use_cases"
        target="_blank">Payment schedules use cases</a> in the Knowledge Center.
      operationId: PUT_CancelPaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >
            The unique ID or number of a payment schedule. For example,
            `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.
          in: path
          name: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTCancelPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402880e741112b310149b7343ef81234
                    accountNumber: A-00000001
                    cf1__c: v1
                    createdById: 402892f942306295014230a4ab4909bf
                    createdDate: '2021-11-01 19:40:00'
                    description: null
                    errorCount: 0
                    id: 402880e749b72b310149b7343ef80005
                    items:
                      - accountId: 402880e741112b310149b7343ef81234
                        amount: 10
                        cf1__c: v1
                        createdById: 402892f942306295014230a4ab4909bf
                        createdDate: '2021-11-01 19:40:00'
                        currency: USD
                        description: null
                        errorMessage: null
                        id: 412880e749b72b310149b7343ef81346
                        number: 1
                        paymentGatewayId: abc
                        paymentId: null
                        paymentMethodId: '123'
                        paymentScheduleId: string
                        paymentScheduleNumber: string
                        runHour: 1
                        scheduledDate: '2021-11-01'
                        status: Canceled
                        updatedById: 402892f942306295014230a4ab4909bf
                        updatedDate: '2021-11-01 19:40:00'
                      - accountId: 402880e741112b310149b7343ef81234
                        amount: 10
                        cf1__c: v1
                        createdById: 402892f942306295014230a4ab4909bf
                        createdDate: '2021-11-01 19:40:00'
                        currency: USD
                        description: null
                        errorMessage: null
                        id: 412880e749b72b310149b7343ef81347
                        number: 2
                        paymentGatewayId: abc
                        paymentId: null
                        paymentMethodId: '123'
                        paymentScheduleId: string
                        paymentScheduleNumber: string
                        runHour: 1
                        scheduledDate: '2021-12-01'
                        status: Canceled
                        updatedById: 402892f942306295014230a4ab4909bf
                        updatedDate: '2021-11-01 19:40:00'
                    nextProcessDate: '2021-11-01'
                    occurrences: 2
                    paymentScheduleNumber: PS-00000001
                    period: Monthly
                    processedCount: 0
                    recentProcessedDate: null
                    runHour: 1
                    startDate: '2021-11-01'
                    status: Canceled
                    success: true
                    totalAmount: 20
                    updatedById: 402892f942306295014230a4ab4909bf
                    updatedDate: '2021-11-01 19:40:00'
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a payment schedule
      tags:
        - Payment Schedules
  /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.

        - When the Multi-currency and Standalone Payments features are not
        enabled, you can create and update a payment schedule and payment
        schedule item in a currency other than the account currency.
      operationId: POST_AddItemsToCustomPaymentSchedule
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >
            The unique ID or number of a payment schedule. For example,
            `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.
          in: path
          name: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTAddItemsToPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90aac892f70c8f0192fb48a8e80281
                    paymentScheduleNumber: PS-00000003
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    accountNumber: A00000370
                    startDate: '2024-11-22'
                    runHour: 0
                    period: null
                    occurrences: 2
                    status: Active
                    totalAmount: 150
                    nextPaymentDate: '2024-11-22'
                    recentPaymentDate: null
                    totalPaymentsProcessed: 0
                    totalPaymentsErrored: 0
                    description: ''
                    isCustom: true
                    prepayment: false
                    billingDocument: null
                    billingDocuments: []
                    createdDate: '2024-11-05 15:44:56'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-11-05 15:46:04'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    cancelledById: null
                    cancelledOn: null
                    cancelDate: null
                    items:
                      - id: 8a90aac892f70c8f0192fb48a9150282
                        number: '1'
                        paymentScheduleId: 8a90aac892f70c8f0192fb48a8e80281
                        paymentScheduleNumber: PS-00000003
                        scheduledDate: '2024-11-22'
                        runHour: 0
                        paymentMethodId: null
                        paymentGatewayId: null
                        paymentGatewayNumber: null
                        amount: 100
                        balance: 100
                        currency: USD
                        status: Pending
                        errorMessage: null
                        paymentId: null
                        psiPayments: []
                        prepayment: false
                        billingDocument: null
                        description: ''
                        cancellationReason: null
                        cancelledById: null
                        cancelledOn: null
                        createdDate: '2024-11-05 15:44:56'
                        createdById: 2c92c8f95e2d6ebb015e325df48e02da
                        updatedDate: '2024-11-05 15:44:56'
                        updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                      - id: 8a9084f992f70ca40192fb49b64d5704
                        number: '2'
                        paymentScheduleId: 8a90aac892f70c8f0192fb48a8e80281
                        paymentScheduleNumber: PS-00000003
                        scheduledDate: '2024-11-22'
                        runHour: 0
                        paymentMethodId: null
                        paymentGatewayId: null
                        paymentGatewayNumber: null
                        amount: 50
                        balance: 50
                        currency: USD
                        status: Pending
                        errorMessage: null
                        paymentId: null
                        psiPayments: []
                        prepayment: false
                        billingDocument: null
                        description: null
                        cancellationReason: null
                        cancelledById: null
                        cancelledOn: null
                        createdDate: '2024-11-05 15:46:04'
                        createdById: 2c92c8f95e2d6ebb015e325df48e02da
                        updatedDate: '2024-11-05 15:46:04'
                        updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    success: true
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Add payment schedule items to a custom payment schedule
      tags:
        - Payment Schedules
  /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](https://developer.zuora.com/api-references/api/tag/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.
      operationId: PUT_PaymentScheduleUpdatePreview
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: >
            The unique ID or number of a payment schedule. For example,
            `8a90857b822459cd018224dcb9eb13be`, or `PS-00000007`.
          in: path
          name: paymentScheduleKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPreviewPaymentScheduleRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 8a90a2fd8074995801807816dbac52a4
                    accountNumber: A00000002
                    billingDocument: null
                    createdById: 8a90e082802185b901802199e15902d1
                    createdDate: '2022-07-10 01:46:33'
                    description: test xiaokai
                    id: 8a90e08281e10bb00181e749f4db01b8
                    isCustom: false
                    items:
                      - amount: 100
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-10 01:46:33'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e08281e10bb00181e749f4dd01b9
                        number: 1
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 12
                        scheduledDate: '2022-07-10'
                        standalone: true
                        status: Canceled
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 100
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-10 01:46:33'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e08281e10bb00181e749f4e501ba
                        number: 2
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 12
                        scheduledDate: '2022-08-10'
                        standalone: true
                        status: Canceled
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 10
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-10 01:46:33'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e08281e10bb00181e749f4e601bb
                        number: 3
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 23
                        scheduledDate: '2022-11-01'
                        standalone: true
                        status: Pending
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 10
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-24 20:07:12'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a908de6822b2e1501823352ac745b53
                        number: 4
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 23
                        scheduledDate: '2022-12-01'
                        standalone: true
                        status: Pending
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                      - amount: 10
                        billingDocument: null
                        createdById: 8a90e082802185b901802199e15902d1
                        createdDate: '2022-07-28 06:12:39'
                        currency: USD
                        description: test xiaokai
                        errorMessage: null
                        id: 8a90e082824456ae018244f00e0317eb
                        number: 5
                        paymentGatewayId: 8a90a2fd807499580180781775c452a8
                        paymentId: null
                        paymentMethodId: 8a90a2fd8074995801807817ebed52aa
                        paymentScheduleId: 8a90e08281e10bb00181e749f4db01b8
                        paymentScheduleNumber: PS-00000002
                        runHour: 23
                        scheduledDate: '2023-01-01'
                        standalone: true
                        status: Pending
                        updatedById: 8a90e082802185b901802199e15902d1
                        updatedDate: '2022-07-28 06:12:39'
                    nextPaymentDate: '2022-11-01'
                    occurrences: 5
                    paymentScheduleNumber: PS-00000002
                    period: Monthly
                    recentPaymentDate: null
                    runHour: 23
                    standalone: true
                    startDate: '2022-07-10'
                    status: Active
                    success: true
                    totalPaymentsErrored: 0
                    totalPaymentsProcessed: 0
                    updatedById: 8a90e082802185b901802199e15902d1
                    updatedDate: '2022-07-28 06:12:39'
              schema:
                $ref: '#/components/schemas/GETPaymentScheduleResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Preview the result of payment schedule updates
      tags:
        - Payment Schedules
  /v1/refunds:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all refunds. Two types of refunds are
        available, electronic refunds and external refunds.


        ### Filtering


        You can use query parameters to restrict the data returned in the
        response. Each query parameter corresponds to one field in the response
        body.


        If the value of a filterable field is string, you can set the
        corresponding query parameter to `null` when filtering. Then, you can
        get the response data with this field value being `null`.


        Examples:


        - /v1/refunds?status=Processed


        - /v1/refunds?amount=4&status=Processed


        - /v1/refunds?status=Processed&type=External&sort=+number
      operationId: GET_Refunds
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: |
            This parameter filters the response based on the `accountId` field.
          in: query
          name: accountId
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `amount` field.
          in: query
          name: amount
          required: false
          schema:
            format: double
            type: number
        - description: >
            This parameter filters the response based on the `createdById`
            field.
          in: query
          name: createdById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `createdDate`
            field.
          in: query
          name: createdDate
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            This parameter filters the response based on the `methodType` field.
          in: query
          name: methodType
          required: false
          schema:
            enum:
              - ACH
              - Cash
              - Check
              - CreditCard
              - PayPal
              - WireTransfer
              - DebitCard
              - CreditCardReferenceTransaction
              - BankTransfer
              - Other
            type: string
        - description: |
            This parameter filters the response based on the `number` field.
          in: query
          name: number
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `paymentId` field.
          in: query
          name: paymentId
          required: false
          schema:
            type: string
        - description: |
            This parameter filters the response based on the `refundDate` field.
          in: query
          name: refundDate
          required: false
          schema:
            format: date
            type: string
        - description: |
            This parameter filters the response based on the `status` field.
          in: query
          name: status
          required: false
          schema:
            enum:
              - Processed
              - Canceled
              - Error
              - Processing
            type: string
        - description: |
            This parameter filters the response based on the `type` field.
          in: query
          name: type
          required: false
          schema:
            enum:
              - External
              - Electronic
            type: string
        - description: >
            This parameter filters the response based on the `updatedById`
            field.
          in: query
          name: updatedById
          required: false
          schema:
            type: string
        - description: >
            This parameter filters the response based on the `updatedDate`
            field.
          in: query
          name: updatedDate
          required: false
          schema:
            format: date-time
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: 


            *operator* *field_name*


            You can use at most two sortable fields in one URL path. Use a comma
            to separate sortable fields. For example:  *operator* *field_name*,
            *operator* *field_name*  


            *operator* is used to mark the order of sequencing. The operator is
            optional. If you only specify the sortable field without any
            operator, the response data is sorted in descending order by this
            field.

              - The `-` operator indicates an ascending order.
              - The `+` operator indicates a descending order.

            By default, the response data is displayed in descending order by
            refund number.


            *field_name* indicates the name of a sortable field. The supported
            sortable fields of this operation are as below:

              - number
              - accountId
              - amount
              - refundDate
              - paymentId
              - createdDate
              - createdById
              - updatedDate
              - updatedById

              
            Examples:


            - /v1/refunds?sort=+number


            - /v1/refunds?status=Processed&sort=-number,+amount
          in: query
          name: sort
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    refunds:
                      - accountId: 4028905f5a87c0ff015a87d25ae90025
                        amount: 4
                        cancelledOn: null
                        comment: update comment
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 14:46:03'
                        creditMemoId: null
                        financeInformation:
                          bankAccountAccountingCode: null
                          bankAccountAccountingCodeType: null
                          transferredToAccounting: 'No'
                          unappliedPaymentAccountingCode: null
                          unappliedPaymentAccountingCodeType: null
                        gatewayId: null
                        gatewayReconciliationReason: null
                        gatewayReconciliationStatus: null
                        gatewayResponse: null
                        gatewayResponseCode: null
                        gatewayState: NotSubmitted
                        id: 4028905f5a87c0ff015a889e590e00c9
                        markedForSubmissionOn: null
                        methodType: CreditCard
                        number: R-00000001
                        paymentId: 4028905f5a87c0ff015a889ddfb800c0
                        paymentMethodId: null
                        paymentMethodSnapshotId: null
                        payoutId: null
                        reasonCode: Standard Refund
                        referenceId: null
                        refundDate: '2017-03-01'
                        refundTransactionTime: null
                        secondRefundReferenceId: null
                        settledOn: null
                        softDescriptor: null
                        softDescriptorPhone: null
                        status: Processed
                        submittedOn: null
                        type: External
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 16:56:41'
                    success: true
              schema:
                $ref: '#/components/schemas/GETRefundCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List refunds
      tags:
        - Refunds
  /v1/refunds/{refundKey}:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Updates the basic and finance information about a refund.
      operationId: PUT_UpdateRefund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID or number of a refund. For example,
            `4028905f5a87c0ff015a889e590e00c9` or `R-00000001`.
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTRefundType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a90a04d90de54810190debe8e3b5a2c
                    number: R-00000287
                    status: Processed
                    type: Electronic
                    methodType: CreditCard
                    accountId: 8a90b4488e7d5c0f018e7db3892400b2
                    amount: 10
                    refundDate: '2024-07-23'
                    comment: null
                    paymentMethodId: 8a90e5e490c9ceb80190d8e9df930bf0
                    paymentMethodSnapshotId: 8a90a04d90de54810190debe8e0c5a29
                    paymentId: 8a90e5e490c9ceb80190d91837840c1d
                    paymentNumber: P-00000387
                    creditMemoId: null
                    reasonCode: Other
                    gatewayId: 8a90d6128ddbaf39018de2d9fe0d2660
                    paymentGatewayNumber: PG-00000001
                    gatewayResponse: Approved
                    gatewayResponseCode: OK
                    gatewayState: Submitted
                    markedForSubmissionOn: null
                    referenceId: null
                    secondRefundReferenceId: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    submittedOn: '2024-07-23 16:39:09'
                    settledOn: null
                    cancelledOn: null
                    createdDate: '2024-07-23 16:39:08'
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2024-07-23 16:49:00'
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    refundTransactionTime: '2024-07-23 16:39:09'
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                      transferredToAccounting: false
                    gatewayReconciliationStatus: null
                    gatewayReconciliationReason: null
                    payoutId: null
                    success: true
              schema:
                $ref: '#/components/schemas/GETRefundType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a refund
      tags:
        - Refunds
    delete:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Deletes a refund. You can delete a refund with the Canceled status. Note
        that refunds applied to credit balance cannot be deleted.
      operationId: DELETE_Refund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a refund or the refund number. For example,
            4028905f5a87c0ff015a889e590e00c9.
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a refund
      tags:
        - Refunds
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about a specific refund.
      operationId: GET_Refund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a refund or the refund number. For example,
            4028905f5a87c0ff015a889e590e00c9.
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028905f5a87c0ff015a87d25ae90025
                    amount: 4
                    cancelledOn: null
                    comment: Create a refund for unapplied payment.
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 14:46:03'
                    creditMemoId: null
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      transferredToAccounting: 'No'
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                    gatewayId: null
                    gatewayReconciliationReason: null
                    gatewayReconciliationStatus: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    id: 4028905f5a87c0ff015a889e590e00c9
                    markedForSubmissionOn: null
                    methodType: CreditCard
                    number: R-00000001
                    paymentId: 4028905f5a87c0ff015a889ddfb800c0
                    paymentMethodId: null
                    paymentMethodSnapshotId: null
                    payoutId: null
                    reasonCode: Standard Refund
                    referenceId: null
                    refundDate: '2017-03-01'
                    refundTransactionTime: null
                    secondRefundReferenceId: null
                    settledOn: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    status: Processed
                    submittedOn: null
                    success: true
                    type: External
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:46:03'
              schema:
                $ref: '#/components/schemas/GETRefundType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a refund
      tags:
        - Refunds
  /v1/refunds/{refundKey}/cancel:
    put:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Cancels a refund.


        If you have the Invoice Settlement feature enabled, refunds applied to
        credit balance cannot be cancelled.
      operationId: PUT_CancelRefund
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a refund or the refund number. For example,
            4028905f5a87c0ff015a889e590e00c9.      
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 4028905f5a87c0ff015a87d25ae90025
                    amount: 4
                    cancelledOn: '2017-03-01 17:03:07'
                    comment: update comment
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 14:46:03'
                    creditMemoId: null
                    financeInformation:
                      bankAccountAccountingCode: null
                      bankAccountAccountingCodeType: null
                      transferredToAccounting: 'No'
                      unappliedPaymentAccountingCode: null
                      unappliedPaymentAccountingCodeType: null
                    gatewayId: null
                    gatewayReconciliationReason: null
                    gatewayReconciliationStatus: null
                    gatewayResponse: null
                    gatewayResponseCode: null
                    gatewayState: NotSubmitted
                    id: 4028905f5a87c0ff015a889e590e00c9
                    markedForSubmissionOn: null
                    methodType: CreditCard
                    number: R-00000001
                    paymentId: 4028905f5a87c0ff015a889ddfb800c0
                    paymentMethodId: null
                    paymentMethodSnapshotId: null
                    payoutId: null
                    reasonCode: Standard Refund
                    referenceId: null
                    refundDate: '2017-03-01'
                    refundTransactionTime: null
                    secondRefundReferenceId: null
                    settledOn: null
                    softDescriptor: null
                    softDescriptorPhone: null
                    status: Canceled
                    submittedOn: null
                    success: true
                    type: External
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 17:03:07'
              schema:
                $ref: '#/components/schemas/GETRefundType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a refund
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about all parts of a refund.
      operationId: GET_RefundParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The number or unique ID of a refund. For example,
            4028905f5a87c0ff015a889e590e00c9.
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    parts:
                      - amount: 4
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 14:46:03'
                        creditMemoId: null
                        id: 4028905f5a87c0ff015a889e592b00cf
                        paymentId: 4028905f5a87c0ff015a889ddfb800c0
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 14:46:03'
                    success: true
              schema:
                $ref: '#/components/schemas/GETRefundPartCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all parts of a refund
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts/{refundpartid}:
    get:
      description: >
        **Note:** This operation is only available if you have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 


        Retrieves the information about a specific refund part.
      operationId: GET_RefundPart
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a specific refund part. You can get the refund part
            ID from the response of [List all parts of a
            refund](https://developer.zuora.com/api-references/api/operation/GET_RefundParts).
          in: path
          name: refundpartid
          required: true
          schema:
            type: string
        - description: >
            The number or unique ID of a refund. For example,
            4028905f5a87c0ff015a889e590e00c9.
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 4
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 14:46:03'
                    creditMemoId: null
                    id: 4028905f5a87c0ff015a889e592b00cf
                    paymentId: 4028905f5a87c0ff015a889ddfb800c0
                    success: true
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:46:03'
              schema:
                $ref: '#/components/schemas/RefundPartResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a refund part
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts/{refundpartid}/item-parts:
    get:
      description: >
        **Note:** This operation is only available if you have the [Invoice Item
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
        feature enabled. Invoice Item Settlement must be used together with
        other Invoice Settlement features (Unapplied Payments, and Credit and
        Debit memos).  If you wish to enable Invoice Settlement, see [Invoice
        Settlement Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.


        Retrieves the information about all items of a refund part. A refund
        part item is a single line item in a refund part. A refund part can
        consist of several different types of items.
      operationId: GET_RefundItemParts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            The unique ID of a specific refund part. You can get the refund part
            ID from the response of [List all parts of a
            refund](https://developer.zuora.com/api-references/api/operation/GET_RefundParts).
          in: path
          name: refundpartid
          required: true
          schema:
            type: string
        - description: >
            The number or unique ID of a refund. For example,
            4028905f5a87c0ff015a889e590e00c9.
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    itemParts:
                      - amount: 4
                        createdById: 402881e522cf4f9b0122cf5d82860002
                        createdDate: '2017-03-01 14:46:03'
                        creditMemoItemId: null
                        creditTaxItemId: null
                        id: 4028905f5a87c0ff015a889e592a00ce
                        updatedById: 402881e522cf4f9b0122cf5d82860002
                        updatedDate: '2017-03-01 14:46:03'
                    success: true
              schema:
                $ref: '#/components/schemas/GETRefundItemPartCollectionType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all refund part items
      tags:
        - Refunds
  /v1/refunds/{refundKey}/parts/{refundpartid}/item-parts/{itempartid}:
    get:
      description: >
        **Note:** This operation is only available if you have the [Invoice Item
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
        feature enabled. Invoice Item Settlement must be used together with
        other Invoice Settlement features (Unapplied Payments, and Credit and
        Debit memos).  If you wish to enable Invoice Settlement, see [Invoice
        Settlement Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.  


        Retrieves the information about a specific refund part item. A refund
        part item is a single line item in a refund part. A refund part can
        consist of several different types of items.
      operationId: GET_RefundItemPart
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The unique ID of a specific refund part item. You can get the refund
            part item ID from the response of [Get refund part
            items](https://developer.zuora.com/api-references/api/operation/GET_RefundItemParts).
          in: path
          name: itempartid
          required: true
          schema:
            type: string
        - description: >
            The unique ID of a specific refund part. You can get the refund part
            ID from the response of [List all parts of a
            refund](https://developer.zuora.com/api-references/api/operation/GET_RefundParts).
          in: path
          name: refundpartid
          required: true
          schema:
            type: string
        - description: >
            The number or unique ID of a refund. For example,
            4028905f5a87c0ff015a889e590e00c9.
          in: path
          name: refundKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    amount: 4
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2017-03-01 14:46:03'
                    creditMemoItemId: null
                    creditTaxItemId: null
                    id: 4028905f5a87c0ff015a889e592a00ce
                    success: true
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2017-03-01 14:46:03'
              schema:
                $ref: '#/components/schemas/GETRefundItemPartType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a refund part item
      tags:
        - Refunds
  /v1/payment-profile:
    put:
      operationId: UpsertPaymentProfiles
      summary: Create or update payment profiles in bulk
      description: >
        Bulk creates payment profiles or updates payment profiles if they
        already exist. 


        You can create or update a maximum of 50 payment profiles in a single
        call.
      tags:
        - Payment Profiles
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bulkPaymentOptionItems:
                  type: array
                  description: |
                    An array of payment profiles you want to create or update.
                  items:
                    properties:
                      subscriptionId:
                        type: string
                        description: >
                          The ID of the subscription associated with the payment
                          profile fields.
                        format: uuid
                      paymentMethodId:
                        type: string
                        description: >
                          The ID of the payment method that processes the
                          payment.
                        format: uuid
                      paymentGatewayId:
                        type: string
                        description: >
                          The ID of the gateway instance that processes the
                          payment.
                        format: uuid
              example:
                bulkPaymentOptionItems:
                  - subscriptionId: 8ad080f08ed1c780018ed6acc5eb65fd
                    paymentGatewayId: 8b48f15831445266784be9fb20be9b40
                    paymentMethodId: 8ad09be48e5bcc3f018e5f0c0791674d
                  - subscriptionId: 2c92c0f86a8dd422016a9e7a70116b0d
                    paymentGatewayId: 8ad086dc88762fc7018876e2a83406ef
                    paymentMethodId: 8ad0950c8292b8560182a75940b808cd
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                example:
                  success: true
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /api/v1/payments/active_invoice_cycle_information/{invoice_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getActiveInvoiceCycle
      summary: List the active retry cycles for an invoice
      description: >
        Gets information of active retry cycles that have not been completed for
        an invoice in Configurable Payment Retry.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
          description: ID of an invoice.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETActiveInvoiceCycleResponse'
  /api/v1/payments/active_debit_memo_cycle_information/{debit_memo_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getActiveDebitMemoCycle
      summary: List the active retry cycles for a debit memo
      description: >
        Gets information of active retry cycles that have not been completed for
        a debit memo in Configurable Payment Retry.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
          description: ID of a debit memo.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETActiveDebitMemoCycleResponse'
  /api/v1/payments/active_account_cycle_information/{account_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getActiveAccountCycle
      summary: List the active retry cycles for an account
      description: >
        Gets information of active retry cycles that have not been completed for
        an account in Configurable Payment Retry.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
          description: ID of an account.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETActiveAccountCycleResponse'
  /api/v1/payments/invoice_cycle_history/{invoice_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getInvoiceCycleHistory
      summary: List the retry cycle history for an invoice
      description: >
        Gets information of all retry cycles for an invoice in Configurable
        Payment Retry.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
          description: ID of an invoice.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETInvoiceCycleHistoryResponse'
  /api/v1/payments/debit_memo_cycle_history/{debit_memo_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getDebitMemoCycleHistory
      summary: List the retry cycle history for a debit memo.
      description: >
        Gets information of all retry cycles for a debit memo in Configurable
        Payment Retry.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
          description: ID of a debit memo.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETDebitMemoCycleHistoryResponse'
  /api/v1/payments/account_cycle_history/{account_id}:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getAccountCycleHistory
      summary: List the retry cycle history for an account
      description: >
        Gets information of all retry cycles for an account in Configurable
        Payment Retry.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
          description: ID of an account.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETAccountCycleHistoryResponse'
  /api/v1/payments/execute_invoice_payment/{invoice_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putExecuteInvoicePayment
      summary: Execute the invoice payment
      description: >
        For all active retry cycles associated with an invoice, schedules the
        next payment retry attempt to occur in the next hourly payment processor
        run.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
          description: ID of an invoice.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: >-
                    Payments with the following IDs enqueued for processing:
                    [290, 291]
  /api/v1/payments/execute_debit_memo_payment/{debit_memo_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putExecuteDebitMemoPayment
      summary: Execute the debit memo payment
      description: >
        For all active retry cycles associated with a debit memo, schedules the
        next payment retry attempt to occur in the next hourly payment processor
        run.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
          description: ID of a debit memo.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: >-
                    Payments with the following IDs enqueued for processing:
                    [300]
  /api/v1/payments/execute_account_payments/{account_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putExecuteAccountPayments
      summary: Execute the account payments
      description: >
        For all active retry cycles associated with an account, schedules the
        next payment retry attempt to occur in the next hourly payment processor
        run.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
          description: ID of an account.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: >-
                    Payments with the following IDs enqueued for processing:
                    [310, 311, 312]
  /api/v1/payments/execute_payments:
    post:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: postExecutePayments
      summary: Execute payments
      description: >
        For all active retry cycles associated with the invoice, debit memo,
        and/or account IDs provided, schedules the next payment retry attempt to
        occur in the next hourly payment processor run.
      tags:
        - Configurable Payment Retry
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account_ids:
                  type: array
                  description: IDs of accounts.
                  items:
                    type: string
                debit_memo_ids:
                  type: array
                  description: IDs of debit memos.
                  items:
                    type: string
                invoice_ids:
                  type: array
                  description: IDs of invoices.
                  items:
                    type: string
              example:
                account_ids:
                  - 2c92c0f96bd69165016bdcbf55ad5e62
                invoice_ids:
                  - 2c92c0fa7853052701785a38c6622473
                  - 2c92c0fa7849b40a01784bc5de0f760f
                debit_memo_ids:
                  - 2c92c0fa7853052701785a38f3bb267f
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: >-
                    Payments with the following IDs enqueued for processing:
                    [100, 101, 110, 111, 121]
  /api/v1/payments/remove_invoice_from_retry_cycle/{invoice_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putRemoveInoviceFromCycle
      summary: Remove an invoice from retry cycle
      description: |
        Stops any active retry cycles associated with the invoice provided.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: invoice_id
          required: true
          schema:
            type: string
          description: ID of an invoice.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: >-
                    Payments with the following IDs have been removed from the
                    retry cycle: [290, 291]
  /api/v1/payments/remove_debit_memo_from_retry_cycle/{debit_memo_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putRemoveDebitMemoFromCycle
      summary: Remove a debit memo from retry cycle
      description: |
        Stops any active retry cycles associated with the debit memo provided.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: debit_memo_id
          required: true
          schema:
            type: string
          description: ID of a debit memo.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: >-
                    Payments with the following IDs have been removed from the
                    retry cycle: [301]
  /api/v1/payments/remove_account_from_retry_cycle/{account_id}:
    put:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: putRemoveAccountFromCycle
      summary: Remove an account from retry cycle
      description: |
        Stops any active retry cycles associated with the account provided.
      tags:
        - Configurable Payment Retry
      parameters:
        - in: path
          name: account_id
          required: true
          schema:
            type: string
          description: ID of an account.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: >-
                    Payments with the following IDs have been removed from the
                    retry cycle: [310, 311, 312]
  /api/v1/payments/submit_failed_payment:
    post:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: postSubmitPaymentToCycle
      summary: Submit a payment to retry cycle
      description: >
        This API request submits a failed payment to the Configurable Payment
        Retry retry cycle. The request adds the failed payment to the existing
        CPR retry cycle. If no CPR retry cycle exists, this request creates a
        new one and adds the failed payment.
      tags:
        - Configurable Payment Retry
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payment_id:
                  type: string
                  description: ID of a failed payment.
              example:
                payment_id: 2c92c0867849d42301784bc9ce806c31
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation is successful.
                  message:
                    type: string
                    description: The response message.
                example:
                  success: true
                  message: Payment entered into retry process
  /api/v1/metrics/baseline:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getBaselineMetrics
      summary: List the baseline metrics
      description: >
        Gets baseline metrics for Configurable Payment Retry, including Retry
        Success Rate and trend, Document Success Rate and trend, and Average
        Days Outstanding and trend. See Response Schema for detailed
        descriptions of the metrics.
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETBaselineMetricsResponse'
  /api/v1/metrics/amount_recovered:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getAmountRecovered
      summary: List the amount recovered metrics
      description: >
        Gets the Amount Recovered metrics, including the total amount recovered
        and the amount recovered over the last 30 days broken down by currency.
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETAmountRecoveredResponse'
  /api/v1/metrics/customer_group_over_time:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getDocumentSuccessRateByCustomerGroup
      summary: List the document success rate metrics by customer group
      description: >
        Gets the Document Success Rate timeseries for each customer group over
        the past 6 months. The data of the current month will not be included.
        For example, if it is April 15th today, the data for April will not be
        included. Data for March and earlier will be shown.
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GETDocumentSuccessRateByCustomerGroupResponse
  /api/v1/metrics/customer_group:
    get:
      security:
        - basicAuth: []
      servers:
        - url: https://payment-retry.apps.zuora.com
      operationId: getCustomerGroupMetrics
      summary: List the customer group metrics
      description: >
        Gets the following metrics for each customer group that is in the active
        status:
          - Document Success Rate and trend
          - Retry Success Rate
          - Average Attempts
      tags:
        - Configurable Payment Retry
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETCustomerGroupMetricsResponse'
  /v1/summary-statement-runs:
    post:
      description: >
        Allows you to initiate the generation of a summary statement run.

        You can specify parameters such as the run type (AdHoc or scheduled) and
        the target account categories (single or multiple accounts).
      operationId: createSummaryStatementRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SummaryStatementRunRequestType'
            examples:
              Example1:
                value:
                  description: >-
                    This is a sample response for accounts from a batch with a
                    billCycleDay of 01.
                  runType: AdHoc
                  targetAccountCategory: AllAccounts
                  batchName: Batch1
                  billCycleDay: '01'
                  dateRangeType: PreviousOneCalendarMonth
                  autoEmailEnabled: false
              Example2:
                value:
                  description: >-
                    This is a sample response for accounts from a batch with
                    open invoices.
                  runType: AdHoc
                  targetAccountCategory: AccountsWithOpenInvoices
                  batchName: Batch1
                  dateRangeType: PreviousOneCalendarMonth
                  autoEmailEnabled: false
              Example3:
                value:
                  description: >-
                    This is a sample response for accounts from a batch with a
                    billCycleDay of 01 that has open invoices.
                  runType: AdHoc
                  targetAccountCategory: AccountsWithOpenInvoices
                  batchName: Batch1
                  dateRangeType: PreviousOneCalendarMonth
                  autoEmailEnabled: false
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 402881869169397401916d8ff8d218c5
                    statementRunNumber: SSR-00000004
                    targetAccountCategory: AllAccounts
                    accountKey: null
                    runType: AdHoc
                    batchName: Batch51
                    billCycleDay: null
                    dateRangeType: PreviousThreeCalendarMonth
                    startDate: '2024-05-01 19:13:57'
                    endDate: '2024-07-31 19:13:57'
                    autoEmailEnabled: false
                    description: HelloWorld
                    status: Pending
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2024-08-19 19:13:57'
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2024-08-20 10:13:57.586'
                    success: true
              schema:
                $ref: '#/components/schemas/SummaryStatementRunResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              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"
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                        requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                        success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header. 
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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. 
              schema:
                maxLength: 64
                type: string
      summary: Create a summary statement run
      tags:
        - Summary Statements
  /v1/accounting-codes:
    get:
      description: >-
        This reference describes how to query all accounting codes in your chart
        of accounts through the REST API.
      operationId: GET_AllAccountingCodes
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_accounting'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountingCodes:
                      - category: Assets
                        createdBy: e20b074746ec48f40147140f51e30a1a
                        createdOn: '2014-07-29 02:20:20'
                        glAccountName: null
                        glAccountNumber: null
                        id: e20b0747478025a10147816ba1c20097
                        name: Accounts Receivable
                        notes: null
                        status: Active
                        type: AccountsReceivable
                        updatedBy: e20b074746ec48f40147140f51e30a1a
                        updatedOn: '2014-07-29 02:20:20'
                      - category: Revenue
                        createdBy: e20b074746ec48f40147140f51e30a1a
                        createdOn: '2014-07-29 02:20:20'
                        glAccountName: null
                        glAccountNumber: null
                        id: e20b0747478025a10147816ba21900a0
                        name: Discounts
                        notes: null
                        status: Inactive
                        type: SalesDiscounts
                        updatedBy: e20b074746ec48f40147140f51e30a1a
                        updatedOn: '2014-09-27 22:11:07'
                    success: true
              schema:
                $ref: '#/components/schemas/GETAccountingCodesType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all accounting codes
      tags:
        - Accounting Codes
    post:
      description: >
        This reference describes how to create a new accounting code through the
        REST API. 

        The accounting code will be active as soon as it has been created.


        ### Prerequisites
          If you have Zuora Finance enabled on your tenant, you must have the  Configure Accounting Codes permission. 
      operationId: POST_AccountingCode
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTAccountingCodeType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8a8081ae547aac1e01547efb61f20140
                    success: true
              schema:
                $ref: '#/components/schemas/POSTAccountingCodeResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an accounting code
      tags:
        - Accounting Codes
  /v1/accounting-codes/{ac-id}:
    delete:
      description: >
        This reference describes how to delete an accounting code through the
        REST API.

        ### Prerequisites

        If you have Zuora Finance enabled on your tenant, then you must have the
        Delete Unused Accounting Code permission.

        ### Limitations

        You can only delete accounting codes that have never been associated
        with any transactions. An accounting code must be deactivated before you
        can delete it.
      operationId: DELETE_AccountingCode
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting code you want to delete.
          in: path
          name: ac-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an accounting code
      tags:
        - Accounting Codes
    get:
      description: >-
        This reference describes how to query an accounting code through the
        REST API.
      operationId: GET_AccountingCode
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting code you want to query.
          in: path
          name: ac-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    category: Assets
                    createdBy: e20b074746ec48f40147140f51e30a1a
                    createdOn: '2016-05-04 01:23:07'
                    glAccountName: null
                    glAccountNumber: null
                    id: 8a8081ae547aac1e01547efb61f20140
                    name: CASH
                    notes: null
                    status: Active
                    success: true
                    type: Cash
                    updatedBy: e20b074746ec48f40147140f51e30a1a
                    updatedOn: '2016-05-05 20:07:38'
              schema:
                $ref: '#/components/schemas/GETAccountingCodeItemType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an accounting code
      tags:
        - Accounting Codes
    put:
      description: >
        This reference describes how to update an existing accounting code
        through the REST API.

        ### Prerequisites
          If you have Zuora Finance enabled on your tenant, you must have the  Manage Accounting Code permission. 
        ### Limitations

        You can only update accounting codes that are not already associated
        with any transactions.
      operationId: PUT_AccountingCode
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting code you want to update.
          in: path
          name: ac-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTAccountingCodeType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an accounting code
      tags:
        - Accounting Codes
  /v1/accounting-codes/{ac-id}/activate:
    put:
      description: >
        This reference describes how to activate an accounting code through the
        REST API.


        Prerequisites

        -------------

        If you have Zuora Finance enabled on your tenant, you must have the
        Manage Accounting Code permission. 
      operationId: PUT_ActivateAccountingCode
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting code you want to activate.
          in: path
          name: ac-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Activate an accounting code
      tags:
        - Accounting Codes
  /v1/accounting-codes/{ac-id}/deactivate:
    put:
      description: >
        This reference describes how to deactivate an accounting code through
        the REST API.


        ### Prerequisites

        If you have Zuora Finance enabled on your tenant, you must have the
        Manage Accounting Code permission.

        ### Limitations

        You can only deactivate accounting codes that are not associated with
        any transactions. 

        You cannot disable accounting codes of type AccountsReceivable.
      operationId: PUT_DeactivateAccountingCode
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting code you want to deactivate.
          in: path
          name: ac-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Deactivate an accounting code
      tags:
        - Accounting Codes
  /v1/accounting-periods:
    get:
      description: Retrieves all accounting periods on your tenant.
      operationId: GET_AllAccountingPeriods
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_accounting'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountingPeriods:
                      - createdBy: e20b074746ec48f40147140f51e30a1a
                        createdOn: '2016-03-16 23:17:25'
                        endDate: '2016-03-31'
                        fileIds:
                          accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5374904f01538340274a13f4
                          accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5374904f01538340273013f3
                          arRollForwardDetailExportFileId: null
                          fxRealizedGainAndLossDetailExportFileId: null
                          fxUnrealizedGainAndLossDetailExportFileId: null
                          revenueDetailCsvFileId: 8a8081ae5374904f0153834033221418
                          revenueDetailExcelFileId: 8a8081ae5374904f0153834032e41417
                          unprocessedChargesFileId: null
                        fiscalYear: 2016
                        id: 8a8081ae5374904f01538338b66e1005
                        name: Mar 2016
                        notes: ''
                        runTrialBalanceEnd: null
                        runTrialBalanceErrorMessage: >-
                          Error creating the trial balance: exchange rate from
                          USD to GBP on 08/03/2015 is not available.  Please
                          import the rate and run trial balance again.
                        runTrialBalanceStart: '2016-03-16 23:25:22'
                        runTrialBalanceStatus: Error
                        startDate: '2016-03-01'
                        status: Open
                        updatedBy: e20b074746ec48f40147140f51e30a1a
                        updatedOn: '2016-03-16 23:25:22'
                      - createdBy: e20b074746ec48f40147140f51e30a1a
                        createdOn: '2016-03-16 23:17:50'
                        endDate: '2016-04-30'
                        fileIds:
                          accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5374904f0153833e9a7a1364
                          accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5374904f0153833e9a651363
                          arRollForwardDetailExportFileId: null
                          fxRealizedGainAndLossDetailExportFileId: null
                          fxUnrealizedGainAndLossDetailExportFileId: null
                          revenueDetailCsvFileId: 8a8081ae5374904f0153833ea2d613af
                          revenueDetailExcelFileId: 8a8081ae5374904f0153833ea2c813ae
                          unprocessedChargesFileId: null
                        fiscalYear: 2016
                        id: 8a8081ae5374904f0153833918af1007
                        name: Apr 2016
                        notes: ''
                        runTrialBalanceEnd: null
                        runTrialBalanceErrorMessage: null
                        runTrialBalanceStart: '2016-03-16 23:23:40'
                        runTrialBalanceStatus: Error
                        startDate: '2016-04-01'
                        status: Open
                        updatedBy: e20b074746ec48f40147140f51e30a1a
                        updatedOn: '2016-03-16 23:23:40'
                      - createdBy: e20b074746ec48f40147140f51e30a1a
                        createdOn: '2016-03-16 23:23:29'
                        endDate: '2016-05-31'
                        fileIds:
                          accountsReceivableAccountAgingDetailExportFileId: null
                          accountsReceivableInvoiceAgingDetailExportFileId: null
                          arRollForwardDetailExportFileId: null
                          fxRealizedGainAndLossDetailExportFileId: null
                          fxUnrealizedGainAndLossDetailExportFileId: null
                          revenueDetailCsvFileId: 8a8081ae54c2eabb0154c307e2920034
                          revenueDetailExcelFileId: 8a8081ae54c2eabb0154c307e27e0033
                          unprocessedChargesFileId: null
                        fiscalYear: 2016
                        id: 8a8081ae5374904f0153833e4590132d
                        name: May 2016
                        notes: ''
                        runTrialBalanceEnd: null
                        runTrialBalanceErrorMessage: null
                        runTrialBalanceStart: '2016-05-18 01:42:30'
                        runTrialBalanceStatus: Error
                        startDate: '2016-05-01'
                        status: Open
                        updatedBy: e20b074746ec48f40147140f51e30a1a
                        updatedOn: '2016-05-18 01:42:30'
                      - createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdOn: '2014-07-28 23:52:46'
                        endDate: null
                        fileIds:
                          accountsReceivableAccountAgingDetailExportFileId: null
                          accountsReceivableInvoiceAgingDetailExportFileId: null
                          arRollForwardDetailExportFileId: null
                          fxRealizedGainAndLossDetailExportFileId: null
                          fxUnrealizedGainAndLossDetailExportFileId: null
                          revenueDetailCsvFileId: null
                          revenueDetailExcelFileId: null
                          unprocessedChargesFileId: null
                        fiscalYear: 0
                        id: e20b0747478025a1014780e489a60002
                        name: Open-Ended
                        notes: null
                        runTrialBalanceEnd: null
                        runTrialBalanceErrorMessage: null
                        runTrialBalanceStart: null
                        runTrialBalanceStatus: Pending
                        startDate: '2016-06-01'
                        status: Open
                        updatedBy: e20b074746ec48f40147140f51e30a1a
                        updatedOn: '2016-03-16 23:23:29'
                    success: true
              schema:
                $ref: '#/components/schemas/GETAccountingPeriodsType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all accounting periods
      tags:
        - Accounting Periods
    post:
      description: >-
        Creates an accounting period.

        Prerequisites

        -------------

        * You must have Zuora Finance enabled on your tenant.

        * You must have the Create Accounting Period user permission.


        Limitations

        -----------

        * When creating the first accounting period on your tenant, the start
        date must be equal to or earlier than the date of the earliest
        transaction on the tenant.

        * Start and end dates of accounting periods must be contiguous. For
        example, if one accounting period ends on January 31, the next period
        must start on February 1.

        * If you have the Revenue Recognition Package and have enabled the
        "Monthly recognition over time" revenue recognition model, the
        accounting period start date and end date must be on the first day and
        last day of the month, respectively. Note that the start and end dates
        do not necessarily have to be in the same month.
      operationId: POST_AccountingPeriod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTAccountingPeriodType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 7b7181ae547aac1e01547efb61f20162
                    success: true
              schema:
                $ref: '#/components/schemas/POSTAccountingPeriodResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an accounting period
      tags:
        - Accounting Periods
  /v1/accounting-periods/{ap-id}:
    delete:
      description: >
        Deletes an accounting period.


        ### Prerequisites

        * You must have Zuora Finance enabled on your tenant.

        * You must have the Delete Accounting Period user permission. See
        [Finance
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).
         
        ### Limitations

        The accounting period to be deleted:
          * Must be the most recent accounting period.
          * Must be an open accounting period.
          * Must have no revenue distributed into it.
          * Must not have any active journal entries.
          * Must not be the open-ended accounting period.
          * Must not be in the process of running a trial balance.
      operationId: DELETE_AccountingPeriod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting period you want to delete.
          in: path
          name: ap-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an accounting period
      tags:
        - Accounting Periods
    get:
      description: |
        Retrieves an accounting period.

        **Prerequisites**: You must have Zuora Finance enabled on your tenant.
      operationId: GET_AccountingPeriod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting period you want to get.
          in: path
          name: ap-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    createdBy: e20b074746ec48f40147140f51e30a1a
                    createdOn: '2014-11-25 22:21:22'
                    endDate: '2014-10-31'
                    fileIds:
                      accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5002967c015012f1230e0914
                      accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5002967c015012f122f10913
                      accountsReceivableDebitMemoAgingDetailExportFileId: 8a8081ae5002967c015012f122f40913
                      arRollForwardDetailExportFileId: 8a8081ae5002967c015012f15d7b09e2
                      fxRealizedGainAndLossDetailExportFileId: 8a8081ae5002967c015012f151a609ba
                      fxUnrealizedGainAndLossDetailExportFileId: 8a8081ae5002967c015012f150b509b8
                      revenueDetailCsvFileId: 8a8081ae5002967c015012f129a10926
                      revenueDetailExcelFileId: 8a8081ae5002967c015012f129870925
                      unprocessedChargesFileId: null
                    fiscalYear: 2014
                    id: e20b074749d2a38b0149eac2e9550aa9
                    name: Oct 2014
                    notes: ''
                    runTrialBalanceEnd: '2015-09-28 00:53:36'
                    runTrialBalanceErrorMessage: null
                    runTrialBalanceStart: '2015-09-28 00:53:13'
                    runTrialBalanceStatus: Completed
                    startDate: '2014-10-01'
                    status: Closed
                    success: true
                    updatedBy: e20b074746ec48f40147140f51e30a1a
                    updatedOn: '2015-09-28 00:53:13'
              schema:
                $ref: '#/components/schemas/GETAccountingPeriodType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an accounting period
      tags:
        - Accounting Periods
    put:
      description: >

        Updates an accounting period.


        Prerequisites

        -------------


        * You must have Zuora Finance enabled on your tenant.


        * You must have the Create Accounting Period user permission. See
        [Finance
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).


        Limitations

        -----------


        * You can update the start date of only the earliest accounting period
        on your tenant. You cannot update the start date of later periods.


        * If you update the earliest accounting period, the start date must be
        equal to or earlier than the date of the earliest transaction on the
        tenant.


        * Start and end dates of accounting periods must be contiguous. For
        example, if one accounting period ends on January 31, the next period
        must start on February 1.


        * If you have the Revenue Recognition Package and have enabled the
        "Monthly recognition over time" revenue recognition model, the
        accounting period start date and end date must be on the first day and
        last day of the month, respectively. Note that the start and end dates
        do not necessarily have to be in the same month.


        * You cannot update the start date or end date of an accounting period
        if:
          * Any revenue has been distributed into the period.
          * The period has any active journal entries.
      operationId: PUT_UpdateAccountingPeriod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting period you want to update.
          in: path
          name: ap-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTAccountingPeriodType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an accounting period
      tags:
        - Accounting Periods
  /v1/accounting-periods/{ap-id}/close:
    put:
      description: >-
        Close an accounting period by accounting period ID.


        Prerequisites

        -------------

        You must have Zuora Finance enabled on your tenant. You must have the
        Manage Close Process and Run Trial Balance user permissions.


        Limitations

        -----------

        * The accounting period cannot already be closed.

        * The accounting period cannot be in the process of running a trial
        balance.

        * All earlier accounting periods must be closed.

        * There must be no required action items for the accounting period. See
        Reconcile Transactions Before Closing an Accounting Period for more
        information.


        Notes

        -----

        When you close an accounting period in Zuora, a trial balance is
        automatically run for that period. A successful response means only that
        the accounting period is now closed, but does not mean that the trial
        balance has successfully completed.
      operationId: PUT_CloseAccountingPeriod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting period you want to close.
          in: path
          name: ap-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Close an accounting period
      tags:
        - Accounting Periods
  /v1/accounting-periods/{ap-id}/pending-close:
    put:
      description: >
        Sets an accounting period to pending close.



        Prerequisites

        -------------


        * You must have Zuora Finance enabled on your tenant.

        * You must have the Manage Close Process and Run Trial Balance user
        permissions.

                    
        Limitations 
         -----------
         
         * The accounting period cannot be closed or pending close.
         
         * The accounting period cannot be in the process of running a trial balance.
         
         * All earlier accounting periods must be closed.

         

         
        Notes

        -----

        When you set an accounting period to pending close in Zuora, a trial
        balance is automatically run for that period. A response of `{
        "success": true }`  means only that the accounting period status is now
        pending close, but does not mean that the trial balance has successfully
        completed. You can use the Get Accounting Period REST API call to view
        details about the outcome of the trial balance.
      operationId: PUT_PendingCloseAccountingPeriod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting period you want to set to pending close.
          in: path
          name: ap-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Set an accounting period to pending close
      tags:
        - Accounting Periods
  /v1/accounting-periods/{ap-id}/reopen:
    put:
      description: >-
        Re-opens an accounting period.

        Prerequisites

        -------------

        * You must have Zuora Finance enabled on your tenant.

        * You must have the Manage Close Process and Run Trial Balance user
        permissions.


        Limitations

        -----------

        * The accounting period must be closed or pending close.

        * You can only re-open an accounting period that is immediately previous
        to an open period.
      operationId: PUT_ReopenAccountingPeriod
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ID of the accounting period that you want to re-open.
          in: path
          name: ap-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Reopen an accounting period
      tags:
        - Accounting Periods
  /v1/accounting-periods/{ap-id}/run-trial-balance:
    put:
      description: >
        Runs the trial balance for an accounting period. 


        Prerequisites

        -------------


        * You must have Zuora Finance enabled on your tenant.


        * You must have the Manage Close Process and Run Trial Balance user
        permissions. See [Finance
        Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).

                  
        Limitations 

        -----------
         
         * The accounting period must be open.
         
         * The accounting period cannot already be in the process of running a trial balance.

         
        Notes

        -----

        The trial balance is run asynchronously. A response of `{ "success":
        true }` means only that the trial balance has started processing, but
        does not mean that the trial balance has successfully completed. You can
        use the [Get Accounting
        Period](https://developer.zuora.com/api-references/api/operation/GET_AccountingPeriod)
        REST API call to view details about the outcome of the trial balance.
      operationId: PUT_RunTrialBalance
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            ID of the accounting period for which you want to run a trial
            balance.
          in: path
          name: ap-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Run trial balance
      tags:
        - Accounting Periods
  /v1/journal-entries:
    post:
      description: >
        This REST API reference describes how to manually create a summary
        journal entry. Request and response field descriptions and sample code
        are provided.

        ### Requirements

        1.The sum of debits must equal the sum of credits in the summary journal
        entry.


        2.The following applies only if you use foreign currency conversion:
          * If you have configured Aggregate transactions with different currencies during a Journal Run to "Yes", the value of the **currency** field must be the same as your tenant's home currency. That is, you must create journal entries using your home currency.
          * All journal entries in an accounting period must either all be aggregated or all be unaggregated. You cannot have a mix of aggregated and unaggregated journal entries in the same accounting period.
      operationId: POST_SummaryJournalEntry
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTJournalEntryType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    journalEntryNumber: JE-00000001
                    success: true
              schema:
                $ref: '#/components/schemas/POSTJournalEntryResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a summary journal entry
      tags:
        - Summary Journal Entries
  /v1/journal-entries/journal-runs/{jr-number}:
    get:
      description: >

        This REST API reference describes how to retrieve information about all
        summary journal entries in a journal run.
      operationId: GET_AllSummaryJournalEntries
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_revenue'
        - description: Journal run number.
          in: path
          name: jr-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    journalEntries:
                      - accountingPeriodName: Dec'16
                        aggregateCurrency: true
                        currency: USD
                        homeCurrency: USD
                        journalEntryDate: '2016-12-31'
                        journalEntryItems:
                          - accountingCodeName: Accounts Receivable
                            accountingCodeType: AccountsReceivable
                            amount: 100
                            glAccountName: Accounts Receivable
                            glAccountNumber: 10-001-000-1234
                            homeCurrencyAmount: 100
                            type: Debit
                          - accountingCodeName: Sales Revenue
                            accountingCodeType: SalesRevenue
                            amount: 100
                            glAccountName: Sales Revenue
                            glAccountNumber: 10-001-000-1000
                            homeCurrencyAmount: 100
                            type: Credit
                        notes: note
                        number: JE-00000006
                        segments:
                          - segmentName: Seg1
                            segmentValue: seg value
                        status: Created
                        timePeriodEnd: '2016-12-31'
                        timePeriodStart: '2016-12-01'
                        transactionType: Invoice Item
                        transferredToAccounting: 'No'
                    success: true
              schema:
                $ref: '#/components/schemas/GETJournalEntriesInJournalRunType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all summary journal entries in a journal run
      tags:
        - Summary Journal Entries
  /v1/journal-entries/{je-number}:
    delete:
      description: >
        This reference describes how to delete a summary journal entry using the
        REST API.


        You must have the "Delete Cancelled Journal Entry" user permission
        enabled to delete summary journal entries.


        A summary journal entry must be canceled before it can be deleted.
      operationId: DELETE_SummaryJournalEntry
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Journal entry number in the format JE-00000001.
          in: path
          name: je-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a summary journal entry
      tags:
        - Summary Journal Entries
    get:
      description: >
        This REST API reference describes how to get information about a summary
        journal entry by its journal entry number.
      operationId: GET_SummaryJournalEntry
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: ''
          in: path
          name: je-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountingPeriodName: Jan'16
                    aggregateCurrency: true
                    currency: USD
                    homeCurrency: USD
                    journalEntryDate: '2016-01-31'
                    journalEntryItems:
                      - accountingCodeName: Deferred Revenue
                        accountingCodeType: DeferredRevenue
                        amount: 424.08
                        glAccountName: null
                        glAccountNumber: null
                        homeCurrencyAmount: 424.08
                        type: Debit
                      - accountingCodeName: Professional Services Revenue
                        accountingCodeType: SalesRevenue
                        amount: 424.08
                        glAccountName: null
                        glAccountNumber: null
                        homeCurrencyAmount: 424.08
                        type: Credit
                    notes: null
                    number: JE-00000001
                    segments:
                      - segmentName: Customer Code
                        segmentValue: A00000001
                      - segmentName: Charge Type
                        segmentValue: OneTime
                    status: Created
                    success: true
                    timePeriodEnd: '2016-01-31'
                    timePeriodStart: '2016-01-01'
                    transactionType: Revenue Event Item
                    transferDateTime: null
                    transferredBy: null
                    transferredToAccounting: null
              schema:
                $ref: '#/components/schemas/GETJournalEntryDetailType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a summary journal entry
      tags:
        - Summary Journal Entries
  /v1/journal-entries/{je-number}/basic-information:
    put:
      description: >

        This REST API reference describes how to update the basic information of
        a summary journal entry. Request and response field descriptions and
        sample code are provided.
      operationId: PUT_BasicSummaryJournalEntry
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Journal entry number in the format JE-00000001.
          in: path
          name: je-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTBasicSummaryJournalEntryType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a summary journal entry
      tags:
        - Summary Journal Entries
  /v1/journal-entries/{je-number}/cancel:
    put:
      description: >

        This reference describes how to cancel a summary journal entry using the
        REST API.
            
        You must have the "Cancel Journal Entry" user permission enabled to
        cancel summary journal entries.
            
        A summary journal entry cannot be canceled if its Transferred to
        Accounting status is "Yes" or "Processing".
      operationId: PUT_SummaryJournalEntry
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Journal entry number in the format JE-00000001.
          in: path
          name: je-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a summary journal entry
      tags:
        - Summary Journal Entries
  /v1/journal-runs:
    post:
      description: >
        This REST API reference describes how to create a journal run. Request
        and response field descriptions and sample code are provided.
      operationId: POST_JournalRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTJournalRunType'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    journalRunNumber: JR-00000008
                    success: true
              schema:
                $ref: '#/components/schemas/POSTJournalRunResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a journal run
      tags:
        - Journal Runs
  /v1/journal-runs/{jr-number}:
    delete:
      description: |
        This reference describes how to delete a journal run using the REST API.
                              
         You can only delete journal runs that have already been canceled.
                              
         You must have the "Delete Cancelled Journal Run" Zuora Finance user permission enabled to delete journal runs.
      operationId: DELETE_JournalRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Journal run number. Must be a valid journal run number in the format
            `JR-00000001`.
          in: path
          name: jr-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a journal run
      tags:
        - Journal Runs
    get:
      description: >
        This REST API reference describes how to get information about a journal
        run. Request and response field descriptions and sample code are
        provided.
      operationId: GET_JournalRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Journal run number. Must be a valid journal run number in the format
            `JR-00000001`.
          in: path
          name: jr-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    executedOn: '2014-11-15 22:05:12'
                    journalEntryDate: '2016-02-02'
                    number: JR-00000002
                    segmentationRuleName: s1
                    status: Completed
                    success: true
                    targetEndDate: '2016-03-31'
                    targetStartDate: '2016-03-01'
                    totalJournalEntryCount: 2
                    transactionTypes:
                      - type: Invoice Item
              schema:
                $ref: '#/components/schemas/GETJournalRunType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a journal run
      tags:
        - Journal Runs
  /v1/journal-runs/{jr-number}/cancel:
    put:
      description: >
        This reference describes how to cancel a journal run using the REST API.
                  
        The summary journal entries in the journal run are canceled
        asynchronously. See the "Example" section below for details.
                  
        You must have the "Cancel Journal Run" Zuora Finance user permission
        enabled to cancel journal runs.


        ### Notes

        When you cancel a journal run, the summary journal entries associated
        with that journal run are canceled asynchronously. A response of `{
        "success": true }` means only that the specified journal run has a
        status of "Pending", "Error", or "Completed" and therefore can be
        canceled, but does not mean that the whole journal run was successfully
        canceled.


        For example, let's say you want to cancel journal run JR-00000075. The
        journal run status is "Completed" and it contains ten journal entries.
        One of the journal entries has its Transferred to Accounting status set
        to "Yes", meaning that the entry cannot be canceled. The workflow might
        go as follows:

        1. You make an API call to cancel the journal run.

        2. The journal run status is "Completed", so you receive a response of
        `{ "success": true }`.

        3. Zuora begins asynchronously canceling journal entries associated with
        the journal run. The journal entry whose Transferred to Accounting
        status is "Yes" fails to be canceled. The cancelation process continues,
        and the other journal entries are successfully canceled.

        4. The journal run status remains as "Completed". The status does not
        change to "Canceled" because the journal run still contains a journey
        entry that is not canceled.
      operationId: PUT_JournalRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            Journal run number. Must be a valid journal run number in the format
            JR-00000001. 

            You can only cancel a journal run whose status is "Pending",
            "Error", or "Completed".
          in: path
          name: jr-number
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a journal run
      tags:
        - Journal Runs
  /v1/bulk:
    post:
      description: >
        Describes how to perform a mass action through the REST API. 


        Using this API method, you send a multipart/form-data request containing
        a `.csv` file with data about the mass action you want to perform. Zuora
        returns a key and then asynchronously processes the mass action. You can
        use the key to get details about the result of the mass action.


        If you want to use this operation to perform the Mass Payment Upload
        (MPU) mass action, see [Mass Payment
        Upload](https://knowledgecenter.zuora.com/Billing/Finance/Mass_Updater/Mass_Payment_Upload)
        for more information.
      operationId: POST_MassUpdater
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: >
                    File containing data about the mass action you want to
                    perform. The file requirements are the same as when
                    uploading a file through the Mass Updater in the Zuora UI.
                    The file must be a `.csv` file or a zipped `.csv` file.


                    The maximum file size is 4 MB.


                    The data in the file must be formatted according to the mass
                    action type you want to perform.
                  format: binary
                  type: string
                params:
                  description: >
                    Container for the following fields. You must format this
                    parameter as a JSON object.


                    * `actionType` (string, **Required**) - Type of mass action
                    you want to perform. The following mass actions are
                    supported: `UpdateAccountingCode`, `CreateRevenueSchedule`,
                    `UpdateRevenueSchedule`, `DeleteRevenueSchedule`,
                    `ImportFXRate`, and `MPU`.


                    * `checksum` (string) - An MD5 checksum that is used to
                    validate the integrity of
                      the uploaded file. The checksum is a 32-character string.
                  type: string
              required:
                - file
                - params
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    bulkKey: 402892f04c97b89a014c97bb30a50003
                    success: true
              schema:
                $ref: '#/components/schemas/POSTMassUpdateResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Perform a mass action
      tags:
        - Mass Updater
      x-code-samples:
        - label: cURL
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1" -F
            "file=@CreateRevenueSchedules.csv" -F "params="{\"actionType\":
            \"CreateRevenueSchedule\"}" "https://rest.zuora.com/v1/bulk"
  /v1/bulk/{bulk-key}:
    get:
      description: >
        Describes how to get information about the result of a mass action
        through the REST API. 
      operationId: GET_MassUpdater
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            String of 32 characters that identifies a mass action. You get the
            bulk-key after performing a mass action through the REST API.
          in: path
          name: bulk-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    actionType: UpdateAccountingCode
                    endedOn: '2015-04-07 14:32:01'
                    errorCount: 1
                    inputSize: 354
                    outputSize: 350
                    outputType: (url:.csv.zip)
                    outputURL: >-
                      https://rest.zuora.com/v1/files/402892c84c9285b1014c9293f5320007
                    processedCount: 3
                    startedOn: '2015-04-07 14:22:11'
                    status: Completed
                    success: true
                    successCount: 2
                    totalCount: 3
                    uploadedBy: smith@example.com
                    uploadedOn: '2015-04-07 14:22:09'
              schema:
                $ref: '#/components/schemas/GETMassUpdateType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all results of a mass action
      tags:
        - Mass Updater
  /v1/bulk/{bulk-key}/stop:
    put:
      description: >
        Describes how to stop a mass action through the REST API. You can stop a
        mass action when its status is Pending or Processing. After you have
        stopped a mass action, you can get the mass action result to see details
        of the mass action.


        - If you stop a mass action when its status is Pending, no response file
        is generated because no records have been processed.


        - If you stop a mass action when its status is Processing, a response
        file is generated. You can check the response file to see which records
        have been processed and which have not. In the response file, the
        **Success** column has the value `Y` (successful) or `N` (failed) for
        processed records, and a blank value for unprocessed records.


        Records that have already been processed when a mass action is stopped
        are not rolled back.
      operationId: PUT_MassUpdater
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            String of 32 characters that identifies a mass action. You get the
            bulk-key after performing a mass action through the REST API.
          in: path
          name: bulk-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Stop a mass action
      tags:
        - Mass Updater
  /events/event-triggers:
    post:
      description: >
        When you create an event trigger, you must specify the base object and
        define the trigger condition.


        ### Specify the base object


        Use `baseObject` field to specify which object to define a trigger on.
        You can define an event trigger on any of the following objects:
          
        * Account

        * AccountingCode

        * AccountingPeriod

        * Amendment

        * BillingRun

        * Contact

        * CreditBalanceAdjustment

        * CreditMemo

        * CreditMemoApplication

        * CreditMemoApplicationItem

        * CreditMemoItem

        * CreditMemoPart

        * DebitMemo

        * DebitMemoItem

        * DeliveryAdjustment

        * Feature

        * Fulfillment

        * Fund

        * Invoice

        * InvoiceAdjustment

        * InvoiceItem

        * InvoiceItemAdjustment

        * JournalEntry

        * JournalEntryItem

        * Order

        * OrderAction

        * OrderLineItem

        * Payment

        * PaymentApplication

        * PaymentMethod

        * PaymentPart

        * PaymentSchedule

        * PaymentScheduleItem

        * Product

        * ProductFeature

        * ProductRatePlan

        * ProductRatePlanCharge

        * ProductRatePlanChargeTier

        * RatePlan

        * RatePlanCharge

        * RatePlanChargeTier

        * RatingResult

        * Refund

        * RefundApplication

        * RefundPart

        * RevenueEvent

        * RevenueEventItem

        * RevenueSchedule

        * RevenueScheduleItem

        * Subscription

        * SubscriptionChargeDeliverySchedule

        * SubscriptionChargePriceInterval

        * SubscriptionChargePriceIntervalTier

        * SubscriptionOffer

        * SubscriptionProductFeature

        * TaxationItem

        * UpdaterDetail

        * Usage

        * ValidityPeriodSummary
          
        In addition to the above Zuora standard objects, you can also use custom
        objects as base objects for custom events.


        #### Tenant level base objects and tenant level event triggers


        Zuora identifies the following base objects and custom objects as the
        tenant level base objects:
          
        * AccountingCode

        * AccountingPeriod

        * BillingRun

        * Feature

        * JournalEntry

        * JournalEntryItem

        * Product

        * ProductFeature

        * ProductRatePlan

        * ProductRatePlanCharge

        * ProductRatePlanChargeTier


        Event triggers defined on tenant level base objects are tenant level
        event triggers. Notifications associated with tenant level events are
        system notifications.
          
        **Note:** Tenant level event triggers and system notifications are only
        available in the default profile.


        ### Define the trigger condition


        The `condition` field is a
        [JEXL](http://commons.apache.org/proper/commons-jexl/) expression that
        specifies when to trigger events. The expression can contain fields from
        the object that the trigger is defined on.


        **Note:** The condition cannot contain fields from [data
        source](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL)
        objects that are joined to the object that the trigger is defined on.


        For example, the following condition causes an event to be triggered
        whenever an invoice is posted with an amount greater than 1000:

          ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0```

        Where:


        * `changeType` is a keyword that specifies the type of change that
        occurred to the Invoice object. For all objects, the supported values of
        `changeType` are `INSERT`, `UPDATE`,  and `DELETE`.

        * `Invoice.Status` is the value of the Invoice object's `Status` field
        after the change occurred.

        * `Invoice.Status_old` is the value of the Invoice object's `Status`
        field before the change occurred.


        In the above example, the value of `baseObject` is `Invoice`.


        #### Limitations


        This event trigger has the following limitations:
          
        * Base object values for Zuora standard objects are case sensitive. For
        example, `PaymentMethod` is correct, and `Paymentmethod` or
        `paymentmethod` is incorrect.

        * Base object values for custom objects must be lowercase. For example,
        `default__vehicle`.

        * The INSERT change type is not supported on RatePlan base objects.

        * The INSERT change type is not supported on SubscriptionProductFeature
        base objects.

        * When creating custom events, you cannot match fields of the
        RatePlanCharge object against constant values for the `condition` field.
        For example, the following condition will cause errors:
        `RatePlanCharge.ShippingProcessStatus__c == 'Shipping Confirmed'`, where
        `Shipping Confirmed` is a constant value.

        * Fields on objects are case-sensitive. For example,
        `PaymentMethod.createdbyid` can result in errors. The correct format is
        `PaymentMethod.CreatedById`.

        * A condition cannot contain fields from data source objects that are
        joined to the base object.

        * Do not create duplicate events because they will be either merged or
        deleted. Zuora considers events that have the same trigger condition as
        duplicate events, regardless of event type names.


        See [Custom
        Events](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Z_Custom_Events)
        for more information.
      operationId: POST_EventTrigger
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostEventTriggerRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 5a70564ad08c412fb98e06a80c365c93
                    baseObject: Invoice
                    condition: >-
                      changeType == 'UPDATE' && Invoice.Status == 'Posted' &&
                      Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0
                    eventType:
                      name: LargeInvoicePosted
                      displayName: Large Invoice Posted
                      namespace: user.notification
                    active: true
              schema:
                $ref: '#/components/schemas/EventTrigger'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "MissingRequiredField",
                          "message": "eventType is missing"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "SystemError",
                          "message": "internal server error"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an event trigger
      tags:
        - Custom Event Triggers
    get:
      operationId: GET_EventTriggers
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The Zuora object that trigger condition is defined upon. The format
            of the value in this field depends on the base object type:

            - Standard object: object name, which should follow the pattern
            ^[A-Z][\w\-]*$. For example, `Invoice`.

            - Custom object: `default__<custom_object_api_name>`. For example,
            `default__vehicle`.
          in: query
          name: baseObject
          required: false
          schema:
            type: string
        - description: >-
            The event type name. Should be specified in the pattern:
            ^[A-Za-z]{1,}[\w\-]*$
          in: query
          name: eventTypeName
          required: false
          schema:
            type: string
        - description: The status of the event trigger.
          in: query
          name: active
          required: false
          schema:
            type: string
        - description: >-
            The first index of the query result. Default to 0 if absent, and the
            minimum is 0.
          in: query
          name: start
          required: false
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: >-
            The maximum number of data records to be returned. Default to 10 if
            absent.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - id: ac1ee535e8524858a72edb464212729d
                        baseObject: Invoice
                        condition: >-
                          changeType == 'UPDATE' && Invoice.Status == 'Posted'
                          && Invoice.Status_old != 'Posted' && Invoice.Amount >
                          1000.0
                        description: >-
                          Trigger an event when an invoice is posted with amount
                          over 1000
                        eventType:
                          name: LargeInvoicePosted
                          displayName: Large Invoice Posted
                          description: An invoice is posted with amount over 1000
                        active: true
                    next: >-
                      https://api.zuora.com/events/event-triggers?start=1&limit=1
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/EventTrigger'
                    type: array
                  next:
                    description: The link to the next page. No value if it is last page.
                    type: string
                type: object
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "FieldConstraintViolation",
                          "message": "start should be >= 0"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "SystemError",
                          "message": "internal server error"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List event triggers
      tags:
        - Custom Event Triggers
  /events/event-triggers/{id}:
    get:
      operationId: GET_EventTrigger
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: ac1ee535e8524858a72edb464212729d
                    baseObject: Invoice
                    condition: >-
                      changeType == 'UPDATE' && Invoice.Status == 'Posted' &&
                      Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0
                    description: >-
                      Trigger an event when an invoice is posted with amount
                      over 1000
                    eventType:
                      name: LargeInvoicePosted
                      displayName: Large Invoice Posted
                      description: An invoice is posted with amount over 1000
                    active: true
              schema:
                $ref: '#/components/schemas/EventTrigger'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "ObjectNotFound",
                          "message": "no event trigger found with the given id"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "SystemError",
                          "message": "internal server error"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an event trigger
      tags:
        - Custom Event Triggers
    put:
      description: ''
      operationId: PUT_EventTrigger
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutEventTriggerRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 5a70564ad08c412fb98e06a80c365c93
                    baseObject: Invoice
                    condition: >-
                      changeType == 'UPDATE' && Invoice.Status == 'Posted' &&
                      Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0
                    description: >-
                      Trigger the event when an invoice is posted with amount
                      over 1000
                    eventType:
                      name: LargeInvoicePosted
                      displayName: Large Invoice Posted
                      namespace: user.notification
                    active: true
              schema:
                $ref: '#/components/schemas/EventTrigger'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "ObjectNotFound",
                          "message": "no event trigger found with the given id"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "SystemError",
                          "message": "internal server error"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an event trigger
      tags:
        - Custom Event Triggers
    delete:
      description: ''
      operationId: DELETE_EventTrigger
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '204':
          description: No Content
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "ObjectNotFound",
                          "message": "no event trigger found with the given id"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "reasons": [
                        {
                          "code": "SystemError",
                          "message": "internal server error"
                        }
                      ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an event trigger
      tags:
        - Custom Event Triggers
  /events/scheduled-events:
    post:
      description: >
        To create a custom scheduled event, you must specify the base object,
        the base field and the scheduled time.
      operationId: POST_ScheduledEvent
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostScheduledEventRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScheduledEventResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: FieldConstraintViolation
                        message: name should follow ^[A-Za-z]{1,}[\w\-]*$
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a scheduled event
      tags:
        - Custom Scheduled Events
    get:
      operationId: GET_ScheduledEvents
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >-
            The name of the scheduled event. Should be specified in the pattern:
            ^[A-Za-z]{1,}[\\w\\-]*$
          in: query
          name: eventTypeName
          required: false
          schema:
            type: string
        - description: >-
            The base object that the scheduled event is defined upon. Should be
            specified in the pattern: ^[A-Z][\\w\\-]*$
          in: query
          name: apiObject
          required: false
          schema:
            type: string
        - description: >-
            The base field of the base object in the `apiObject` field. Should
            be specified in the pattern: ^[A-Z][\\w\\-]*$
          in: query
          name: apiField
          required: false
          schema:
            type: string
        - description: Indicate whether the scheduled event is active or inactive.
          in: query
          name: active
          required: false
          schema:
            type: boolean
        - description: >-
            The first index of the query result. Default to 0 if absent, and the
            minimum is 0.
          in: query
          name: start
          required: false
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: >-
            The maximum number of data records to be returned. Default to 10 if
            absent.
          in: query
          name: limit
          required: false
          schema:
            default: 10
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/GetScheduledEventResponse'
                    type: array
                  next:
                    description: The link to the next page. No value if it is last page.
                    example: /events/scheduled-events?start=10&limit=10
                    type: string
                type: object
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all scheduled events
      tags:
        - Custom Scheduled Events
  /events/scheduled-events/{id}:
    get:
      operationId: GET_ScheduledEventByID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The ID of the scheduled event.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScheduledEventResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ResourceNotFound
                        message: >-
                          no resource found with the given identifier event-type
                          by tenant id:10315 and
                          id:59b8b0bfb3b94ce6a8fb96aed64d73c5
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a scheduled event by ID
      tags:
        - Custom Scheduled Events
    put:
      operationId: UPDATE_ScheduledEventByID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The ID of the scheduled event.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutScheduledEventRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScheduledEventResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: FieldConstraintViolation
                        message: name should follow ^[A-Za-z]{1,}[\w\-]*$
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a scheduled event by ID
      tags:
        - Custom Scheduled Events
    delete:
      operationId: DELETE_ScheduledEventByID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The ID of the scheduled event.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ResourceNotFound
                        message: >-
                          no resource found with the given identifier event-type
                          by tenant id:10315 and
                          id:59b8b0bfb3b94ce6a8fb96aed64d73c5
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a scheduled event by ID
      tags:
        - Custom Scheduled Events
  /notifications/notification-definitions:
    post:
      description: >
        Creates a notification definition. If a filter rule is specified, it
        will be evaluated to see if the notification definition is qualified to
        handle the incoming events during runtime. If the notification is
        qualified, it will send the email and invoke the callout if it has an
        email template or a callout.


        This operation supports creating notification definitions for all event
        types:


        - To create a notification definition for a standard event, you must
        specify the `eventCategory` field. For more information about standard
        event category codes, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
        target="_blank">Standard event category code for events and
        notifications</a>.

        - To create a notification definition for a Zuora custom event, custom
        event, or custom scheduled event, you must specify the `eventTypeName`
        field. For more information, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_C_Zuora_Custom_Events"
        target="_blank">Zuora custom events</a>, [Custom event
        triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/),
        and [Custom scheduled
        events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/).
          
        You must specify either `eventCategory` or `eventTypeName`, but not both
        at the same time.
      operationId: POST_Create_Notification_Definition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            examples:
              Create a notification definition:
                value:
                  name: Account Edit Notification
                  eventTypeName: AccountEdit
                  emailActive: true
                  emailTemplateId: f11e498862584a10a05b83ea70119659
                  communicationProfileId: 2c92c0f9446cd49501447539d6a72815
              Create a notification definition with filter rules:
                value:
                  name: Account Edit Notification
                  eventTypeName: AccountEdit
                  emailActive: true
                  emailTemplateId: f11e498862584a10a05b83ea70119659
                  communicationProfileId: 2c92c0f9446cd49501447539d6a72815
                  filterRule:
                    condition: >-
                      Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status
                      == _ACCOUNT_STATUS
                    description: Filter rule to test if an account is a VIP account
                    parameters:
                      _ACCOUNT_STATUS:
                        description: The status of the VIP Account
                        displayName: VIP Account Status
                        options:
                          - Draft
                          - Active
                          - Canceled
                        valueType: STRING
                      _VIP_BALANCE_AMOUNT:
                        description: The minimum account balance
                        displayName: VIP Account Balance
                        options: null
                        valueType: BIG_DECIMAL
                  filterRuleParams:
                    _ACCOUNT_STATUS: Active
                    _VIP_BALANCE_AMOUNT: '100000.0'
            schema:
              $ref: '#/components/schemas/POSTPublicNotificationDefinitionRequest'
        description: The request body used to create the notification definition.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"ConstraintViolated",
                      "message":"The email template is defined on a different EventType other than the notification's"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a notification definition
      tags:
        - Notifications
    get:
      description: |
        Queries notification definitions with the specified filters.
      operationId: GET_Query_Notification_Definitions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - allowEmptyValue: true
          description: The first index of the query result.
          in: query
          name: start
          schema:
            default: 1
            format: int32
            type: integer
        - allowEmptyValue: true
          description: The maximum number of results the query should return.
          in: query
          name: limit
          schema:
            default: 20
            format: int32
            maximum: 100
            minimum: 1
            type: integer
        - allowEmptyValue: true
          description: Id of the profile.
          in: query
          name: profileId
          schema:
            format: uuid
            type: string
        - description: >
            The event category code for a standard event, on which the
            notification definition is created.


            For the list of supported standard event category codes, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
            target="_blank">Standard event category code for events and
            notifications</a>.


            You cannot specify `eventCategory` and `eventTypeName` at the same
            time.
          in: query
          name: eventCategory
          schema:
            type: number
        - allowEmptyValue: true
          description: >
            The name of the Zuora custom event, custom event, or custom
            scheduled event on which the notification definition is created.


            You cannot specify `eventCategory` and `eventTypeName` at the same
            time.
          in: query
          name: eventTypeName
          schema:
            type: string
        - allowEmptyValue: true
          description: The ID of the email template.
          in: query
          name: emailTemplateId
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: >-
                        #/components/schemas/GETPublicNotificationDefinitionResponse
                    type: array
                  next:
                    description: >-
                      The URI to query the next page of data, e.g.
                      '/notification-definitions?start=1&limit=10'. The start
                      equals request's start+limit, and the limit equals the
                      request's limit. If the current page is the last page,
                      this value is null.
                    example: /notification-definitions?start=1&limit=10
                    type: string
                type: object
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List notification definitions
      tags:
        - Notifications
  /notifications/notification-definitions/{id}:
    get:
      description: |
        Queries the notification definition of the given ID.
      operationId: GET_Get_Notification_Definition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the notification definition.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora request ID passed from the request or generated by the
                API Gateway.
              schema:
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a notification definition
      tags:
        - Notifications
    put:
      description: |
        Updates a notification definition.
      operationId: PUT_Update_Notification_Definition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the notification definition to be updated.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPublicNotificationDefinitionRequest'
        description: The request body of the notification definition to be updated.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"ConstraintViolated",
                      "message":"The email template is defined on a different EventType other than the notification's"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a notification definition
      tags:
        - Notifications
    delete:
      description: |
        Deletes a notification definition.
      operationId: DELETE_Delete_Notification_Definition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the notification definition to be deleted.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '204':
          description: No Content
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"ObjectNotFound",
                      "message":"The notification definition with id 6e569e1e05f040eda51a927b140c0ac2 does not exist"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a notification definition
      tags:
        - Notifications
  /notifications/email-templates/import:
    post:
      description: >
        Creates email templates for standard or custom events if you do not
        specify email template IDs, or updates existing email templates if you
        specify valid email template IDs.


        For each email template when you are creating email templates, whether
        the template is created for a standard event, a custom event, or a
        custom scheduled event is dependent on whether you specify the
        `eventCategory` or `eventTypeName` field.


        - If you specify the `eventCategory` field, the email template is
        created based on a standard event. See [Standard Event
        Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API)
        for all standard event category codes.

        - If you specify the `eventTypeName` field, the email template is
        created based on the corresponding custom event or custom scheduled
        event. See [Custom event
        triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/)
        for more information about custom events, and [Custom scheduled
        events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/)
        for more information about custom scheduled events.


        The maximum number of email templates that you can create or update by
        one call is 1,000.
      operationId: POST_CreateOrUpdateEmailTemplates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            examples:
              Create an email template:
                value:
                  allowPartialSuccess: true
                  emailTemplates:
                    - active: true
                      name: Account Edit Email
                      eventTypeName: AccountEdit
                      description: Details of the email template
                      fromName: Company Co. Ltd.
                      fromEmailType: TenantEmail
                      toEmailType: BillToContact
                      replyToEmailType: TenantEmail
                      emailSubject: >-
                        Account {{DataSource.Account.AccountNumber}} has been
                        edited
                      emailBody: >-
                        Dear user,<p>the account
                        {{DataSource.Account.AccountNumber}} has been edited.
                        <p>Company Co. Ltd.
              Update an email template:
                value:
                  allowPartialSuccess: true
                  emailTemplates:
                    - id: f11e498862584a10a05b83ea70119659
                      name: Account Edit Email
                      eventTypeName: AccountEdit
                      description: Details of the email template
                      fromName: Company Co. Ltd.
                      fromEmailType: TenantEmail
                      toEmailType: BillToContact
                      replyToEmailType: TenantEmail
                      emailSubject: >-
                        Account {{DataSource.Account.AccountNumber}} has been
                        edited
                      emailBody: >-
                        Dear user,<p>the account
                        {{DataSource.Account.AccountNumber}} has been edited.
                        <p>Company Co. Ltd.
            schema:
              $ref: '#/components/schemas/POSTCreateOrUpdateEmailTemplateRequest'
        description: The request body to import or update email templates.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrUpdateEmailTemplatesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create or update email templates
      tags:
        - Notifications
  /notifications/email-templates:
    post:
      description: >
        Creates an email template. 


        This operation supports creating the email template for all event types.


        - If you specify the `eventCategory` field, the email template is
        created based on a standard event. See [Standard Event
        Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API)
        for all standard event category codes.

        - If you specify the `eventTypeName` field, the email template is
        created based on the corresponding custom event or custom scheduled
        event. See [Custom event
        triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/)
        for more information about custom events, and [Custom scheduled
        events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/)
        for more information about custom scheduled events.
      operationId: POST_Create_Email_Template
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPublicEmailTemplateRequest'
        description: The request body to create an email template.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPublicEmailTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"ObjectNotFound",
                      "message":"eventType {com.zuora.notification, AccountEdit} does not exist"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an email template
      tags:
        - Notifications
    get:
      description: >
        Queries email templates. This operation supports querying email
        templates for all event types.
      operationId: GET_Query_Email_Templates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - allowEmptyValue: true
          description: The first index of the query result.
          in: query
          name: start
          schema:
            default: 1
            format: int32
            type: integer
        - allowEmptyValue: true
          description: The maximum number of results the query should return.
          in: query
          name: limit
          schema:
            default: 20
            format: int32
            maximum: 100
            minimum: 1
            type: integer
        - allowEmptyValue: true
          description: The event category code for standard events.
          in: query
          name: eventCategory
          schema:
            type: number
        - allowEmptyValue: true
          description: The name of the custom event or custom scheduled event.
          in: query
          name: eventTypeName
          schema:
            type: string
        - allowEmptyValue: true
          description: The name of the email template.
          in: query
          name: name
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - active: true
                        bccEmailAddress: user@example.com
                        ccEmailAddress: user@example.com
                        ccEmailType: SpecificEmails
                        createdBy: 6e569e1e05f040eda51a927b140c0ac3
                        createdOn: '2017-04-18T07:36:19.798Z'
                        description: Email when an account is edited
                        emailBody: >-
                          Dear user,<p>the account <Account.Name> has been
                          edited. </p><p>Example Co. Ltd.</p>
                        emailHeaders:
                          My-Header-1: Header value 1
                          My-Header-2: Header value 2
                        emailSubject: Account <Account.Number> has been edited
                        encodingType: UTF8
                        eventTypeName: AccountEdit
                        fromEmailType: TenantEmail
                        fromName: Example Co. Ltd.
                        id: 6e569e1e05f040eda51a927b140c0ac2
                        isHtml: true
                        name: Account Edit Email
                        replyToEmailType: TenantEmail
                        toEmailAddress: DummyEmailAddress@example.com
                        toEmailType: SpecificEmails
                        updatedBy: 6e569e1e05f040eda51a927b140c0ac4
                        updatedOn: '2017-04-18T07:36:19.798Z'
                      - active: true
                        bccEmailAddress: user@example.com
                        ccEmailAddress: user@example.com
                        ccEmailType: SpecificEmails
                        createdBy: 6e569e1e05f040eda51a927b140c0ac3
                        createdOn: '2017-04-18T07:37:20.798Z'
                        description: Email when an invoice is posted
                        emailBody: >-
                          Dear user,<p>the invoice <Invoice.Number> has been
                          posted. </p><p>Example Co. Ltd.</p>
                        emailHeaders:
                          My-Header-1: Header value 1
                          My-Header-2: Header value 2
                        emailSubject: Invoice <Invoice.Number> has been posted
                        encodingType: UTF8
                        eventCategory: 1110
                        fromEmailAddress: EmailAddress1@example.com
                        fromEmailType: SpecificEmail
                        fromName: Example Co. Ltd.
                        id: 6e569e1e05f040eda51a927b70e31f4e
                        isHtml: true
                        name: Invoice Posted Email
                        replyToEmailType: TenantEmail
                        toEmailType: BillToContact
                        updatedBy: 6e569e1e05f040eda51a927b140c0ac4
                        updatedOn: '2017-04-18T07:37:20.798Z'
                    next: /notification-definitions?start=1&limit=10
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/GETPublicEmailTemplateResponse'
                    type: array
                  next:
                    description: >-
                      The URI to query the next page of data, e.g.
                      '/notification-definitions?start=1&limit=10'. The start
                      equals request's start+limit, and the limit equals the
                      request's limit. If the current page is the last page,
                      this value is null.
                    type: string
                type: object
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List email templates
      tags:
        - Notifications
  /notifications/email-templates/{id}:
    get:
      description: >
        Queries the email template based on the specified ID. This operation
        supports retrieving the email template for all event types.
      operationId: GET_Get_Email_Template
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the email template.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    active: true
                    bccEmailAddress: user@example.com
                    ccEmailAddress: user@example.com
                    ccEmailType: SpecificEmails
                    createdBy: 6e569e1e05f040eda51a927b140c0ac3
                    createdOn: '2017-04-18T07:36:19.798Z'
                    description: Email when an account is edited
                    emailBody: >-
                      Dear user,<p>the account <Account.Name> has been edited.
                      </p><p>Example Co. Ltd.</p>
                    emailHeaders:
                      My-Header-1: Header value 1
                      My-Header-2: Header value 2
                    emailSubject: Account <Account.Number> has been edited
                    encodingType: UTF8
                    eventTypeName: AccountEdit
                    fromEmailType: TenantEmail
                    fromName: Example Co. Ltd.
                    id: 6e569e1e05f040eda51a927b140c0ac2
                    isHtml: true
                    name: Account Edit Email
                    replyToEmailType: TenantEmail
                    toEmailAddress: DummyEmailAddress@example.com
                    toEmailType: SpecificEmails
                    updatedBy: 6e569e1e05f040eda51a927b140c0ac4
                    updatedOn: '2017-04-18T07:36:19.798Z'
              schema:
                $ref: '#/components/schemas/GETPublicEmailTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specified a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
                    examples:
              schema:
                maxLength: 64
                type: string
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"ObjectNotFound",
                      "message":"The email template with id 6e569e1e05f040eda51a927b140c0ac2 does not exist in this tenant"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an email template
      tags:
        - Notifications
    put:
      description: >
        Updates an email template. This operation supports updating the email
        template for all event types.
      operationId: PUT_Update_Email_Template
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the email template to be updated.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPublicEmailTemplateRequest'
        description: The request body to update an email template.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GETPublicEmailTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"ObjectNotFound",
                      "message":"eventType {com.zuora.notification, AccountEdit} does not exist"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an email template
      tags:
        - Notifications
    delete:
      description: >
        Deletes an email template. This operation supports deleting an email
        template for all event types.
      operationId: DELETE_Delete_Email_Template
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the email template to be deleted.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '204':
          description: No Content
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"ObjectNotFound",
                      "message":"The email template with id 6e569e1e05f040eda51a927b140c0ac2 does not exist in this tenant"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"404",
                      "message":"HTTP 404 Not Found"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"405",
                      "message":"HTTP 405 Method Not Allowed"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"415",
                      "message":"HTTP 415 Unsupported Media Type"
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                      "code":"500",
                      "message":"A temporary problem in the service occurred, you can retry later."
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an email template
      tags:
        - Notifications
  /notifications/callout-templates/import:
    post:
      summary: Create or update callout templates
      operationId: CreateOrUpdateCalloutTemplates
      tags:
        - Notifications
      description: >
        Creates callout templates for standard or custom events if you do not
        specify callout template IDs, or updates existing callout templates if
        you specify valid callout template IDs.


        For each callout template when you are creating callout templates,
        whether the template is created for a standard event, a custom event, or
        a custom scheduled event is dependent on whether you specify the
        `eventCategory` or `eventTypeName` field.


        - If you specify the `eventCategory` field, the callout template is
        created based on a standard event. See <a
        href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
        target="_blank">Standard event category code for events and
        notifications</a> for all standard event category codes.

        - If you specify the `eventTypeName` field, the callout template is
        created based on the corresponding custom event, Zuora custom event, or
        custom scheduled event. See [Custom event
        triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/)
        for more information about custom events, and [Custom scheduled
        events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/)
        for more information about custom scheduled events.


        The maximum number of callout templates that you can create or update by
        one call is 1,000.
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequest'
        description: The request body to import or update callout templates.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrUpdateEmailTemplatesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /notifications/callout-templates:
    post:
      summary: Create a callout template
      operationId: CreateCalloutTemplate
      tags:
        - Notifications
      description: >
        Creates a callout template.


        This operation supports creating the callout template for all event
        types:


        - To create a callout template for a standard event, you must specify
        the `eventCategory` field. For more information about standard event
        category codes, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
        target="_blank">Standard event category code for events and
        notifications</a>.

        - To create a callout template for a Zuora custom event, custom event,
        or custom scheduled event, you must specify the `eventTypeName` field.
        For more information, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_C_Zuora_Custom_Events"
        target="_blank">Zuora custom events</a>, [Custom event
        triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/),
        and [Custom scheduled
        events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/).
          
        You must specify either `eventCategory` or `eventTypeName`, but not both
        at the same time.
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTPublicCalloutTemplateRequest'
            examples:
              Callout - Without authentication:
                value:
                  name: Account Edit
                  eventTypeName: AccountEdit
                  calloutBaseurl: https://www.example.com/callout/AccountEdit
                  httpMethod: POST
              Callout - Base authentication:
                value:
                  name: Account Edit
                  eventTypeName: AccountEdit
                  calloutBaseurl: https://www.example.com/callout/AccountEdit
                  httpMethod: POST
                  requiredAuth: true
                  calloutAuth:
                    username: name
                    password: pw123
              Callout - OAuth 2.0 authentication:
                value:
                  name: Account Edit
                  eventTypeName: AccountEdit
                  calloutBaseurl: https://www.example.com/callout/AccountEdit
                  httpMethod: POST
                  requiredOauth2: true
                  oauth2ProviderId: 8ad099a98b94d51e018ba3beb9ed6c29
        description: The request body to create a callout template.
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: dcc5a61ee76e496c984206131b5b83e7
                    createdBy: 8a90e08282f4ed040182f67bab2902ff
                    createdOn: 2024-06-17T04:07:13.000 UTC
                    updatedBy: 8a90e08282f4ed040182f67bab2902ff
                    updatedOn: 2024-06-17T04:07:13.000 UTC
                    eventTypeName: AccountEdit
                    eventTypeNamespace: user.notification
                    name: Account Edit
                    description: Callout when an account is edited
                    active: true
                    calloutBaseurl: https://www.example.com/callout/AccountEdit
                    calloutParams: null
                    calloutHeaders: null
                    httpMethod: POST
                    requiredAuth: false
                    calloutAuth: null
                    requiredOauth2: false
                    oauth2ProviderId: null
                    calloutRetry: true
                    contentType: APPLICATION_JSON
                    useCustomRequestBody: false
                    customRequestBody: null
                    certificate: null
                    hmacKey: null
                    hmacValue: null
                    hmacData: null
                    hmacAlgorithm: null
                    hmacSecret: null
                    hmacOutputFormat: null
                    confirmSuccessFromResponseContent: false
              schema:
                $ref: '#/components/schemas/GETPublicCalloutTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
    get:
      summary: List callout templates
      operationId: GetCalloutTemplates
      tags:
        - Notifications
      description: >
        Queries callout templates. This operation supports querying callout
        templates for all event types.
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - allowEmptyValue: true
          description: The first index of the query result.
          in: query
          name: start
          schema:
            default: 1
            format: int32
            type: integer
        - allowEmptyValue: true
          description: The maximum number of results the query should return.
          in: query
          name: limit
          schema:
            default: 20
            format: int32
            maximum: 100
            minimum: 1
            type: integer
        - allowEmptyValue: true
          description: >-
            The event category code of a standard event to which the callout
            templates you want to query relates.
          in: query
          name: eventCategory
          schema:
            type: number
        - allowEmptyValue: true
          description: >
            The name of a Zuora custom event, custom event, or custom scheduled
            event to which the callout templates you want to query relates.
          in: query
          name: eventTypeName
          schema:
            type: string
        - allowEmptyValue: true
          description: The name of the callout template.
          in: query
          name: name
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - id: dcc5a61ee76e496c984206131b5b83e7
                        createdBy: 8a90e08282f4ed040182f67bab2902ff
                        createdOn: 2024-06-17T04:07:13.000 UTC
                        updatedBy: 8a90e08282f4ed040182f67bab2902ff
                        updatedOn: 2024-06-17T04:07:13.000 UTC
                        eventTypeName: AccountEdit
                        eventTypeNamespace: user.notification
                        name: Account Edit
                        description: Callout when an account is edited
                        active: true
                        calloutBaseurl: https://www.example.com/callout/AccountEdit
                        calloutParams: null
                        calloutHeaders: null
                        httpMethod: POST
                        requiredAuth: false
                        calloutAuth: null
                        requiredOauth2: false
                        oauth2ProviderId: null
                        calloutRetry: true
                        contentType: APPLICATION_JSON
                        useCustomRequestBody: false
                        customRequestBody: null
                        certificate: null
                        hmacKey: null
                        hmacValue: null
                        hmacData: null
                        hmacAlgorithm: null
                        hmacSecret: null
                        hmacOutputFormat: null
                        confirmSuccessFromResponseContent: false
                      - id: a745b9dd39154591b6cc618465aeb133
                        createdBy: 8a90e08282f4ed040182f67bab2902ff
                        createdOn: 2024-06-17T04:09:03.000 UTC
                        updatedBy: 8a90e08282f4ed040182f67bab2902ff
                        updatedOn: 2024-06-17T04:09:03.000 UTC
                        eventTypeName: AccountDelete
                        eventTypeNamespace: user.notification
                        name: Account Delete
                        description: Callout when an account is deleted
                        active: true
                        calloutBaseurl: https://www.example.com/callout/AccountDelete
                        calloutParams: null
                        calloutHeaders: null
                        httpMethod: POST
                        requiredAuth: false
                        calloutAuth: null
                        requiredOauth2: false
                        oauth2ProviderId: null
                        calloutRetry: true
                        contentType: APPLICATION_JSON
                        useCustomRequestBody: false
                        customRequestBody: null
                        certificate: null
                        hmacKey: null
                        hmacValue: null
                        hmacData: null
                        hmacAlgorithm: null
                        hmacSecret: null
                        hmacOutputFormat: null
                        confirmSuccessFromResponseContent: false
                    next: /notifications/callout-templates?start=21&limit=20
              schema:
                type: object
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/GETPublicCalloutTemplateResponse'
                    type: array
                  next:
                    description: >
                      The URI to query the next page of data, e.g.
                      '/notifications/callout-templates?start=21&limit=20'.

                      The start equals request's start+limit, and the limit
                      equals the

                      request's limit. If the current page is the last page,
                      this value

                      is null.
                    type: string
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /notifications/callout-templates/{id}:
    get:
      summary: Retrieve a callout template
      operationId: GetCalloutTemplte
      tags:
        - Notifications
      description: >
        Queries the callout template based on the specified ID. This operation
        supports retrieving the callout template for all event types.
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the callout template.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: dcc5a61ee76e496c984206131b5b83e7
                    createdBy: 8a90e08282f4ed040182f67bab2902ff
                    createdOn: 2024-06-17T04:07:13.000 UTC
                    updatedBy: 8a90e08282f4ed040182f67bab2902ff
                    updatedOn: 2024-06-17T04:07:13.000 UTC
                    eventTypeName: AccountEdit
                    eventTypeNamespace: user.notification
                    name: Account Edit
                    description: Callout when an account is edited
                    active: true
                    calloutBaseurl: https://www.example.com/callout/AccountEdit
                    calloutParams: null
                    calloutHeaders: null
                    httpMethod: POST
                    requiredAuth: false
                    calloutAuth: null
                    requiredOauth2: false
                    oauth2ProviderId: null
                    calloutRetry: true
                    contentType: APPLICATION_JSON
                    useCustomRequestBody: false
                    customRequestBody: null
                    certificate: null
                    hmacKey: null
                    hmacValue: null
                    hmacData: null
                    hmacAlgorithm: null
                    hmacSecret: null
                    hmacOutputFormat: null
                    confirmSuccessFromResponseContent: false
              schema:
                $ref: '#/components/schemas/GETPublicCalloutTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specified a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
                    examples:
              schema:
                maxLength: 64
                type: string
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
    put:
      summary: Update a callout template
      operationId: UpdateCalloutTemplate
      tags:
        - Notifications
      description: >-
        Updates a callout template. This operation supports updating the callout
        template for all event types.
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the callout template to be updated.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTPublicCalloutTemplateRequest'
            examples:
              Callout - Without authentication:
                value:
                  name: Account Edit
                  calloutBaseurl: https://www.example.com/callout/AccountEdit
                  httpMethod: POST
              Callout - Base authentication:
                value:
                  name: Account Edit
                  calloutBaseurl: https://www.example.com/callout/AccountEdit
                  httpMethod: POST
                  requiredAuth: true
                  calloutAuth:
                    username: name
                    password: pw123
              Callout - OAuth 2.0 authentication:
                value:
                  name: Account Edit
                  calloutBaseurl: https://www.example.com/callout/AccountEdit
                  httpMethod: POST
                  requiredOauth2: true
                  oauth2ProviderId: 8ad099a98b94d51e018ba3beb9ed6c29
        description: The request body to update a callout template.
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: dcc5a61ee76e496c984206131b5b83e7
                    createdBy: 8a90e08282f4ed040182f67bab2902ff
                    createdOn: 2024-06-17T04:07:13.000 UTC
                    updatedBy: 8a90e08282f4ed040182f67bab2902ff
                    updatedOn: 2024-06-17T04:07:13.000 UTC
                    eventTypeName: AccountEdit
                    eventTypeNamespace: user.notification
                    name: Account Edit
                    description: Callout when an account is edited
                    active: true
                    calloutBaseurl: https://www.example.com/callout/AccountEdit
                    calloutParams: null
                    calloutHeaders: null
                    httpMethod: POST
                    requiredAuth: false
                    calloutAuth: null
                    requiredOauth2: false
                    oauth2ProviderId: null
                    calloutRetry: true
                    contentType: APPLICATION_JSON
                    useCustomRequestBody: false
                    customRequestBody: null
                    certificate: null
                    hmacKey: null
                    hmacValue: null
                    hmacData: null
                    hmacAlgorithm: null
                    hmacSecret: null
                    hmacOutputFormat: null
                    confirmSuccessFromResponseContent: false
              schema:
                $ref: '#/components/schemas/GETPublicCalloutTemplateResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
    delete:
      summary: Delete a callout template
      operationId: DeleteCalloutTemplate
      tags:
        - Notifications
      description: >-
        Deletes a callout template. This operation supports deleting a callout
        template for all event types.
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: The ID of the callout template to be deleted.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '204':
          description: No Content
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /notifications/reusable-blocks/import:
    post:
      description: >
        Creates reusable blocks if you do not specify block IDs, or updates
        existing reusable blocks if you specify valid block IDs. All fields must
        be provided for each reusable block you want to update.


        The maximum number of reusable blocks that you can create or update by
        one call is 1,000.
      operationId: createOrUpdateReusableBlocks
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            examples:
              Create a reusable block:
                value:
                  allowPartialSuccess: true
                  reusableBlocks:
                    - name: Footer Block
                      category: Footers
                      content: (The content of the block)
              Update a reusable block:
                value:
                  allowPartialSuccess: true
                  reusableBlocks:
                    - id: 385bcf09b2aa4a628098a88f62552180
                      active: true
                      name: Header Block
                      number: RB-00000010
                      category: Headers
                      tags:
                        - logo
                      content: (The content of the block)
            schema:
              $ref: '#/components/schemas/CreateOrUpdateReusableBlockRequest'
        description: The request body to import or update reusable blocks.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrUpdateReusableBlockResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create or update reusable blocks
      tags:
        - Notifications
  /notifications/reusable-blocks:
    post:
      description: >
        Creates a reusable block for email templates, such as email headers or
        footers.
      operationId: createReusableBlock
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePublicReusableBlockRequest'
        description: The request body to create a reusable block.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPublicReusableBlockResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '500'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a reusable block
      tags:
        - Notifications
    get:
      description: |
        Queries reusable blocks.
      operationId: getReusableBlocks
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - allowEmptyValue: true
          description: The first index of the query result.
          in: query
          name: start
          schema:
            default: 1
            format: int32
            type: integer
        - allowEmptyValue: true
          description: The maximum number of results the query should return.
          in: query
          name: limit
          schema:
            default: 20
            format: int32
            maximum: 5000
            minimum: 1
            type: integer
        - allowEmptyValue: true
          description: Whether to return only active reusable blocks.
          in: query
          name: activeOnly
          schema:
            type: boolean
            default: true
        - allowEmptyValue: true
          description: The category that the returned blocks belong to.
          in: query
          name: category
          schema:
            type: string
            enum:
              - Headers
              - Footers
              - Other
        - allowEmptyValue: true
          description: The name of the block the query should return.
          in: query
          name: name
          schema:
            type: string
        - allowEmptyValue: true
          description: >-
            The tags the returned blocks are associated with. If multiple tags
            are specified, only blocks that match all specified tags are
            returned.
          in: query
          name: tag
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    next: /notifications/reusable-blocks?start=21&limit=20
                    data:
                      - id: c6af751e4a0041eebb000c51e95e6c2d
                        createdBy: 8a90e08282f4ed040182f67bab2902ff
                        createdOn: 2025-04-22T08:17:24.000 UTC
                        updatedBy: 8a90e08282f4ed040182f67bab2902ff
                        updatedOn: 2025-04-22T08:17:24.000 UTC
                        active: true
                        name: Header Block
                        number: RB-00000010
                        category: Headers
                        tags: []
                        content: (The content of the block)
                      - id: 385bcf09b2aa4a628098a88f62552180
                        createdBy: 8a90e08282f4ed040182f67bab2902ff
                        createdOn: 2025-04-17T03:36:39.000 UTC
                        updatedBy: 8a90e08282f4ed040182f67bab2902ff
                        updatedOn: 2025-04-22T08:55:07.000 UTC
                        active: true
                        name: Footer Block
                        number: RB-00000009
                        category: Footers
                        tags: []
                        content: (The content of the block)
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/GetPublicReusableBlockResponse'
                    type: array
                  next:
                    description: >
                      The URI to query the next page of data, e.g.
                      '/notifications/reusable-blocks?start=21&limit=20'. The
                      start equals the request's start+limit, and the limit
                      equals the request's limit. If the current page is the
                      last page, this value is null.
                    type: string
                type: object
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '500'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List reusable blocks
      tags:
        - Notifications
  /notifications/reusable-blocks/{blockKey}:
    get:
      description: |
        Queries the reusable block based on the specified ID or name.
      operationId: getReusableBlock
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The ID or name of the reusable block.
          in: path
          name: blockKey
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: c6af751e4a0041eebb000c51e95e6c2d
                    createdBy: 8a90e08282f4ed040182f67bab2902ff
                    createdOn: 2025-04-22T08:17:24.000 UTC
                    updatedBy: 8a90e08282f4ed040182f67bab2902ff
                    updatedOn: 2025-04-22T08:17:24.000 UTC
                    active: true
                    name: Header Block
                    number: RB-00000010
                    category: Headers
                    tags: []
                    content: (The content of the block)
              schema:
                $ref: '#/components/schemas/GetPublicReusableBlockResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. If you specified a
                tracing identifier in the request headers, Zuora returns the
                same tracing identifier. Otherwise, Zuora does not set this
                header.
                    examples:
              schema:
                maxLength: 64
                type: string
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '500'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a reusable block
      tags:
        - Notifications
    put:
      description: |
        Updates a reusable block.
      operationId: updateReusableBlock
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The ID or name of the reusable block.
          in: path
          name: blockKey
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePublicReusableBlockRequest'
        description: The request body to update a reusable block.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePublicReusableBlockResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '500'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a reusable block
      tags:
        - Notifications
    delete:
      description: |
        Deletes a reusable block.
      operationId: deleteReusableBlock
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The ID or name of the reusable block.
          in: path
          name: blockKey
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: ObjectNotFound
                        message: >-
                          eventType {com.zuora.notification, AccountEdit} does
                          not exist
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '404'
                        message: HTTP 404 Not Found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '405':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '405'
                        message: HTTP 405 Method Not Allowed
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Method Not Allowed
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '415'
                        message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unsupported Media Type
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: '500'
                        message: >-
                          A temporary problem in the service occurred, you can
                          retry later.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a reusable block
      tags:
        - Notifications
  /notifications/history:
    delete:
      description: >
        Delete all notification histories for the given account. All email and
        callout notifications for this account will be deleted upon successful
        operation.
      operationId: DELETE_Delete_Notification_History_For_Account
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            The ID of the account whose notification histories are to be
            deleted.
          in: query
          name: accountId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '202':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                        "id": "2be2f02afc504d1b83fb3cd095ce4dc6",
                        "status": "RUNNING",
                        "tenantId": "9",
                        "createdBy": "402881e522cf4f9b0122cf5d82860002",
                        "createdOn": 1610358627000,
                        "accountId": "2c9e8084769a87be0176f0cfa138001e"
                    }
              schema:
                $ref: '#/components/schemas/NotificationsHistoryDeletionTaskResponse'
          description: Accepted
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                description: >-
                  The error message notifying that `accountId` must not be
                  empty.
                example: >-
                  may not be null (path =
                  PublicNotificationHistoryResource.deleteHistoryByAccountId.query
                  param accountId, invalidValue = null)
                type: string
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                        "reasons": [
                            {
                                "code": "404",
                                "message": "HTTP 404 Not Found"
                            }
                        ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete notification histories for an account
      tags:
        - Notifications
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X DELETE -H "Authorization: Bearer
            6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type:
            application/json"
            "https://rest.zuora.com//notifications/history?accountId=402892c74c9193cd014c96bbe7c101f9"
  /notifications/history/tasks/{id}:
    get:
      description: |
        Get the notification history deletion task by ID.
      operationId: GET_Get_Notification_History_Deletion_Task
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The ID of the notification history deletion task. You can get the
            deletion task ID from the 202 response body of the [Delete
            notification histories for an
            account](https://developer.zuora.com/api-references/api/operation/DELETE_Delete_Notification_History_For_Account)
            operation.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                        "id": "2be2f02afc504d1b83fb3cd095ce4dc6",
                        "status": "FINISHED",
                        "tenantId": "9",
                        "createdBy": "402881e522cf4f9b0122cf5d82860002",
                        "createdOn": 1610358627000,
                        "accountId": "2c9e8084769a87be0176f0cfa138001e"
                    }
              schema:
                $ref: '#/components/schemas/NotificationsHistoryDeletionTaskResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value: |-
                    {
                        "reasons": [
                            {
                                "code": "ObjectNotFound",
                                "message": "history task with id 2be2f02afc504d1b83fb3cd095ce4dc7 not found"
                            }
                        ]
                    }
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a notification history deletion task
      tags:
        - Notifications
  /notifications/callout-histories/resend:
    post:
      description: >
        Resends callout notifications if your customers did not receive previous
        callout notifications.


        Details about the status codes and response contents of this operation
        are as follows:


        | Scenario                               | Status code     | Response
        content                                            |

        |----------------------------------------|-----------------|-------------------------------------------------------------|

        | Success for all notifications          | 202 Accepted    |
        (blank)                                                     |

        | Success for at least one notification  | 202 Accepted    | Error code
        and error message of each failed notification    |

        | Failure for all notifications          | 400 Bad Request | Error code
        and error message of each failed notification    |
      operationId: POST_ResendCalloutNotifications
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTResendCalloutNotifications'
        description: The request body to resend callout notifications.
        required: true
      responses:
        '202':
          content:
            application/json:
              examples:
                response:
                  value:
                    a00000000000000000000000000000000:
                      code: ObjectNotFound
                      message: Callout history does not exist.
              schema:
                $ref: '#/components/schemas/ResendCalloutNotificationsFailedResponse'
          description: Accepted
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    a00000000000000000000000000000000:
                      code: ObjectNotFound
                      message: Callout history does not exist.
                    a00000000000000000000000000000001:
                      code: ObjectNotFound
                      message: Callout history does not exist.
              schema:
                $ref: '#/components/schemas/ResendCalloutNotificationsFailedResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Resend callout notifications
      tags:
        - Notifications
  /notifications/email-histories/resend:
    post:
      description: >
        Resends email notifications if your customers did not receive previous
        email notifications.


        Details about the status codes and response contents of this operation
        are as follows:


        | Scenario                               | Status code     | Response
        content                                            |

        |----------------------------------------|-----------------|-------------------------------------------------------------|

        | Success for all notifications          | 202 Accepted    |
        (blank)                                                     |

        | Success for at least one notification  | 202 Accepted    | Error code
        and error message of each failed notification    |

        | Failure for all notifications          | 400 Bad Request | Error code
        and error message of each failed notification    |
      operationId: POST_ResendEmailNotifications
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTResendEmailNotifications'
        description: The request body to resend email notifications.
        required: true
      responses:
        '202':
          content:
            application/json:
              examples:
                response:
                  value:
                    a00000000000000000000000000000000:
                      code: ObjectNotFound
                      message: Email history does not exist.
              schema:
                $ref: '#/components/schemas/ResendEmailNotificationsFailedResponse'
          description: Accepted
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    a00000000000000000000000000000000:
                      code: ObjectNotFound
                      message: Email history does not exist.
                    a00000000000000000000000000000001:
                      code: ObjectNotFound
                      message: Email history does not exist.
              schema:
                $ref: '#/components/schemas/ResendEmailNotificationsFailedResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Resend email notifications
      tags:
        - Notifications
  /v1/notification-history/callout:
    get:
      description: |
        Describes how to get a notification history for callouts.
      operationId: GET_CalloutHistory
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >-
            The final date and time of records to be returned. Defaults to now.
            Use format yyyy-MM-ddTHH:mm:ss.
          in: query
          name: endTime
          required: false
          schema:
            format: date-time
            type: string
        - description: >-
            The initial date and time of records to be returned. Defaults to
            (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss.
          in: query
          name: startTime
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            The ID of an object that triggered a callout notification. 
          in: query
          name: objectId
          required: false
          schema:
            type: string
        - description: >
            If `true`, only return failed records. If `false`, return all
            records in the given date range. The default value is `true`.
          in: query
          name: failedOnly
          required: false
          schema:
            type: boolean
        - description: >
            Category of records to be returned by event category.


            The following formats are supported:

            * `{Event Type Namespace}:{Event Type Name}` if the Custom Events
            feature is enabled in your tenant. For example:
            `user.notification:NewSubscriptionCreated`.

            * Numeric code of the event category if the Custom Events feature is
            not enabled in your tenant. For example, `1210`. See [Event Category
            Code](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories)
            for more information.
          in: query
          name: eventCategory
          required: false
          schema:
            type: string
        - description: ''
          in: query
          name: includeResponseContent
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    calloutHistories:
                      - attemptedNum: 3
                        createTime: '2015-01-13T03:33:51'
                        eventCategory: 1210
                        eventContext:
                          <Account.Currency>: USD
                          <Account.CurrencySymbol>: $
                          <Account.ID>: 402881e54ade80c8014ade884c48000b
                          <Account.Name>: test
                          <Account.Number>: A00000001
                          <BillToContact.FirstName>: Mary
                          <BillToContact.ID>: 402881e54ade80c8014ade884c51000c
                          <BillToContact.LastName>: Smith
                          <BillToContact.WorkEmail>: smith@example.com
                          <BillingAccount.ID>: 402881e54ade80c8014ade884c48000b
                          <Contact.ID>: 402881e54ade80c8014ade884c51000c
                          <Event.Category>: SubscriptionCreated
                          <Event.ID>: 402892fa47866fe701478674a4ff0093
                          <Event.Timestamp>: 2015-01-13T22:31:43.248+0800
                          <Notification>:
                            EmailTemplate: New Subscription Created Default Email Template
                            Event: New Subscription Created
                            Profile: Default Profile
                            calloutAction: true
                            emailAction: true
                            id: 402892fa47866fe701478674a5c100eb
                            updatedBy: 402892fa47866fe7014786749d9b0002
                            updatedOn: 01/12/2015 03:23:08
                          <Object.ID>: 402881e54ae37f31014ae3b514e100fd
                          <Subscription.AutoRenew>: 'No'
                          <Subscription.CMRR>: $250.00
                          <Subscription.ContractEffective>: 01/01/2016
                          <Subscription.CreateDate>: 01/13/2015
                          <Subscription.CreatedBy>: smith@example.com
                          <Subscription.CustomerAcceptance>: 01/01/2016
                          <Subscription.ID>: 402881e54ae37f31014ae3b514e100fd
                          <Subscription.InitialTerm>: '50'
                          <Subscription.RenewalTerm>: '0'
                          <Subscription.ServiceActivation>: 01/01/2016
                          <Subscription.SubscriptionDetailTable>:
                            Charge Name: recurringcharge
                            Charge Type: Recurring
                            Effective Start Date: 01 / 01 / 2016
                            QTY: 5
                            Total: 250
                            Unit Price: 50
                          <Subscription.SubscriptionName>: A-S00000003
                          <Subscription.TCV>: $12,500.00
                          <Subscription.TermEndDate>: 03/01/2020
                          <Subscription.TermSetting>: termed
                          <Subscription.TermStartDate>: 01/01/2016
                        notification: New Subscription Created
                        requestMethod: POST
                        requestUrl: https://www.google.com
                        responseCode: 405
                    nextPage: >-
                      https://localhost:8080/apps/v1/notification-history/callout?page=2&pageSize=1&startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000
                    success: true
              schema:
                $ref: '#/components/schemas/GETCalloutHistoryVOsType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: List callout notification histories
      tags:
        - Notifications
  /v1/notification-history/email:
    get:
      description: >
        Describes how to get a notification history for notification emails.



        ### Notes

        Request parameters and their values may be appended with a "?" following
        the HTTPS GET request.  Additional request parameter are separated by
        "&". 


        For example:


        `GET
        https://rest.zuora.com/v1/notification-history/email?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1`
      operationId: GET_EmailHistory
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >-
            ID of an account. By specifying this query parameter, you can filter
            email notification histories by account.
          in: query
          name: accountId
          schema:
            type: string
        - description: >-
            The end date and time of records to be returned. Defaults to now.
            Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime -
            startTime) is three days.
          in: query
          name: endTime
          required: false
          schema:
            format: date-time
            type: string
        - description: >-
            The initial date and time of records to be returned. Defaults to
            (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date
            range (endTime - startTime) is three days.
          in: query
          name: startTime
          required: false
          schema:
            format: date-time
            type: string
        - description: |
            The Id of an object that triggered an email notification.
          in: query
          name: objectId
          required: false
          schema:
            type: string
        - description: >
            If `true`, only returns failed records. When `false`, returns all
            records in the given date range. Defaults to `true` when not
            specified.
          in: query
          name: failedOnly
          required: false
          schema:
            type: boolean
        - description: >
            Category of records to be returned by event category.


            The following formats are supported:

            * `{Event Type Namespace}:{Event Type Name}` if the Custom Events
            feature is enabled in your tenant. For example:
            `user.notification:NewSubscriptionCreated`.

            * Numeric code of the event category if the Custom Events feature is
            not enabled in your tenant. For example, `1210`. See [Event Category
            Code](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories)
            for more information.
          in: query
          name: eventCategory
          required: false
          schema:
            type: number
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    emailHistories:
                      - accountId: 2c9e8084769a87be0176f0cfa138001e
                        bcc: ceo@example.com,cto@example.com
                        cc: bob@example.com,chris@example.com
                        errorMessage: null
                        eventCategory: 1210
                        fromEmail: no-reply@example.com
                        notification: New Subscription Created
                        replyTo: supportexample.com
                        result: OK
                        sendTime: '2015-01-13T03:31:43'
                        subject: New subscription A-S00000003 was created and activated
                        toEmail: smith@example.com
                    nextPage: >-
                      https://localhost:8080/apps/v1/notification-history/email?page=2&pageSize=1&startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000
                    success: true
              schema:
                $ref: '#/components/schemas/GETEmailHistoryVOsType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: List email notification histories
      tags:
        - Notifications
  /scim/v2/Groups:
    get:
      description: >-
        Returns a paginated list of groups, ten groups per page by default. Use
        the startIndex and count (max 100) query parameters to paginate long
        lists of groups. It's possible to return a list of specific types of
        groups using the filter parameter.
      operationId: getListGroups
      parameters:
        - description: The `Content-Type` of the request must be `application/json`.
          name: Content-Type
          in: header
          required: true
          schema:
            type: string
        - description: The number of records returned per page in the response.
          name: count
          in: query
          required: false
          schema:
            type: integer
            format: int32
        - description: The filter used to filter the group, either by organization id.
          name: filter
          in: query
          required: false
          schema:
            type: string
        - description: >-
            The index number of the page that you want to retrieve. You must set
            count before specifying startIndex. For example, if you set count to
            20 and startIndex to 2, the 21st to 40th records are returned in the
            response.
          name: startIndex
          in: query
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                  Note that only the following MIME types support gzipped
                  responses:
                    - `application/json`
                    - `application/xml`
                    - `text/html`
                    - `text/csv`
                    - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                type: integer
                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:
              schema:
                type: integer
                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:
              schema:
                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:
              schema:
                type: string
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: ''
                    items:
                      type: string
                      example: urn:ietf:params:scim:api:messages:2.0:ListResponse
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    type: object
                    nullable: true
                  totalResults:
                    type: integer
                    description: |
                      Total numbers of groups present.
                    example: 28
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                          example:
                            - urn:ietf:params:scim:schemas:core:2.0:Group
                            - urn:zuora:scim:schemas:1.0:GroupExtension
                        id:
                          type: string
                          example: 01b496f7-1988-44aa-9ea6-c27f0288fa9d
                        displayName:
                          type: string
                          example: Test_GroupName
                        members:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                example: e1b624ac-e00f-422b-b4da-20070901b22f
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                              example:
                                - urn:zuora:scim:schemas:1.0:GroupExtension
                            description:
                              type: string
                              example: Test_GroupDescription
                            organizationId:
                              type: string
                              example: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                            active:
                              type: boolean
                              example: true
                        meta:
                          type: object
                          nullable: true
                          properties:
                            resourceType:
                              type: string
                              example: Group
                            location:
                              type: string
                              example: >-
                                http://localhost:9900/scim/v2/Groups/01b496f7-1988-44aa-9ea6-c27f0288fa9d
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 28
                resources:
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Group
                      - urn:zuora:scim:schemas:1.0:GroupExtension
                    id: 01b496f7-1988-44aa-9ea6-c27f0288fa9d
                    displayName: Test_GroupName
                    members:
                      - value: e1b624ac-e00f-422b-b4da-20070901b22f
                    urn:zuora:scim:schemas:1.0:GroupExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:GroupExtension
                      description: Test_GroupDescription
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      active: true
                    meta:
                      resourceType: Group
                      location: >-
                        http://localhost:9900/scim/v2/Groups/01b496f7-1988-44aa-9ea6-c27f0288fa9d
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    description: |
                      Indicates whether the call succeeded.
                    type: boolean
                    example: false
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Unauthorized
                        code:
                          type: string
                          example: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: |
                      The timestamp when the response was generated.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: string
                    description: |
                      Indicates whether the call succeeded.
                    example: 403
                  error:
                    type: string
                    description: |
                      A brief description of the error that occurred.
                    example: Forbidden
                  message:
                    type: string
                    description: >
                      A detailed message providing additional context about the
                      error or issue. This can be used for debugging or
                      informational purposes.
                    example: Admin access denied
                  path:
                    type: string
                    description: >
                      The API endpoint path that was accessed when the error
                      occurred. This helps to identify which part of the API was
                      involved.
                    example: /scim/v2/Groups
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      List of schema identifiers that define the format of the
                      group resource.
                    example:
                      - urn:ietf:params:scim:api:messages:2.0:Error
                  status:
                    type: string
                    description: The HTTP status code indicating the error type.
                    example: '404'
                  detail:
                    type: string
                    description: >-
                      A brief explanation of the error, providing context about
                      the resource issue.
                    example: Resource not found
      summary: List groups
      tags:
        - SCIM
    post:
      description: >-
        Creates a new group. Must include the displayName attribute. Users can
        be added to the group during creation by supplying the user ID values in
        the members array attribute.
      operationId: createANewGroup
      parameters:
        - description: The `Content-Type` of the request must be `application/json`.
          name: Content-Type
          in: header
          required: true
          schema:
            type: string
        - description: The number of records returned per page in the response.
          name: count
          in: query
          required: false
          schema:
            type: integer
            format: int32
        - description: The filter used to filter the group, either by organization id.
          name: filter
          in: query
          required: false
          schema:
            type: string
        - description: >-
            The index number of the page that you want to retrieve. You must set
            count before specifying startIndex. For example, if you set count to
            20 and startIndex to 2, the 21st to 40th records are returned in the
            response.
          name: startIndex
          in: query
          required: false
          schema:
            type: integer
            format: int32
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                  description: >-
                    List of schema URNs defining the structure of the group
                    resource.
                displayName:
                  type: string
                  description: Name of the group.
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  type: object
                  properties:
                    schemas:
                      type: array
                      items:
                        type: string
                      description: List of URNs for the extension schemas.
                    description:
                      type: string
                      description: Description of the group.
                    organizationId:
                      type: string
                      description: Identifier for the associated organization.
            example:
              schemas:
                - urn:ietf:params:scim:schemas:core:2.0:Group
                - urn:zuora:scim:schemas:1.0:GroupExtension
              displayName: Amy Laurance test scim
              urn:zuora:scim:schemas:1.0:GroupExtension:
                schemas:
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                description: ''
                organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
      responses:
        '201':
          description: Created
          headers:
            Content-Encoding:
              schema:
                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.
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    description: Unique identifier for the group.
                  displayName:
                    type: string
                    description: Name of the group.
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    description: Custom extension schema with additional group attributes.
                    properties:
                      schemas:
                        type: array
                        description: >-
                          List of schema identifiers that define the format of
                          the group resource.
                        items:
                          type: string
                      description:
                        type: string
                        description: Description of the group.
                      organizationId:
                        type: string
                        description: Identifier for the associated organization.
                      active:
                        type: boolean
                        description: Indicates if the group is active.
                  meta:
                    type: object
                    description: Metadata about the resource.
                    properties:
                      resourceType:
                        type: string
                        description: Type of the resource.
                      location:
                        type: string
                        description: URL of the group resource.
              example:
                schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                id: 6cd663a3-39b6-49bf-9ec0-113381e40669
                displayName: Amy Lawrence
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:GroupExtension
                  description: ''
                  organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
                  active: true
                meta:
                  resourceType: Group
                  location: >-
                    http://localhost:9900/scim/v2/Groups/6cd663a3-39b6-49bf-9ec0-113381e40669
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates if the request was successful (false for
                      errors).
                    example: false
                  reasons:
                    type: array
                    description: List of reasons for the unauthorized error.
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: Error message.
                          example: Unauthorized
                        code:
                          type: string
                          description: Error code.
                          example: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: Time when the error occurred.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 403
                  error:
                    type: string
                    description: Error type.
                    example: Forbidden
                  message:
                    type: string
                    description: Details about the access denial.
                    example: Admin access denied
                  path:
                    type: string
                    description: Endpoint path where the error occurred.
                    example: /scim/v2/Groups
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers that define the format of the
                      group resource.
                    items:
                      type: string
                  status:
                    type: string
                    description: HTTP status code.
                    example: '404'
                  detail:
                    type: string
                    description: Reason for the resource not being found.
                    example: Resource not found
      summary: Create a group
      tags:
        - SCIM
  /scim/v2/Groups/bulk:
    post:
      tags:
        - SCIM
      summary: Bulk create groups
      description: >
        Creates multiple Groups within an organization.


        Must include the displayName attribute. Users can be added to the group
        during creation by supplying the user ID values in the members array
        attribute.
      operationId: postBulkCreateGroups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              description: Array of group resources returned by the bulk operation.
              items:
                type: object
                required:
                  - schemas
                  - displayName
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                  - meta
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema URNs defining the structure of the group
                      resource.
                    items:
                      type: string
                  displayName:
                    type: string
                    description: Name of the group.
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    description: >-
                      Custom extension schema with additional attributes for the
                      group.
                    properties:
                      schemas:
                        type: array
                        description: List of URNs for the extension schemas.
                        items:
                          type: string
                      description:
                        type: string
                        description: Description of the group.
                      organizationId:
                        type: string
                        description: Identifier for the associated organization.
                      active:
                        type: boolean
                        description: Indicates whether the group is active.
                  meta:
                    type: object
                    nullable: true
                    description: Metadata about the group resource.
                    properties:
                      resourceType:
                        type: string
                        description: Type of the resource (e.g., Group).
            example:
              - schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                displayName: test_group_11
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:GroupExtension
                  description: ''
                  organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
                  active: false
                meta:
                  resourceType: Group
              - schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                displayName: test_group_22
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:GroupExtension
                  description: ''
                  organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
                  active: false
                meta:
                  resourceType: Group
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                  Note that only the following MIME types support gzipped
                  responses:
                    - `application/json`
                    - `application/xml`
                    - `text/html`
                    - `text/csv`
                    - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                type: integer
                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:
              schema:
                type: integer
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema URNs defining the structure of the
                      response.
                    items:
                      type: string
                    example:
                      - urn:ietf:params:scim:api:messages:2.0:ListResponse
                  totalResults:
                    type: integer
                    description: Total number of user groups returned in the response.
                    example: 2
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    type: string
                    nullable: true
                  resources:
                    type: array
                    description: List of group resources returned by the query.
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          description: >-
                            List of schema identifiers that define the format of
                            the group resource.
                          items:
                            type: string
                          example:
                            - urn:ietf:params:scim:schemas:core:2.0:Group
                            - urn:zuora:scim:schemas:1.0:GroupExtension
                        id:
                          type: string
                          description: Unique identifier for the group.
                          example: 5aa8a1fe-4ed4-44db-a6ae-78645a20ae21
                        displayName:
                          type: string
                          description: Name of the group.
                          example: test_group_1
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          description: >-
                            Custom extension schema with additional attributes
                            for the group.
                          properties:
                            schemas:
                              type: array
                              description: List of URNs for the extension schemas.
                              items:
                                type: string
                              example:
                                - urn:zuora:scim:schemas:1.0:GroupExtension
                            description:
                              type: string
                              description: Description of the group.
                              example: ''
                            organizationId:
                              type: string
                              description: Identifier for the associated organization.
                              example: ec141dc2-901e-4813-a25d-ef480cff1e26
                            active:
                              type: boolean
                              description: Indicates whether the group is active.
                              example: true
                        meta:
                          type: object
                          nullable: true
                          description: Metadata about the group resource.
                          properties:
                            resourceType:
                              type: string
                              description: Type of the resource (e.g., Group).
                              example: Group
                            location:
                              type: string
                              description: URL to access the group resource.
                              example: >-
                                http://localhost:9900/scim/v2/Groups/bulk/5aa8a1fe-4ed4-44db-a6ae-78645a20ae21
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 2
                resources:
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Group
                      - urn:zuora:scim:schemas:1.0:GroupExtension
                    id: 62c20400-6470-4992-8a01-c181efc2ce54
                    displayName: test_group_11
                    urn:zuora:scim:schemas:1.0:GroupExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:GroupExtension
                      description: ''
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      active: true
                    meta:
                      resourceType: Group
                      location: >-
                        http://localhost:9900/scim/v2/Groups/bulk/62c20400-6470-4992-8a01-c181efc2ce54
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Group
                      - urn:zuora:scim:schemas:1.0:GroupExtension
                    id: 71d3c0ec-48db-4522-b5c9-053e051204d7
                    displayName: test_group_22
                    urn:zuora:scim:schemas:1.0:GroupExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:GroupExtension
                      description: ''
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      active: true
                    meta:
                      resourceType: Group
                      location: >-
                        http://localhost:9900/scim/v2/Groups/bulk/71d3c0ec-48db-4522-b5c9-053e051204d7
                startIndex: 1
                itemsPerPage: 2
        '201':
          description: Created
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful (false for
                      errors).
                    example: false
                  reasons:
                    type: array
                    description: List of reasons for the unauthorized error.
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            Error message indicating the reason for unauthorized
                            access.
                          example: Unauthorized
                        code:
                          type: string
                          description: Error code associated with the unauthorized error.
                          example: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: Time when the error occurred.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: HTTP status code indicating the forbidden error.
                    example: 403
                  error:
                    type: string
                    description: Type of error indicating a forbidden action.
                    example: Forbidden
                  message:
                    type: string
                    description: Description of why the action is forbidden.
                    example: Admin access denied
                  path:
                    type: string
                    description: Endpoint path where the error occurred.
                    example: /scim/v2/Groups/bulk
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema URNs defining the structure of the error
                      response.
                    items:
                      type: string
                    example:
                      - urn:ietf:params:scim:api:messages:2.0:Error
                  status:
                    type: string
                    description: >-
                      HTTP status code indicating that the resource was not
                      found.
                    example: '404'
                  detail:
                    type: string
                    description: Details explaining why the resource was not found.
                    example: Resource not found
    patch:
      tags:
        - SCIM
      summary: Bulk update groups
      description: >
        Updates an existing group resource, allowing individual (or groups of)
        users to be added or removed from the group with a single operation.


        Setting the operation attribute of a member object to delete will remove
        members from a group; add is the default operation for PATCH.
      operationId: patchBulkPatchGroups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - schemas
                - operations
              properties:
                schemas:
                  type: array
                  description: >-
                    List of schema identifiers that define the format of the
                    request.
                  items:
                    type: string
                operations:
                  type: array
                  description: List of operations to be performed on the resource.
                  items:
                    type: object
                    required:
                      - op
                      - path
                      - value
                    properties:
                      op:
                        type: string
                        description: >-
                          Operation to be performed. Can be 'add' to add a new
                          item or 'remove' to delete an item.
                        enum:
                          - add
                          - remove
                      path:
                        type: string
                        description: Path to the item or property to be modified.
                      value:
                        type: array
                        description: List of values associated with the operation.
                        items:
                          type: object
                          properties:
                            value:
                              type: string
                              description: The value to be added or removed.
            example:
              schemas:
                - urn:ietf:params:scim:api:messages:2.0:PatchOp
              operations:
                - op: add
                  path: members
                  value:
                    - value: e1b624ac-e00f-422b-b4da-20070901b22f
                    - value: ea27634b-38ab-4592-86e4-2d4a140ae120
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                  Note that only the following MIME types support gzipped
                  responses:
                    - `application/json`
                    - `application/xml`
                    - `text/html`
                    - `text/csv`
                    - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                type: integer
                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:
              schema:
                type: integer
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers that define the structure of
                      the response.
                    items:
                      type: string
                    example:
                      - urn:ietf:params:scim:api:messages:2.0:ListResponse
                  id:
                    type: string
                    nullable: true
                    description: ''
                  externalId:
                    type: string
                    nullable: true
                    description: ''
                  meta:
                    type: object
                    nullable: true
                    description: Metadata about the group.
                    properties:
                      resourceType:
                        type: string
                        description: Type of resource, which is 'Group' for this object.
                        example: Group
                      location:
                        type: string
                  totalResults:
                    type: integer
                    description: Total number of groups returned in the response.
                    example: 2
                  resources:
                    type: array
                    description: List of groups included in the response.
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          description: >-
                            List of schema identifiers that describe the format
                            of the group.
                          items:
                            type: string
                          example:
                            - urn:ietf:params:scim:schemas:core:2.0:Group
                            - urn:zuora:scim:schemas:1.0:GroupExtension
                        id:
                          type: string
                          description: Unique identifier for the group.
                          example: 5aa8a1fe-4ed4-44db-a6ae-78645a20ae21
                        displayName:
                          type: string
                          description: Name of the group.
                          example: test_group_1
                        members:
                          type: array
                          description: List of members associated with the group.
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: Identifier for a member of the group.
                              display:
                                type: string
                                description: ''
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          description: >-
                            Custom attributes for the group defined by the
                            extension schema.
                          properties:
                            schemas:
                              type: array
                              description: >-
                                List of schema identifiers specific to the
                                extension.
                              items:
                                type: string
                              example:
                                - urn:zuora:scim:schemas:1.0:GroupExtension
                            description:
                              type: string
                              description: Additional description for the group.
                              example: ''
                            organizationId:
                              type: string
                              description: >-
                                Identifier for the organization associated with
                                the group.
                              example: ec141dc2-901e-4813-a25d-ef480cff1e26
                            active:
                              type: boolean
                              description: Indicates if the group is active.
                              example: true
                        meta:
                          type: object
                          description: Metadata about the group.
                          properties:
                            resourceType:
                              type: string
                              description: >-
                                Type of resource, which is 'Group' for this
                                object.
                              example: Group
                            location:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 1
                resources:
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Group
                      - urn:zuora:scim:schemas:1.0:GroupExtension
                    id: 0fb99576-2154-4d96-a6cb-384dd430f45f
                    displayName: Amy Test
                    members:
                      - value: e1b624ac-e00f-422b-b4da-20070901b22f
                        display: amy+test102
                      - value: ea27634b-38ab-4592-86e4-2d4a140ae120
                        display: test01@zuora.com
                    urn:zuora:scim:schemas:1.0:GroupExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:GroupExtension
                      description: Amy testing group
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      active: true
                    meta:
                      resourceType: Group
                      location: >-
                        http://localhost:9900/scim/v2/Groups/bulk/0fb99576-2154-4d96-a6cb-384dd430f45f
                startIndex: 1
                itemsPerPage: 1
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful (false in
                      this case).
                    example: false
                  reasons:
                    type: array
                    description: List of reasons for the unauthorized error.
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            Error message explaining why the request is
                            unauthorized.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            Error code representing the unauthorized access
                            issue.
                          example: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: Timestamp when the error occurred.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: HTTP status code indicating the request is forbidden.
                    example: 403
                  error:
                    type: string
                    description: Type of error indicating that access is forbidden.
                    example: Forbidden
                  message:
                    type: string
                    description: Description of why the request is forbidden.
                    example: Admin access denied
                  path:
                    type: string
                    description: Endpoint path where the forbidden error occurred.
                    example: /scim/v2/Groups/bulk
  /scim/v2/Groups/delete:
    post:
      tags:
        - SCIM
      summary: Bulk delete groups
      description: >
        Permanently removes groups from an organization (members are not
        deleted, only the group).
      operationId: postBulkDeleteGroups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                operations:
                  type: array
                  items:
                    type: object
                    properties:
                      op:
                        type: string
                        enum:
                          - add
                          - remove
                          - replace
                      path:
                        type: string
                      value:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
              required:
                - schemas
                - operations
            example:
              schemas:
                - urn:ietf:params:scim:api:messages:2.0:PatchOp
              operations:
                - op: add
                  path: members
                  value:
                    - value: 71d3c0ec-48db-4522-b5c9-053e051204d7
                    - value: 62c20400-6470-4992-8a01-c181efc2ce54
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            description: >-
              Specify a unique idempotency key to ensure that a POST or PATCH
              request is idempotent. Do not use this header for other request
              types.
        - name: Accept-Encoding
          in: header
          required: false
          schema:
            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.

              If 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.
        - name: Content-Encoding
          in: header
          required: false
          schema:
            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.


              Note that only the following MIME types support gzipped responses:
                - `application/json`
                - `application/xml`
                - `text/html`
                - `text/csv`
                - `text/plain`
        - name: Authorization
          in: header
          required: false
          schema:
            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](https://developer.zuora.com/api-references/api/operation/createToken).
        - name: Zuora-Track-Id
          in: header
          required: false
          schema:
            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 (`'`).
        - name: Zuora-Entity-Ids-Single
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                  Note that only the following MIME types support gzipped
                  responses:
                    - `application/json`
                    - `application/xml`
                    - `text/html`
                    - `text/csv`
                    - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                type: integer
                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:
              schema:
                type: integer
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers that define the structure of
                      the response.
                    items:
                      type: string
                    example:
                      - urn:ietf:params:scim:api:messages:2.0:ListResponse
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                    description: >-
                      An external identifier for the resource, often used for
                      integration with external systems.
                  meta:
                    type: object
                    nullable: true
                    description: Metadata about the group resource.
                    properties:
                      resourceType:
                        type: string
                        description: Type of resource, which is 'Group' for this object.
                        example: Group
                      location:
                        type: string
                  totalResults:
                    type: integer
                    description: Total number of groups returned in the response.
                    example: 2
                  resources:
                    type: array
                    description: List of group resources included in the response.
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          description: >-
                            List of schema identifiers that define the format of
                            the group resource.
                          items:
                            type: string
                          example:
                            - urn:ietf:params:scim:schemas:core:2.0:Group
                            - urn:zuora:scim:schemas:1.0:GroupExtension
                        id:
                          type: string
                          description: Unique identifier for the group.
                          example: 5aa8a1fe-4ed4-44db-a6ae-78645a20ae21
                        externalId:
                          type: string
                          nullable: true
                          description: >-
                            An external identifier for the resource, often used
                            for integration with external systems.
                        displayName:
                          type: string
                          description: Name of the group.
                          example: test_group_1
                        urn:zuora:scim:schemas:1.0:GroupExtension:
                          type: object
                          description: >-
                            Custom attributes for the group defined by the
                            extension schema.
                          properties:
                            description:
                              type: string
                              description: Additional description for the group.
                              example: ''
                            organizationId:
                              type: string
                              description: >-
                                Identifier for the organization associated with
                                the group.
                              example: ec141dc2-901e-4813-a25d-ef480cff1e26
                            active:
                              type: boolean
                              description: Indicates whether the group is active.
                              example: true
                        meta:
                          type: object
                          description: Metadata about the group resource.
                          properties:
                            resourceType:
                              type: string
                              description: >-
                                Type of resource, which is 'Group' for this
                                object.
                              example: Group
                            location:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 2
                resources:
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Group
                      - urn:zuora:scim:schemas:1.0:GroupExtension
                    id: 71d3c0ec-48db-4522-b5c9-053e051204d7
                    displayName: test_group_22
                    urn:zuora:scim:schemas:1.0:GroupExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:GroupExtension
                      description: ''
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      active: false
                    meta:
                      resourceType: Group
                      location: >-
                        http://localhost:9900/scim/v2/Groups/delete/71d3c0ec-48db-4522-b5c9-053e051204d7
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Group
                      - urn:zuora:scim:schemas:1.0:GroupExtension
                    id: 62c20400-6470-4992-8a01-c181efc2ce54
                    displayName: test_group_11
                    urn:zuora:scim:schemas:1.0:GroupExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:GroupExtension
                      description: ''
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      active: false
                    meta:
                      resourceType: Group
                      location: >-
                        http://localhost:9900/scim/v2/Groups/delete/62c20400-6470-4992-8a01-c181efc2ce54
                startIndex: 1
                itemsPerPage: 2
        '201':
          description: Created
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful (false in
                      this case).
                    example: false
                  reasons:
                    type: array
                    description: List of reasons for the unauthorized error.
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: Message explaining why the request is unauthorized.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            Error code representing the unauthorized access
                            issue.
                          example: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    description: The time at which the error occurred.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: HTTP status code indicating that the request is forbidden.
                    example: 403
                  error:
                    type: string
                    description: Type of error indicating that access is forbidden.
                    example: Forbidden
                  message:
                    type: string
                    description: Description of why the request is forbidden.
                    example: Admin access denied
                  path:
                    type: string
                    description: Endpoint path where the forbidden error occurred.
                    example: /scim/v2/Groups/delete
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers that define the structure of
                      the error response.
                    items:
                      type: string
                    example:
                      - urn:ietf:params:scim:api:messages:2.0:Error
                  status:
                    type: string
                    description: >-
                      HTTP status code indicating that the resource was not
                      found.
                    example: '404'
                  detail:
                    type: string
                    description: >-
                      Description of the error detailing why the resource was
                      not found.
                    example: Resource not found
  /scim/v2/Groups/{id}:
    get:
      tags:
        - SCIM
      summary: Retrieve a group
      description: Retrieves a single group resource.
      operationId: getASpecificGroup
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the group to retrieve.
          schema:
            type: string
          example: 78faa61b-4e3b-4799-9579-210fd4d80aca
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                Note that only the following MIME types support gzipped
                responses:

                - `application/json`

                - `application/xml`

                - `text/html`

                - `text/csv`

                - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                type: string
              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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    description: Unique identifier for the group.
                  displayName:
                    type: string
                    description: Name of the group.
                  members:
                    type: array
                    description: List of members associated with the group.
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Identifier for a member of the group.
                        display:
                          type: string
                          description: ''
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    description: >-
                      Custom attributes specific to the group defined by the
                      extension schema.
                    properties:
                      schemas:
                        type: array
                        description: >-
                          List of schema identifiers that define the format of
                          the custom attributes.
                        items:
                          type: string
                      description:
                        type: string
                        description: Additional description for the group.
                      organizationId:
                        type: string
                        description: >-
                          Identifier for the organization associated with the
                          group.
                      active:
                        type: boolean
                        description: Indicates whether the group is active.
                  meta:
                    type: object
                    description: Metadata about the group resource.
                    properties:
                      resourceType:
                        type: string
                        description: Type of resource, which is 'Group' for this object.
                        enum:
                          - Group
                      location:
                        type: string
                        description: URL where the group resource can be accessed.
              example:
                schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                id: 0fb99576-2154-4d96-a6cb-384dd430f45f
                displayName: Amy Lawrence
                members:
                  - value: ea27634b-38ab-4592-86e4-2d4a140ae120
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:GroupExtension
                  description: Amy testing group
                  organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                  active: true
                meta:
                  resourceType: Group
                  location: >-
                    http://localhost:9900/scim/v2/Groups/0fb99576-2154-4d96-a6cb-384dd430f45f/0fb99576-2154-4d96-a6cb-384dd430f45f
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Groups/00000000-0000-0000-000000000000
        '404':
          description: Not Found
          content:
            application/json:
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
    put:
      tags:
        - SCIM
      summary: Update a group
      description: >
        Updates an existing group resource, overwriting all values for a group
        even if an attribute is empty or not provided.

        PUT will replace all members of a group with those members provided via
        the members attribute. If an attribute that had been set previously is
        left blank during a PUT operation, the new value will be blank in
        accordance with the data type of the attribute and the storage provider.
      operationId: updateASpecificGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - name: id
          in: path
          required: true
          description: The ID of the group to update.
          schema:
            type: string
          example: 78faa61b-4e3b-4799-9579-210fd4d80aca
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                  description: List of schema URNs defining the structure of the request.
                operations:
                  type: array
                  items:
                    type: object
                    required:
                      - op
                      - path
                      - value
                    properties:
                      op:
                        type: string
                        description: The operation to perform (e.g., add, remove, replace).
                      path:
                        type: string
                        description: The path to the attribute that is being modified.
                      value:
                        type: array
                        items:
                          type: object
                          required:
                            - value
                          properties:
                            value:
                              type: string
                              description: The value to be added.
            example:
              schemas:
                - urn:ietf:params:scim:api:messages:2.0:PatchOp
              operations:
                - op: add
                  path: members
                  value:
                    - value: 6d1c8c54-64a4-4073-b505-d3508bd84e48
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                Note that only the following MIME types support gzipped
                responses:

                - `application/json`

                - `application/xml`

                - `text/html`

                - `text/csv`

                - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                type: string
              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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers that define the structure of
                      the group resource.
                    items:
                      type: string
                  id:
                    type: string
                    description: Unique identifier assigned to the group.
                  displayName:
                    type: string
                    description: Name of the group.
                  members:
                    type: array
                    description: List of members associated with the group.
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Unique identifier of a member within the group.
                        display:
                          type: string
                          description: ''
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    description: >-
                      Custom attributes specific to the group defined by the
                      extension schema.
                    properties:
                      schemas:
                        type: array
                        description: >-
                          List of schema identifiers that define the format of
                          the custom attributes.
                        items:
                          type: string
                      description:
                        type: string
                        description: Additional description or notes about the group.
                      organizationId:
                        type: string
                        description: >-
                          Identifier for the organization to which the group
                          belongs.
                      active:
                        type: boolean
                        description: Indicates whether the group is currently active.
                  meta:
                    type: object
                    description: Metadata related to the group resource.
                    properties:
                      resourceType:
                        type: string
                        description: >-
                          Type of the resource, which is 'Group' for this
                          object.
                        enum:
                          - Group
                      location:
                        type: string
                        description: URL where the group resource can be accessed.
              example:
                schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                id: 6cd663a3-39b6-49bf-9ec0-113381e40669
                displayName: Amy test scim
                members:
                  - value: 6d1c8c54-64a4-4073-b505-d3508bd84e48
                    display: assingh102@zuora.com
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:GroupExtension
                  description: ''
                  organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
                  active: true
                meta:
                  resourceType: Group
                  location: >-
                    http://localhost:9900/scim/v2/Groups/6cd663a3-39b6-49bf-9ec0-113381e40669/6cd663a3-39b6-49bf-9ec0-113381e40669
        '201':
          description: Created
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Groups/00000000-0000-0000-000000000000
        '404':
          description: Not Found
          content:
            application/json:
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
    delete:
      tags:
        - SCIM
      summary: Delete a group
      description: |
        Permanently removes a group (members are not deleted, only the group).
      operationId: deleteASpecificGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - name: id
          in: path
          required: true
          description: The ID of the group to delete.
          schema:
            type: string
          example: 78faa61b-4e3b-4799-9579-210fd4d80aca
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                type: string
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
            Zuora-Track-Id:
              schema:
                type: string
              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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                  displayName:
                    type: string
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      description:
                        type: string
                      organizationId:
                        type: string
                      active:
                        type: boolean
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                      location:
                        type: string
              example:
                schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                id: 6cd663a3-39b6-49bf-9ec0-113381e40669
                displayName: Amy test scim
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:GroupExtension
                  description: ''
                  organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
                  active: false
                meta:
                  resourceType: Group
                  location: >-
                    http://localhost:9900/scim/v2/Groups/6cd663a3-39b6-49bf-9ec0-113381e40669/6cd663a3-39b6-49bf-9ec0-113381e40669
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Groups/00000000-0000-0000-000000000000
        '404':
          description: Not Found
          content:
            application/json:
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
    patch:
      tags:
        - SCIM
      summary: Partially update a group
      description: >
        Updates an existing group resource, allowing individual (or groups of)
        users to be added or removed from the group with a single operation.

        Setting the operation attribute of a member object to delete will remove
        members from a group; add is the default operation for PATCH.
      operationId: partiallyUpdateAspecificGroup
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - name: id
          in: path
          required: true
          description: The ID of the group to partially update.
          schema:
            type: string
          example: 78faa61b-4e3b-4799-9579-210fd4d80aca
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                Operations:
                  type: array
                  items:
                    type: object
                    properties:
                      op:
                        type: string
                        enum:
                          - add
                          - remove
                          - replace
                      path:
                        type: string
                      value:
                        type: array
                        items:
                          type: object
                          properties:
                            value:
                              type: string
              required:
                - schemas
                - Operations
            example:
              schemas:
                - urn:ietf:params:scim:api:messages:2.0:PatchOp
              Operations:
                - op: add
                  path: members
                  value:
                    - value: ea27634b-38ab-4592-86e4-2d4a140ae120
                    - value: e1b624ac-e00f-422b-b4da-20070901b22f
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                Note that only the following MIME types support gzipped
                responses:

                - `application/json`

                - `application/xml`

                - `text/html`

                - `text/csv`

                - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                type: string
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
            Zuora-Track-Id:
              schema:
                type: string
              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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers that define the structure of
                      the group resource.
                    items:
                      type: string
                  id:
                    type: string
                    description: Unique identifier assigned to the group.
                  displayName:
                    type: string
                    description: Name of the group.
                  members:
                    type: array
                    description: List of members associated with the group.
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Unique identifier of a member within the group.
                        display:
                          type: string
                          description: ''
                  urn:zuora:scim:schemas:1.0:GroupExtension:
                    type: object
                    description: >-
                      Custom attributes specific to the group defined by the
                      extension schema.
                    properties:
                      schemas:
                        type: array
                        description: >-
                          List of schema identifiers that define the format of
                          the custom attributes.
                        items:
                          type: string
                      description:
                        type: string
                        description: Additional description or notes about the group.
                      organizationId:
                        type: string
                        description: >-
                          Identifier for the organization to which the group
                          belongs.
                      active:
                        type: boolean
                        description: Indicates whether the group is currently active.
                  meta:
                    type: object
                    description: Metadata related to the group resource.
                    properties:
                      resourceType:
                        type: string
                        description: >-
                          Type of the resource, which is 'Group' for this
                          object.
                      location:
                        type: string
                        description: URL where the group resource can be accessed.
              example:
                schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:zuora:scim:schemas:1.0:GroupExtension
                id: 0fb99576-2154-4d96-a6cb-384dd430f45f
                displayName: Amy Test
                members:
                  - value: e1b624ac-e00f-422b-b4da-20070901b22f
                    display: amy+Lawrence
                  - value: ea27634b-38ab-4592-86e4-2d4a140ae120
                    display: test01@zuora.com
                urn:zuora:scim:schemas:1.0:GroupExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:GroupExtension
                  description: Amy testing group
                  organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                  active: true
                meta:
                  resourceType: Group
                  location: >-
                    http://localhost:9900/scim/v2/Groups/0fb99576-2154-4d96-a6cb-384dd430f45f/0fb99576-2154-4d96-a6cb-384dd430f45f
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Groups/00000000-0000-0000-000000000000
  /scim/v2/ResourceTypes:
    get:
      tags:
        - SCIM
      summary: List all resource types
      description: >
        Retrieves all Resource Types managed by OneId. Resource Types define the
        resource name, endpoint URL, schemas, and other metadata that indicate
        where a resource is managed and how it is composed, e.g., "User" or
        "Group".
      operationId: getTheRessourceType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                type: string
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
            Zuora-Track-Id:
              schema:
                type: string
              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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers that define the structure of
                      the response.
                    items:
                      type: string
                  totalResults:
                    type: integer
                    description: Total number of resource types available.
                  resources:
                    type: array
                    description: List of resource types available.
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          description: >-
                            List of schema identifiers that define the structure
                            of the resource type.
                          items:
                            type: string
                        id:
                          type: string
                          description: Unique identifier of the resource type.
                        name:
                          type: string
                          description: Name of the resource type.
                        description:
                          type: string
                          description: Detailed description of the resource type.
                        endpoint:
                          type: string
                          description: API endpoint for accessing the resource type.
                        schema:
                          type: string
                          description: >-
                            Schema identifier defining the structure of the
                            resource type.
                        schemaExtensions:
                          type: array
                          description: >-
                            List of schema extensions applied to the resource
                            type.
                          items:
                            type: object
                            properties:
                              schema:
                                type: string
                                description: Schema identifier for the extension.
                              required:
                                type: boolean
                                description: Indicates if the schema extension is required.
                        meta:
                          type: object
                          description: Metadata about the resource type.
                          properties:
                            resourceType:
                              type: string
                              description: >-
                                Type of the resource, which is 'ResourceType'
                                for this object.
                            location:
                              type: string
                              description: URL where the resource type can be accessed.
                  startIndex:
                    type: integer
                    description: Index of the first item in the current page of results.
                  itemsPerPage:
                    type: integer
                    description: Number of items returned per page.
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                totalResults: 2
                resources:
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:ResourceType
                    id: User
                    name: User
                    description: SCIM 2.0 User
                    endpoint: /v2/Users
                    schema: urn:ietf:params:scim:schemas:core:2.0:User
                    schemaExtensions:
                      - schema: urn:zuora:scim:schemas:1.0:UserExtension
                        required: true
                    meta:
                      resourceType: ResourceType
                      location: http://localhost:9900/scim/v2/ResourceTypes/User
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:ResourceType
                    id: Group
                    name: Group
                    description: SCIM 2.0 Group
                    endpoint: /v2/Groups
                    schema: urn:ietf:params:scim:schemas:core:2.0:Group
                    schemaExtensions:
                      - schema: urn:zuora:scim:schemas:1.0:GroupExtension
                        required: true
                    meta:
                      resourceType: ResourceType
                      location: http://localhost:9900/scim/v2/ResourceTypes/Group
                startIndex: 1
                itemsPerPage: 2
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/ResourceTypes
        '404':
          description: Not Found
          content:
            application/json:
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
  /scim/v2/ResourceTypes/{id}:
    get:
      tags:
        - SCIM
      summary: Retrieve a resource type
      description: |
        Get related information on a single resource type.

        Examples:
          ```
          /scim/v2/ResourceTypes/User
          /scim/v2/ResourceTypes/Group
          ```
      operationId: getASpecificResourceType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of URNs that specify the schemas applied to this
                      resource. These URNs define the structure and constraints
                      for the resource's data.
                  id:
                    type: string
                    description: >-
                      A unique identifier for the resource type. This ID is used
                      to reference the resource type in API requests.
                  name:
                    type: string
                    description: >-
                      The name of the resource type. This is a human-readable
                      identifier for the resource.
                  description:
                    type: string
                    description: >-
                      A brief description of the resource type. This provides
                      context or additional information about the resource's
                      purpose and usage.
                  endpoint:
                    type: string
                    description: >-
                      The URI path where the resource type can be accessed. This
                      endpoint is used to interact with the resource type
                      through the API.
                  schema:
                    type: string
                    description: >-
                      The URN of the schema that defines the structure and
                      attributes of the resource type. This schema provides the
                      format and constraints for the resource's data.
                  schemaExtensions:
                    type: array
                    items:
                      type: object
                      properties:
                        schema:
                          type: string
                          description: >-
                            The URN of the schema extension that adds additional
                            attributes to the resource type. This extends the
                            base schema with extra fields or constraints.
                        required:
                          type: boolean
                          description: >-
                            Indicates whether the schema extension is required
                            for the resource type. If true, the extension must
                            be included in resource data.
                    description: >-
                      A list of schema extensions that provide additional
                      attributes for the resource type. Each extension adds new
                      fields or constraints to the resource.
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                        description: >-
                          The type of resource represented by this schema. This
                          helps identify the nature of the resource (e.g.,
                          'ResourceType').
                      location:
                        type: string
                        description: >-
                          The URI where the resource type's details can be
                          accessed. This is useful for retrieving information
                          about the resource type.
              example:
                schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:ResourceType
                id: User
                name: User
                description: SCIM 2.0 User
                endpoint: /v2/Users
                schema: urn:ietf:params:scim:schemas:core:2.0:User
                schemaExtensions:
                  - schema: urn:zuora:scim:schemas:1.0:UserExtension
                    required: true
                meta:
                  resourceType: ResourceType
                  location: http://localhost:9900/scim/v2/ResourceTypes/User
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/ResourceTypes/
        '404':
          description: Not Found
          content:
            application/json:
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
  /scim/v2/Schemas:
    get:
      tags:
        - SCIM
      summary: List all schemas of resources
      description: >
        Lists all schemas for all supported resources. A schema is a collection
        of attribute definitions that describe the contents of an entire or
        partial resource, e.g., "urn:ietf:params:scim:schemas:core:2.0:User".  


        The attribute definitions specify the name of the attribute, and
        metadata such as type (e.g., string, binary), cardinality (singular,
        multi, complex), mutability, and returnability.
      operationId: getSchemaOfSCIM
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
          description: Unique key used to ensure idempotent behavior.
        - name: Accept-Encoding
          in: header
          required: false
          schema:
            type: string
          description: >
            Indicates the response's preferred content encoding. Supported
            values are `gzip` and `identity`.
        - name: Content-Encoding
          in: header
          required: false
          schema:
            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.
        - name: Authorization
          in: header
          required: false
          schema:
            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](https://developer.zuora.com/api-references/api/operation/createToken).
        - name: Zuora-Track-Id
          in: header
          required: false
          schema:
            type: string
          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 (`'`).
        - name: Zuora-Entity-Ids-Single
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema identifiers defining the structure of the
                      response.
                    items:
                      type: string
                  patch:
                    type: object
                    description: Information about support for patch operations.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates if patch operations are supported.
                  bulk:
                    type: object
                    description: Information about support for bulk operations.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates if bulk operations are supported.
                      maxOperations:
                        type: integer
                        description: >-
                          Maximum number of operations allowed in a single bulk
                          request.
                      maxPayloadSize:
                        type: integer
                        description: >-
                          Maximum size (in bytes) of the payload allowed for a
                          bulk request.
                  filter:
                    type: object
                    description: Information about support for filtering.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates if filtering is supported.
                      maxResults:
                        type: integer
                        description: >-
                          Maximum number of results that can be returned by a
                          single filter query.
                  changePassword:
                    type: object
                    description: Information about support for password change operations.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates if password change operations are supported.
                  sort:
                    type: object
                    description: Information about support for sorting.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates if sorting is supported.
                  etag:
                    type: object
                    description: Information about support for ETag operations.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates if ETag operations are supported.
                  authenticationSchemes:
                    type: array
                    description: List of supported authentication schemes.
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Name of the authentication scheme.
                        description:
                          type: string
                          description: Description of the authentication scheme.
                        specUri:
                          type: string
                          description: >-
                            URI for the specification of the authentication
                            scheme.
                        type:
                          type: string
                          description: >-
                            Type of the authentication scheme (e.g., OAuth,
                            Basic).
                        primary:
                          type: boolean
                          description: >-
                            Indicates if this is the primary authentication
                            scheme.
                  id:
                    type: string
                    nullable: true
                  externalId:
                    type: string
                    nullable: true
                  meta:
                    nullable: true
                    type: object
                    description: Metadata about the resource type.
                    properties:
                      resourceType:
                        type: string
                        description: Type of the resource (e.g., ResourceType).
                      location:
                        type: string
                        description: URL where the resource type can be accessed.
                  totalResults:
                    type: integer
                    description: Total number of user groups returned in the response.
                    example: 2
                  resources:
                    type: array
                    description: List of resource types available.
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          description: >-
                            List of schema identifiers that define the structure
                            of the resource type.
                          items:
                            type: string
                        id:
                          type: string
                          description: Unique identifier of the resource type.
                        name:
                          type: string
                          description: Name of the resource type.
                        description:
                          type: string
                          description: Detailed description of the resource type.
                        attributes:
                          type: array
                          description: List of attributes defined by the schema.
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: Name of the attribute.
                              type:
                                type: string
                                description: >-
                                  Data type of the attribute (e.g., string,
                                  boolean).
                              multiValued:
                                type: boolean
                                description: >-
                                  Indicates if the attribute can hold multiple
                                  values.
                              description:
                                type: string
                                description: Description of the attribute.
                              required:
                                type: boolean
                                description: Indicates if the attribute is required.
                              caseExact:
                                type: boolean
                                description: >-
                                  Indicates if the attribute value is
                                  case-sensitive.
                              mutability:
                                type: string
                                description: >-
                                  Specifies the mutability of the attribute
                                  (e.g., readOnly, readWrite).
                              returned:
                                type: string
                                description: >-
                                  Specifies when the attribute is returned in
                                  responses (e.g., always, never).
                              uniqueness:
                                type: string
                                description: >-
                                  Specifies the uniqueness of the attribute
                                  values (e.g., none, server).
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 4
                resources:
                  - schemas:
                      - urn:ietf:params:scim:schemas:core:2.0:Schema
                    id: urn:ietf:params:scim:schemas:core:2.0:User
                    name: User
                    description: User Account
                    attributes:
                      - name: active
                        type: boolean
                        multiValued: false
                        description: >-
                          A Boolean value indicating the User's administrative
                          status.
                        required: false
                        caseExact: true
                        mutability: readWrite
                        returned: default
                        uniqueness: none
                      - name: addresses
                        type: complex
                        subAttributes:
                          - name: country
                            type: string
                            multiValued: false
                            description: The country name component.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: formatted
                            type: string
                            multiValued: false
                            description: >-
                              The full mailing address, formatted for display or
                              use with a mailing label. This attribute MAY
                              contain newlines.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: locality
                            type: string
                            multiValued: false
                            description: The city or locality component.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: postalCode
                            type: string
                            multiValued: false
                            description: The zipcode or postal code component.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: primary
                            type: boolean
                            multiValued: false
                            description: >-
                              A Boolean value indicating the 'primary' or
                              preferred attribute value for this attribute,
                              e.g., the preferred address. The primary attribute
                              value 'true' MUST appear no more than once.
                            required: false
                            caseExact: true
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: region
                            type: string
                            multiValued: false
                            description: The state or region component.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: streetAddress
                            type: string
                            multiValued: false
                            description: >-
                              The full street address component, which may
                              include house number, street name, PO BOX, and
                              multi-line extended street address information.
                              This attribute MAY contain newlines.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: type
                            type: string
                            multiValued: false
                            description: >-
                              A label indicating the attribute's function; e.g.,
                              'work' or 'home'.
                            required: false
                            canonicalValues:
                              - other
                              - work
                              - home
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                        multiValued: true
                        description: Physical mailing addresses for this User.
                        required: false
                        caseExact: true
                        mutability: readWrite
                        returned: default
                        uniqueness: none
                      - name: displayName
                        type: string
                        multiValued: false
                        description: >-
                          The name of the User, suitable for display to
                          end-users. The name SHOULD be the full name of the
                          User being described if known.
                        required: false
                        caseExact: false
                        mutability: readWrite
                        returned: default
                        uniqueness: none
                      - name: emails
                        type: complex
                        subAttributes:
                          - name: display
                            type: string
                            multiValued: false
                            description: >-
                              A human readable name, primarily used for display
                              purposes.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: primary
                            type: boolean
                            multiValued: false
                            description: >-
                              A Boolean value indicating the 'primary' or
                              preferred attribute value for this attribute,
                              e.g., the preferred mailing address or primary
                              e-mail address. The primary attribute value 'true'
                              MUST appear no more than once.
                            required: false
                            caseExact: true
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: type
                            type: string
                            multiValued: false
                            description: >-
                              A label indicating the attribute's function; e.g.,
                              'work' or 'home'.
                            required: false
                            canonicalValues:
                              - other
                              - work
                              - home
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                          - name: value
                            type: string
                            multiValued: false
                            description: >-
                              E-mail addresses for the user. The value SHOULD be
                              canonicalized by the Service Provider, e.g.,
                              bjensen@example.com instead of
                              bjensen@EXAMPLE.COM. Canonical Type values of
                              work, home, and other.
                            required: false
                            caseExact: false
                            mutability: readWrite
                            returned: default
                            uniqueness: none
                        multiValued: true
                        description: >-
                          E-mail addresses for the user. The value SHOULD be
                          canonicalized by the Service Provider, e.g.,
                          bjensen@example.com instead of bjensen@EXAMPLE.COM.
                          Canonical Type values of work, home, and other.
                        required: false
                        caseExact: true
                        mutability: readWrite
                        returned: default
                        uniqueness: none
          headers:
            Content-Encoding:
              schema:
                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.

                  Note that only the following MIME types support gzipped
                  responses:

                  - `application/json`

                  - `application/xml`

                  - `text/html`

                  - `text/csv`

                  - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Schemas
        '404':
          description: Not Found
          content:
            application/json:
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
  /scim/v2/Schemas/{id}:
    get:
      tags:
        - SCIM
      summary: List schemas of a resource
      description: |
        Gets a specific resource schema by ID.

        Examples:
          ```
          /scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group
          /scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User

          /scim/v2/Schemas/urn:zuora:scim:schemas:1.0:UserExtension
          /scim/v2/Schemas/urn:zuora:scim:schemas:1.0:GroupExtension
          ```
      operationId: getTheSchemaOfSpecificSCIM
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema URNs defining the structure of the
                      response.
                    items:
                      type: string
                  id:
                    type: string
                    description: Unique identifier of the schema.
                  name:
                    type: string
                    description: Name of the schema.
                  description:
                    type: string
                    description: Description of the schema.
                  attributes:
                    type: array
                    description: List of attributes defined by the schema.
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: Name of the attribute.
                        type:
                          type: string
                          description: Data type of the attribute (e.g., string, boolean).
                        multiValued:
                          type: boolean
                          description: Indicates if the attribute can hold multiple values.
                        description:
                          type: string
                          description: Description of the attribute.
                        required:
                          type: boolean
                          description: Indicates if the attribute is required.
                        caseExact:
                          type: boolean
                          description: Indicates if the attribute value is case-sensitive.
                        mutability:
                          type: string
                          description: >-
                            Specifies the mutability of the attribute (e.g.,
                            readOnly, readWrite).
                        returned:
                          type: string
                          description: >-
                            Specifies when the attribute is returned in
                            responses (e.g., always, never).
                        uniqueness:
                          type: string
                          description: >-
                            Specifies the uniqueness of the attribute values
                            (e.g., none, server).
                  meta:
                    type: object
                    description: Metadata about the schema.
                    properties:
                      resourceType:
                        type: string
                        description: Type of the resource (e.g., Schema).
                      location:
                        type: string
                        description: URL where the schema can be accessed.
                example:
                  schemas:
                    - urn:ietf:params:scim:schemas:core:2.0:Schema
                  id: urn:ietf:params:scim:schemas:core:2.0:User
                  name: User
                  description: User resource schema
                  attributes:
                    - name: userName
                      type: string
                      multiValued: false
                      description: User's username
                      required: true
                      caseExact: false
                      mutability: readWrite
                      returned: always
                      uniqueness: server
                    - name: displayName
                      type: string
                      multiValued: false
                      description: User's display name
                      required: false
                      caseExact: false
                      mutability: readWrite
                      returned: default
                      uniqueness: none
                  meta:
                    resourceType: Schema
                    location: >-
                      http://localhost:9900/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful (false for
                      unauthorized errors).
                    example: false
                  reasons:
                    type: array
                    description: >-
                      List of reasons explaining why the request was
                      unauthorized.
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A message providing details about the unauthorized
                            error.
                          example: Unauthorized
                        code:
                          type: string
                          description: A code representing the specific unauthorized error.
                          example: '90000011'
                example:
                  success: false
                  reasons:
                    - message: Unauthorized
                      code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: The timestamp when the error occurred.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: HTTP status code indicating that the request is forbidden.
                    example: 403
                  error:
                    type: string
                    description: Error type describing the forbidden access.
                    example: Forbidden
                  message:
                    type: string
                    description: A message detailing why the access was forbidden.
                    example: Admin access denied
                  path:
                    type: string
                    description: The request path that caused the forbidden error.
                    example: >-
                      /scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User
                example:
                  timestamp: '2023-07-28T10:47:07.931+00:00'
                  status: 403
                  error: Forbidden
                  message: Admin access denied
                  path: /scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema URNs describing the structure of the error
                      response.
                    items:
                      type: string
                  status:
                    type: string
                    description: >-
                      HTTP status code indicating that the resource was not
                      found.
                    example: '404'
                  detail:
                    type: string
                    description: >-
                      Detailed message explaining that the resource was not
                      found.
                    example: Resource not found
                example:
                  schemas:
                    - urn:ietf:params:scim:api:messages:2.0:Error
                  status: '404'
                  detail: Resource not found
  /scim/v2/ServiceProviderConfig:
    get:
      tags:
        - SCIM
      summary: Retrieve the service provider configuration
      operationId: getTheServiceProviderConfig
      description: Returns Zuora’s service provider configuration.
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema URNs that define the structure of the
                      response.
                    items:
                      type: string
                  patch:
                    type: object
                    description: Details about support for the PATCH method.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates whether the PATCH method is supported.
                  bulk:
                    type: object
                    description: Details about support for bulk operations.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates whether bulk operations are supported.
                      maxOperations:
                        type: integer
                        description: >-
                          The maximum number of operations that can be performed
                          in a single bulk request.
                      maxPayloadSize:
                        type: integer
                        description: >-
                          The maximum size of the payload for a single bulk
                          request, in bytes.
                  filter:
                    type: object
                    description: Details about support for filtering resources.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates whether filtering is supported.
                      maxResults:
                        type: integer
                        description: >-
                          The maximum number of results that can be returned in
                          a single request when using filters.
                  changePassword:
                    type: object
                    description: Details about support for password change operations.
                    properties:
                      supported:
                        type: boolean
                        description: >-
                          Indicates whether password change operations are
                          supported.
                  sort:
                    type: object
                    description: Details about support for sorting resources.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates whether sorting is supported.
                  etag:
                    type: object
                    description: Details about support for ETag headers.
                    properties:
                      supported:
                        type: boolean
                        description: Indicates whether ETag headers are supported.
                  authenticationSchemes:
                    type: array
                    description: >-
                      List of authentication schemes supported by the service
                      provider.
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          description: The name of the authentication scheme.
                        description:
                          type: string
                          description: >-
                            A description of how the authentication scheme
                            works.
                        specUri:
                          type: string
                          description: >-
                            A URI to the specification of the authentication
                            scheme.
                        type:
                          type: string
                          description: >-
                            The type of the authentication scheme (e.g.,
                            OAuth2).
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this is the primary authentication
                            scheme.
                  meta:
                    type: object
                    description: Metadata about the service provider configuration.
                    properties:
                      resourceType:
                        type: string
                        description: >-
                          Type of the resource returned (e.g.,
                          ServiceProviderConfig).
                      location:
                        type: string
                        description: URI of the resource.
                example:
                  schemas:
                    - >-
                      urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig
                  patch:
                    supported: true
                  bulk:
                    supported: true
                    maxOperations: 1000
                    maxPayloadSize: 10000
                  filter:
                    supported: true
                    maxResults: 100
                  changePassword:
                    supported: false
                  sort:
                    supported: false
                  etag:
                    supported: false
                  authenticationSchemes:
                    - name: Client Credentials
                      description: >
                        The client credentials (or other forms of client
                        authentication) can be used as an authorization grant
                        when the authorization scope is limited to the protected
                        resources under the control of the client, or to
                        protected resources previously arranged with the
                        authorization server. Client credentials are used as an
                        authorization grant typically when the client is acting
                        on its own behalf (the client is also the resource
                        owner) or is requesting access to protected resources
                        based on an authorization previously arranged with the
                        authorization server.
                      specUri: https://www.rfc-editor.org/rfc/rfc6749#section-4.4
                      type: oauth2
                      primary: true
                    - name: Authorization Grant
                      description: >
                        An authorization grant is a credential representing the
                        resource owner's authorization (to access its protected
                        resources) used by the client to obtain an access token.
                        This specification defines four grant types --
                        authorization code, implicit, resource owner password
                        credentials, and client credentials -- as well as an
                        extensibility mechanism for defining additional types.
                      specUri: https://www.rfc-editor.org/rfc/rfc6749#section-4.1
                      type: oauth2
                      primary: false
                  meta:
                    resourceType: ServiceProviderConfig
                    location: http://localhost:9900/scim/v2/ServiceProviderConfig
        '401':
          description: Unauthorized - The request requires user authentication.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Indicates whether the operation was successful or not.
                    example: false
                  reasons:
                    type: array
                    description: >-
                      A list of reasons explaining why the request was
                      unauthorized.
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A message describing the reason for the unauthorized
                            error.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            An error code associated with the unauthorized
                            error.
                          example: '90000011'
                example:
                  success: false
                  reasons:
                    - message: Unauthorized
                      code: '90000011'
        '403':
          description: >-
            Forbidden - The server understands the request but refuses to
            authorize it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: The timestamp when the error occurred.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: HTTP status code representing the error.
                    example: 403
                  error:
                    type: string
                    description: A brief description of the error.
                    example: Forbidden
                  message:
                    type: string
                    description: A message explaining why access was forbidden.
                    example: Admin access denied
                  path:
                    type: string
                    description: The path of the request that caused the error.
                    example: /scim/v2/Groups
                example:
                  timestamp: '2023-07-28T10:47:07.931+00:00'
                  status: 403
                  error: Forbidden
                  message: Admin access denied
                  path: /scim/v2/Groups
        '404':
          description: Not Found - The requested resource could not be found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    description: >-
                      A list of schema URNs that describe the structure of the
                      error response.
                    items:
                      type: string
                  status:
                    type: string
                    description: HTTP status code representing the error.
                    example: '404'
                  detail:
                    type: string
                    description: >-
                      A detailed message explaining the resource not found
                      error.
                    example: Resource not found
                example:
                  schemas:
                    - urn:ietf:params:scim:api:messages:2.0:Error
                  status: '404'
                  detail: Resource not found
  /scim/v2/Users:
    servers:
      - url: https://one.zuora.com
        description: OneID SCIM API Server
    get:
      tags:
        - SCIM
      summary: List users
      description: >
        Returns a paginated list of users, 100 users per page by default.

        When querying larger instances, reduce the count parameter to 1,000 or
        less, and use the startIndex parameter to paginate through users.

        It's possible to return a list of specific types of users with the
        filter parameter.

        Examples:

        ```
          /list?filter=userName eq "testuser"
          /list??filter=status eq "PENDING_ACTIVATION"
          /list??filter=id eq "91f659cd-6ded-4d92-aa5c-144c3b5455c3" and status eq "PENDING_ACTIVATION"
        ```
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      operationId: getListOfUsers
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:

                - `application/json`

                - `application/xml`

                - `text/html`

                - `text/csv`

                - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              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.
              schema:
                type: string
            RateLimit-Remaining:
              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.
              schema:
                type: number
            RateLimit-Reset:
              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.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              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.
              schema:
                type: string
                maxLength: 64
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that describe the structure of the
                      response.
                  totalResults:
                    type: integer
                    description: The total number of results matching the query.
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                          description: >-
                            A list of schema URNs that describe the structure of
                            the user resource.
                        id:
                          type: string
                          description: The unique identifier for the user resource.
                        meta:
                          type: object
                          properties:
                            created:
                              type: string
                              format: date-time
                              description: >-
                                The timestamp when the user resource was
                                created.
                            resourceType:
                              type: string
                              description: The type of resource, in this case, 'User'.
                            location:
                              type: string
                              description: The URI of the user resource.
                        userName:
                          type: string
                          description: The username associated with the user account.
                        name:
                          type: object
                          properties:
                            formatted:
                              type: string
                              description: >-
                                The full name of the user, formatted for
                                display.
                            familyName:
                              type: string
                              description: The user's family (last) name.
                            givenName:
                              type: string
                              description: The user's given (first) name.
                        displayName:
                          type: string
                          description: The display name of the user.
                        preferredLanguage:
                          type: string
                          description: The preferred language of the user.
                        locale:
                          type: string
                          description: The locale of the user.
                        active:
                          type: boolean
                          description: Indicates whether the user account is active.
                        emails:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: The email address of the user.
                              display:
                                type: string
                                description: >-
                                  The display name associated with the email
                                  address.
                              type:
                                type: string
                                description: The type of email address (e.g., work, home).
                              primary:
                                type: boolean
                                description: >-
                                  Indicates whether this email address is the
                                  primary one for the user.
                        roles:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: The role identifier associated with the user.
                              display:
                                type: string
                                description: The display name of the role.
                        groups:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: >-
                                  The group identifier to which the user
                                  belongs.
                              display:
                                type: string
                                description: The display name of the group.
                        urn:zuora:scim:schemas:1.0:UserExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of schema URNs specific to the
                                UserExtension.
                            organizationId:
                              type: string
                              description: >-
                                The identifier of the organization to which the
                                user belongs.
                            status:
                              type: string
                              description: >-
                                The current status of the user account (e.g.,
                                ACTIVE, PENDING_ACTIVATION).
                            ssoEnabled:
                              type: boolean
                              description: >-
                                Indicates whether Single Sign-On (SSO) is
                                enabled for the user.
                            region:
                              type: string
                              description: The region where the user is located.
                  startIndex:
                    type: integer
                    description: The index of the first result in the current page.
                  itemsPerPage:
                    type: integer
                    description: The number of items per page in the response.
                example:
                  schemas:
                    - urn:ietf:params:scim:api:messages:2.0:ListResponse
                  totalResults: 327
                  resources:
                    - schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                        - urn:ietf:params:scim:schemas:core:2.0:User
                      id: 91f659cd-6ded-4d92-bd5c-144c3b5455c4
                      meta:
                        created: '2023-07-04T10:12:03.721Z'
                        resourceType: User
                        location: >-
                          http://localhost:9900/scim/v2/Users/91f659cd-6ded-4d92-bd5c-144c3b5455c4
                      userName: aghosh+123
                      name:
                        formatted: aghosh g
                        familyName: g
                        givenName: aghosh
                      displayName: aghosh g
                      preferredLanguage: en
                      locale: en-US
                      active: false
                      emails:
                        - value: aghosh+123@zuora.com
                          display: aghosh+123@zuora.com
                          type: work
                          primary: true
                      roles:
                        - value: ADMIN
                          display: ADMIN
                      urn:zuora:scim:schemas:1.0:UserExtension:
                        schemas:
                          - urn:zuora:scim:schemas:1.0:UserExtension
                        organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
                        status: PENDING_ACTIVATION
                        ssoEnabled: false
                        region: US
                    - schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                        - urn:ietf:params:scim:schemas:core:2.0:User
                      id: eb48a32d-2fe6-48d1-8a18-797919f3810a
                      meta:
                        created: '2023-07-13T06:15:25.836Z'
                        resourceType: User
                        location: >-
                          http://localhost:9900/scim/v2/Users/eb48a32d-2fe6-48d1-8a18-797919f3810a
                      userName: Amy+555
                      name:
                        formatted: Amy Lawrence
                        familyName: Amy
                        givenName: Lawrence
                      displayName: Amy Lawrence
                      preferredLanguage: en
                      locale: en-US
                      active: true
                      emails:
                        - value: asmurugesan+555@zuora.com
                          display: asmurugesan+555@zuora.com
                          type: work
                          primary: true
                      groups:
                        - value: 7f5c248e-44e8-48d3-bacc-b5bd1253c2e4
                          display: ''
                      roles:
                        - value: USER
                          display: USER
                      urn:zuora:scim:schemas:1.0:UserExtension:
                        schemas:
                          - urn:zuora:scim:schemas:1.0:UserExtension
                        organizationId: rc141dc2-901e-4813-a25d-ef480cff1e26
                        status: ACTIVE
                        ssoEnabled: false
                        region: EU
                  startIndex: 1
                  itemsPerPage: 100
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful or not. In
                      this case, it will be `false` due to unauthorized access.
                    example: false
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A brief description of the reason for the
                            unauthorized access. Provides context for the
                            failure.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            A code representing the error. Used for programmatic
                            identification of the error.
                          example: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: >-
                      The timestamp when the error occurred. Provides context
                      for when the error happened.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: >-
                      The HTTP status code for the error. Indicates that the
                      server understood the request but refuses to authorize it.
                    example: 403
                  error:
                    type: string
                    description: >-
                      A brief description of the error. Indicates that access is
                      forbidden.
                    example: Forbidden
                  message:
                    type: string
                    description: >-
                      A detailed message about the error, usually describing why
                      the request was forbidden.
                    example: Admin access denied
                  path:
                    type: string
                    description: >-
                      The URI path of the request that caused the error. Helps
                      in identifying the resource involved in the error.
                    example: /scim/v2/Users
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs related to the error response.
                      Provides information about the error response structure.
                  status:
                    type: string
                    description: >-
                      The HTTP status code for the error. Indicates that the
                      requested resource could not be found.
                    example: '404'
                  detail:
                    type: string
                    description: >-
                      A description of the error. Provides details about why the
                      resource was not found.
                    example: Resource not found
    post:
      tags:
        - SCIM
      summary: Create a user
      description: >
        Creates a user. Must include the userName attribute and an email
        address. User will be created as an SSO user by default and a federated
        ID must be provided for the user.
      operationId: createAUser
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              description: Array of user resources returned by the bulk operation.
              items:
                type: object
                required:
                  - schemas
                  - name
                  - active
                  - emails
                  - roles
                  - externalId
                  - userName
                  - preferredLanguage
                  - locale
                  - urn:zuora:scim:schemas:1.0:UserExtension
                properties:
                  schemas:
                    type: array
                    description: >-
                      List of schema URNs defining the structure of the user
                      resource.
                    items:
                      type: string
                  name:
                    type: object
                    description: Name details of the user.
                    properties:
                      givenName:
                        type: string
                        description: User's first name.
                      familyName:
                        type: string
                        description: User's last name.
                      formatted:
                        type: string
                        description: Formatted full name.
                  active:
                    type: boolean
                    description: Indicates whether the user is active.
                  emails:
                    type: array
                    description: List of email addresses associated with the user.
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Email address.
                        type:
                          type: string
                          description: Type of email (e.g., work, personal).
                        primary:
                          type: boolean
                          description: Indicates if this is the primary email.
                  roles:
                    type: array
                    description: Roles assigned to the user.
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Role value (e.g., ADMIN).
                  externalId:
                    type: string
                    description: External identifier for the user.
                  userName:
                    type: string
                    description: Unique username for the user.
                  preferredLanguage:
                    type: string
                    description: User's preferred language.
                  locale:
                    type: string
                    description: User's locale.
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    description: >-
                      Custom extension schema with additional attributes for the
                      user.
                    properties:
                      schemas:
                        type: array
                        description: List of URNs for the extension schemas.
                        items:
                          type: string
                      organizationId:
                        type: string
                        description: Identifier for the associated organization.
            example:
              - schemas:
                  - urn:zuora:scim:schemas:1.0:UserExtension
                  - urn:ietf:params:scim:schemas:core:2.0:User
                name:
                  givenName: Amy
                  familyName: Lawrence
                  formatted: Amy Lawrence
                active: true
                emails:
                  - value: amy+Lawrence@zuora.com
                    type: work
                    primary: true
                roles:
                  - value: ADMIN
                externalId: asdasdasdS
                userName: amy+test102
                preferredLanguage: en
                locale: en-US
                urn:zuora:scim:schemas:1.0:UserExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:UserExtension
                  organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                  id:
                    type: string
                    description: Unique identifier for the user.
                  externalId:
                    type: string
                    description: External identifier for the user.
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                        description: Timestamp of when the user was created.
                      resourceType:
                        type: string
                        description: Type of the resource (e.g., User).
                      location:
                        type: string
                        description: URL of the user resource.
                  userName:
                    type: string
                    description: Unique username for the user.
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                        description: Formatted full name.
                      familyName:
                        type: string
                        description: User's last name.
                      givenName:
                        type: string
                        description: User's first name.
                  displayName:
                    type: string
                    description: Display name of the user.
                  preferredLanguage:
                    type: string
                    description: User's preferred language.
                  locale:
                    type: string
                    description: User's locale.
                  active:
                    type: boolean
                    description: Indicates whether the user is active.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Email address.
                        display:
                          type: string
                          description: Display version of the email.
                        type:
                          type: string
                          description: Type of email (e.g., work, personal).
                        primary:
                          type: boolean
                          description: Indicates if this is the primary email.
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: Role value (e.g., ADMIN).
                        display:
                          type: string
                          description: Display version of the role.
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                      organizationId:
                        type: string
                        description: Identifier for the associated organization.
                      status:
                        type: string
                        description: Current status of the user.
                      ssoEnabled:
                        type: boolean
                        description: Indicates if SSO is enabled for the user.
                      region:
                        type: string
                        description: Region associated with the user.
              example:
                schemas:
                  - urn:zuora:scim:schemas:1.0:UserExtension
                  - urn:ietf:params:scim:schemas:core:2.0:User
                id: e1b624ac-e00f-422b-b4da-20070901b22f
                externalId: amy+test102
                meta:
                  created: '2024-09-05T07:44:44.262Z'
                  resourceType: User
                  location: >-
                    http://localhost:9900/scim/v2/Users/e1b624ac-e00f-422b-b4da-20070901b22f
                userName: amy+test102
                name:
                  formatted: Amy Lawrence
                  familyName: Lawrence
                  givenName: Amy
                displayName: Amy Lawrence
                preferredLanguage: en
                locale: en-US
                active: true
                emails:
                  - value: amy+test102@zuora.com
                    display: amy+test102@zuora.com
                    type: work
                    primary: true
                roles:
                  - value: ADMIN
                    display: ADMIN
                urn:zuora:scim:schemas:1.0:UserExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:UserExtension
                  organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                  status: ACTIVE
                  ssoEnabled: true
                  region: EU
        '201':
          description: Created
          headers:
            Content-Encoding:
              schema:
                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.
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that apply to the user resource.
                      This typically includes SCIM schema definitions and any
                      custom schemas used.
                  id:
                    type: string
                    description: >-
                      A unique identifier for the user resource. Assigned by the
                      server upon creation.
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                        description: >-
                          The timestamp when the user resource was created.
                          Provides information about the creation time of the
                          resource.
                      resourceType:
                        type: string
                        description: >-
                          The type of resource, in this case, it will be 'User'.
                          Helps identify the type of the resource.
                      location:
                        type: string
                        description: >-
                          The URL to access the newly created user resource.
                          Provides the URI of the user resource for future
                          references or operations.
                  userName:
                    type: string
                    description: >-
                      The username for the user. Typically used for login and
                      unique identification of the user within the system.
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                        description: >-
                          The full name of the user as a single formatted
                          string. Useful for display purposes.
                      familyName:
                        type: string
                        description: >-
                          The family name (surname) of the user. Used for
                          sorting and identifying users.
                      givenName:
                        type: string
                        description: >-
                          The given name (first name) of the user. Helps in
                          personalizing interactions and communications.
                  displayName:
                    type: string
                    description: >-
                      A display name for the user, typically used in user
                      interfaces or directories. It may combine various name
                      attributes for better presentation.
                  preferredLanguage:
                    type: string
                    description: >-
                      The preferred language of the user for communication. This
                      helps in providing content in the user's chosen language.
                  locale:
                    type: string
                    description: >-
                      The locale or region of the user, often used to format
                      dates, times, and numbers according to regional
                      preferences.
                  active:
                    type: boolean
                    description: >-
                      Indicates whether the user account is active. If `false`,
                      the user is considered inactive or disabled.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: >-
                            The email address of the user. Used for
                            communication and login purposes.
                        display:
                          type: string
                          description: >-
                            A human-readable email address, often the same as
                            `value`, but can be formatted differently.
                        type:
                          type: string
                          description: >-
                            The type of email address (e.g., work, home). Helps
                            categorize different types of email addresses.
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this email address is the primary
                            one for the user. Useful for identifying the main
                            contact address.
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: >-
                            The unique identifier of a group to which the user
                            belongs. Useful for group-based permissions and
                            organization.
                        display:
                          type: string
                          description: >-
                            The display name of the group. Provides a
                            human-readable name for the group.
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: >-
                            The role assigned to the user. Represents the user's
                            role within the system (e.g., admin, user).
                        display:
                          type: string
                          description: >-
                            The display name of the role. Provides a
                            human-readable label for the user's role.
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of schema URNs specific to the user extension.
                          Defines additional properties or custom attributes for
                          the user resource.
                      organizationId:
                        type: string
                        description: >-
                          The unique identifier for the organization to which
                          the user belongs. Useful for organizational management
                          and reporting.
                      status:
                        type: string
                        description: >-
                          The current status of the user account (e.g., ACTIVE,
                          PENDING_ACTIVATION). Helps in tracking the user’s
                          state.
                      ssoEnabled:
                        type: boolean
                        description: >-
                          Indicates whether Single Sign-On (SSO) is enabled for
                          the user. Useful for authentication and access
                          management.
                      region:
                        type: string
                        description: >-
                          The geographical region of the user. Helps in regional
                          data management and compliance.
                example:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:UserExtension
                    - urn:ietf:params:scim:schemas:core:2.0:User
                  id: eb48a32d-2fe6-48d1-8a18-797919f3810a
                  meta:
                    created: '2023-07-13T06:15:25.836Z'
                    resourceType: User
                    location: >-
                      http://localhost:9900/scim/v2/Users/eb48a32d-2fe6-48d1-8a18-797919f3810a
                  userName: Amy+555
                  name:
                    formatted: Amy Lawrence
                    familyName: Lawrence
                    givenName: Amy
                  displayName: Amy Lawrence
                  preferredLanguage: en
                  locale: en-US
                  active: true
                  emails:
                    - value: asmurugesan+555@zuora.com
                      display: asmurugesan+555@zuora.com
                      type: work
                      primary: true
                  groups:
                    - value: 7f5c248e-44e8-48d3-bacc-b5bd1253c2e4
                      display: ''
                  roles:
                    - value: USER
                      display: USER
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                    organizationId: rc141dc2-901e-4813-a25d-ef480cff1e26
                    status: ACTIVE
                    ssoEnabled: false
                    region: EU
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful. For a 401
                      error, this will always be false.
                    example: false
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A message describing the reason for the unauthorized
                            error. Provides more context about the failure.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            An application-specific error code that provides
                            additional details about the unauthorized error.
                          example: '90000011'
                example:
                  success: false
                  reasons:
                    - message: Unauthorized
                      code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: >-
                      The timestamp when the error occurred. Useful for
                      debugging and tracking when the error happened.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: >-
                      The HTTP status code representing the error. For forbidden
                      errors, this will always be 403.
                    example: 403
                  error:
                    type: string
                    description: >-
                      A brief description of the error type. In this case, it
                      indicates a 'Forbidden' error.
                    example: Forbidden
                  message:
                    type: string
                    description: >-
                      A message providing more details about the specific error
                      that occurred. Describes why access was denied.
                    example: Admin access denied
                  path:
                    type: string
                    description: >-
                      The URI path of the resource that caused the error. Helps
                      in identifying which resource or endpoint triggered the
                      error.
                    example: /scim/v2/Users
                example:
                  timestamp: '2023-07-28T10:47:07.931+00:00'
                  status: 403
                  error: Forbidden
                  message: Admin access denied
                  path: /scim/v2/Users
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that are relevant to the error
                      response. Usually includes a standard error schema.
                  status:
                    type: string
                    description: >-
                      The HTTP status code representing the error. For not found
                      errors, this will always be '404'.
                    example: '404'
                  detail:
                    type: string
                    description: >-
                      A message providing details about the resource that was
                      not found. Helps in understanding what was missing or
                      incorrectly requested.
                    example: Resource not found
                example:
                  schemas:
                    - urn:ietf:params:scim:api:messages:2.0:Error
                  status: '404'
                  detail: Resource not found
  /scim/v2/Users/bulk:
    servers:
      - url: https://one.zuora.com
        description: OneID SCIM API Server
    post:
      tags:
        - SCIM
      summary: Bulk create users
      description: Creates multiple users within an organization.
      operationId: bulkCreateUsers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that describe the structure of the
                      user resource. These URNs indicate the schemas that are
                      applicable to the user data.
                  name:
                    type: object
                    properties:
                      givenName:
                        type: string
                        description: The given (or first) name of the user.
                      familyName:
                        type: string
                        description: The family (or last) name of the user.
                      formatted:
                        type: string
                        description: >-
                          The full name of the user in a formatted string.
                          Typically includes given name and family name.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The email address of the user.
                        type:
                          type: string
                          description: The type of email address (e.g., 'work', 'home').
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this email address is the user's
                            primary email.
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: >-
                            The role assigned to the user, typically represented
                            by an identifier.
                        display:
                          type: string
                          nullable: true
                  userName:
                    type: string
                    description: The username or login name of the user.
                  preferredLanguage:
                    type: string
                    description: >-
                      The preferred language of the user, typically represented
                      by a locale code (e.g., 'en', 'fr').
                  locale:
                    type: string
                    description: >-
                      The locale of the user, typically represented by a locale
                      code (e.g., 'en-US', 'fr-FR').
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of schema URNs that describe additional
                          extensions or custom schemas applied to the user
                          resource.
                      organizationId:
                        type: string
                        description: >-
                          An identifier for the organization to which the user
                          belongs. This may be used for organizational or
                          grouping purposes.
            example:
              - schemas:
                  - urn:zuora:scim:schemas:1.0:UserExtension
                  - urn:ietf:params:scim:schemas:core:2.0:User
                name:
                  givenName: Amy
                  familyName: Lawrence
                  formatted: Amy Lawrence
                emails:
                  - value: Amy+test3@zuora.com
                    type: work
                    primary: true
                roles:
                  - value: USER
                userName: Amy+test3@zuora.com
                preferredLanguage: en
                locale: en-US
                urn:zuora:scim:schemas:1.0:UserExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:UserExtension
                  organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
              - schemas:
                  - urn:zuora:scim:schemas:1.0:UserExtension
                  - urn:ietf:params:scim:schemas:core:2.0:User
                name:
                  givenName: Amy
                  familyName: Lawrence
                  formatted: Amy Lawrence
                emails:
                  - value: Amy+test4@zuora.com
                    type: work
                    primary: true
                roles:
                  - value: USER
                userName: Amy+test4@zuora.com
                preferredLanguage: en
                locale: en-US
                urn:zuora:scim:schemas:1.0:UserExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:UserExtension
                  organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that describe the structure of the
                      response. These URNs indicate the schemas that are
                      applicable to the data.
                  id:
                    type: string
                    nullable: true
                    description: >-
                      A unique identifier for the response object, often used
                      for referencing or tracking.
                  externalId:
                    type: string
                    nullable: true
                    description: >-
                      An external identifier for the resource, often used for
                      integration with external systems.
                  totalResults:
                    type: integer
                    description: >-
                      The total number of user resources available in the
                      response, irrespective of pagination.
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                          description: >-
                            A list of schema URNs that describe the structure of
                            the individual user resource. These URNs indicate
                            the schemas applicable to the user data.
                        id:
                          type: string
                          nullable: true
                          description: A unique identifier for the user resource.
                        externalId:
                          type: string
                          nullable: true
                          description: >-
                            An external identifier for the resource, often used
                            for integration with external systems.
                        meta:
                          nullable: true
                          type: object
                          properties:
                            created:
                              type: string
                              format: date-time
                              description: >-
                                The date and time when the user resource was
                                created, in ISO 8601 format.
                            resourceType:
                              type: string
                              description: >-
                                The type of the resource, typically 'User' for
                                user resources.
                            location:
                              type: string
                              description: The URL where the user resource can be accessed.
                        userName:
                          type: string
                          description: The username or login name for the user.
                        name:
                          type: object
                          properties:
                            formatted:
                              type: string
                              description: >-
                                The full name of the user, formatted as a single
                                string.
                            familyName:
                              type: string
                              description: The family (or last) name of the user.
                            givenName:
                              type: string
                              description: The given (or first) name of the user.
                        displayName:
                          type: string
                          description: >-
                            The display name of the user, typically used for
                            user identification.
                        preferredLanguage:
                          type: string
                          description: >-
                            The user's preferred language, typically represented
                            by a locale code (e.g., 'en', 'fr').
                        locale:
                          type: string
                          description: >-
                            The user's locale, typically represented as a locale
                            code (e.g., 'en-US', 'fr-FR').
                        active:
                          type: boolean
                          description: >-
                            Indicates whether the user is currently active or
                            not.
                        emails:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: The email address of the user.
                              display:
                                type: string
                                description: >-
                                  A display name or description for the email
                                  address.
                              type:
                                type: string
                                description: >-
                                  The type of email address (e.g., 'work',
                                  'home').
                              primary:
                                type: boolean
                                description: >-
                                  Indicates whether this email address is the
                                  primary one for the user.
                        roles:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: >-
                                  The role assigned to the user, often
                                  represented by an identifier.
                              display:
                                type: string
                                nullable: true
                        urn:zuora:scim:schemas:1.0:UserExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of schema URNs that describe additional
                                extensions or custom schemas applied to the user
                                resource.
                            organizationId:
                              type: string
                              format: uuid
                              example: ec141dc2-901e-4813-a25d-ef480cff1e26
                              description: >-
                                An identifier for the organization to which the
                                user belongs. This may be used for
                                organizational or grouping purposes.
                            status:
                              type: string
                              example: NEW
                              description: >-
                                The current status of the user. Example values
                                might include 'NEW', 'ACTIVE', 'INACTIVE', etc.
                            ssoEnabled:
                              type: boolean
                              description: >-
                                Indicates whether Single Sign-On (SSO) is
                                enabled for the user.
                            region:
                              type: string
                  startIndex:
                    type: integer
                  itemsPerPage:
                    type: integer
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 2
                resources:
                  - schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: 8b40ccce-5fb7-4643-9b78-e194fe5303e6
                    externalId: Amy+test3@zuora.com
                    meta:
                      created: '2024-10-03T09:37:39.851Z'
                      resourceType: User
                      location: >-
                        http://localhost:9900/scim/v2/Users/bulk/8b40ccce-5fb7-4643-9b78-e194fe5303e6
                    userName: Amy+test3@zuora.com
                    name:
                      formatted: Amy Lawrence
                      familyName: Amy
                      givenName: Lawrence
                    displayName: Amy Lawrence
                    preferredLanguage: en
                    locale: en-US
                    active: true
                    emails:
                      - value: Amy+test3@zuora.com
                        display: Amy+test3@zuora.com
                        type: work
                        primary: true
                    roles:
                      - value: USER
                        display: USER
                    urn:zuora:scim:schemas:1.0:UserExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      status: ACTIVE
                      ssoEnabled: true
                      region: EU
                  - schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: 41aa4e47-01e2-4d85-a6bc-d88e18477011
                    externalId: Amy+test4@zuora.com
                    meta:
                      created: '2024-10-03T09:37:40.161Z'
                      resourceType: User
                      location: >-
                        http://localhost:9900/scim/v2/Users/bulk/41aa4e47-01e2-4d85-a6bc-d88e18477011
                    userName: Amy+test4@zuora.com
                    name:
                      formatted: Amy Lawrence
                      familyName: Amy
                      givenName: Lawrence
                    displayName: Amy Lawrence
                    preferredLanguage: en
                    locale: en-US
                    active: true
                    emails:
                      - value: Amy+test4@zuora.com
                        display: Amy+test4@zuora.com
                        type: work
                        primary: true
                    roles:
                      - value: USER
                        display: USER
                    urn:zuora:scim:schemas:1.0:UserExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      status: ACTIVE
                      ssoEnabled: true
                      region: EU
                startIndex: 1
                itemsPerPage: 2
        '201':
          description: Created
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the operation was successful or not. For
                      a 401 Unauthorized error, this will be `false`.
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A brief description of the reason for the
                            unauthorized access. This message typically explains
                            why the request is unauthorized, such as missing or
                            invalid authentication credentials.
                        code:
                          type: string
                          description: >-
                            An error code that provides a more specific
                            identification of the issue. This code can be used
                            for debugging or logging purposes.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: >-
                      The date and time when the error occurred, in ISO 8601
                      format.
                  status:
                    type: integer
                    description: >-
                      The HTTP status code for the response, which is 403 in
                      this case, indicating that access to the resource is
                      forbidden.
                  error:
                    type: string
                    description: >-
                      A short, descriptive string representing the error type.
                      For a 403 response, this is typically 'Forbidden'.
                  message:
                    type: string
                    description: >-
                      A human-readable message providing additional details
                      about the error. This message typically explains why
                      access is denied.
                  path:
                    type: string
                    description: The URI path of the resource where the error occurred.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that describe the structure of the
                      error response. This helps in understanding the error
                      context.
                  status:
                    type: string
                    description: >-
                      The HTTP status code for the response, which is 404 in
                      this case, indicating that the requested resource could
                      not be found.
                  detail:
                    type: string
                    description: >-
                      A human-readable message providing additional information
                      about the error. This typically explains what resource was
                      not found.
    patch:
      tags:
        - SCIM
      summary: Bulk update users
      description: >-
        Updates an existing multiple user resource, overwriting values for
        specified attributes.
      operationId: bulkUpdateUsers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that apply to this resource,
                      indicating the structure and attributes of the resource.
                  id:
                    type: string
                    description: A unique identifier for the resource within the system.
                  externalId:
                    type: string
                    description: >-
                      An external identifier for the resource, often used for
                      integration with external systems.
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                        description: >-
                          The date and time when the resource was created, in
                          ISO 8601 format.
                      resourceType:
                        type: string
                        description: >-
                          The type of resource (e.g., User) this metadata
                          pertains to.
                      location:
                        type: string
                        description: >-
                          The URL where the resource can be accessed or
                          retrieved.
                  userName:
                    type: string
                    description: >-
                      The username of the user. This is typically a unique
                      identifier for the user within the system.
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                        description: >-
                          The full name of the user in a formatted string (e.g.,
                          'John Doe').
                      familyName:
                        type: string
                        description: The family name (or surname) of the user.
                      givenName:
                        type: string
                        description: The given name (or first name) of the user.
                  displayName:
                    type: string
                    description: >-
                      A name that is suitable for display to end-users, which
                      may be different from the username or full name.
                  preferredLanguage:
                    type: string
                    description: >-
                      The preferred language of the user for communication and
                      content.
                  locale:
                    type: string
                    description: >-
                      The locale of the user, typically used to determine
                      regional settings (e.g., 'en-US' for English, United
                      States).
                  active:
                    type: boolean
                    description: >-
                      Indicates whether the user account is currently active. A
                      value of `true` means the account is active, and `false`
                      means it is inactive.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The email address of the user.
                        display:
                          type: string
                          description: >-
                            A display name for the email address, often the same
                            as the email address itself.
                        type:
                          type: string
                          description: The type of email address (e.g., 'work', 'home').
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this email address is the primary
                            one for the user. A value of `true` means it is the
                            primary email.
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: >-
                            The role assigned to the user (e.g., 'ADMIN',
                            'USER').
                        display:
                          type: string
                          nullable: true
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of schema URNs specific to the user extension,
                          indicating additional attributes.
                      organizationId:
                        type: string
                        description: >-
                          An identifier for the organization associated with the
                          user, often used for organizational contexts.
                      status:
                        type: string
                        description: >-
                          The current status of the user within the system
                          (e.g., 'ACTIVE', 'PENDING').
                      ssoEnabled:
                        type: boolean
                        description: >-
                          Indicates whether Single Sign-On (SSO) is enabled for
                          the user. A value of `true` means SSO is enabled.
                      region:
                        type: string
                        description: ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  itemsPerPage:
                    type: integer
                    description: |
                      The items that are allowed on each page.
                  startIndex:
                    type: integer
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that apply to this resource,
                      indicating the structure and attributes of the response.
                  id:
                    type: string
                    nullable: true
                    description: >-
                      A unique identifier for the response resource, typically
                      the ID of the user or group.
                  externalId:
                    type: string
                    nullable: true
                    description: >-
                      An external identifier for the resource, often used for
                      integration with external systems.
                  meta:
                    type: object
                    nullable: true
                    properties:
                      created:
                        type: string
                        format: date-time
                        description: >-
                          The date and time when the user resource was created,
                          in ISO 8601 format.
                      resourceType:
                        type: string
                        description: The type of resource (e.g., 'User').
                      location:
                        type: string
                        description: >-
                          The URL where the user resource can be accessed or
                          retrieved.
                  totalResults:
                    type: integer
                    description: >-
                      The total number of results returned by the request. This
                      helps in pagination and determining the total size of the
                      dataset.
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                          description: >-
                            A list of schema URNs that define the structure and
                            attributes of the user resource.
                        id:
                          type: string
                          nullable: true
                          description: A unique identifier for the user resource.
                        externalId:
                          type: string
                          nullable: true
                          description: >-
                            An external identifier for the resource, often used
                            for integration with external systems.
                        meta:
                          type: object
                          properties:
                            created:
                              type: string
                              format: date-time
                              description: >-
                                The date and time when the user resource was
                                created, in ISO 8601 format.
                            resourceType:
                              type: string
                              description: The type of resource (e.g., 'User').
                            location:
                              type: string
                              description: >-
                                The URL where the user resource can be accessed
                                or retrieved.
                        userName:
                          type: string
                          description: >-
                            The username of the user, typically used as a unique
                            identifier.
                        name:
                          type: object
                          properties:
                            formatted:
                              type: string
                              description: >-
                                The full name of the user formatted as a single
                                string (e.g., 'John Doe').
                            familyName:
                              type: string
                              description: The user's family name (surname).
                            givenName:
                              type: string
                              description: The user's given name (first name).
                        displayName:
                          type: string
                          description: >-
                            A display name for the user, which may differ from
                            the username or full name.
                        preferredLanguage:
                          type: string
                          description: >-
                            The user's preferred language for communication and
                            content.
                        locale:
                          type: string
                          description: >-
                            The user's locale, which typically indicates
                            regional settings (e.g., 'en-US').
                        active:
                          type: boolean
                          description: >-
                            Indicates whether the user account is currently
                            active. `true` means active, `false` means inactive.
                        emails:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: The email address of the user.
                              display:
                                type: string
                                description: >-
                                  A display name for the email address, often
                                  the same as the email address itself.
                              type:
                                type: string
                                description: >-
                                  The type of email address (e.g., 'work',
                                  'home').
                              primary:
                                type: boolean
                                description: >-
                                  Indicates whether this email address is the
                                  primary one for the user. `true` means
                                  primary.
                        roles:
                          type: array
                          items:
                            type: object
                            properties:
                              value:
                                type: string
                                description: The role assigned to the user (e.g., 'ADMIN').
                              display:
                                type: string
                                nullable: true
                        urn:zuora:scim:schemas:1.0:UserExtension:
                          type: object
                          properties:
                            schemas:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of schema URNs specific to the user
                                extension, detailing additional attributes.
                            organizationId:
                              type: string
                              format: uuid
                              example: ec141dc2-901e-4813-a25d-ef480cff1e26
                              description: >-
                                An identifier for the organization associated
                                with the user.
                            status:
                              type: string
                              example: NEW
                              description: >-
                                The current status of the user (e.g., 'ACTIVE',
                                'NEW').
                            ssoEnabled:
                              type: boolean
                              description: >-
                                Indicates whether Single Sign-On (SSO) is
                                enabled for the user. `true` means SSO is
                                enabled.
                            region:
                              type: string
                              description: ''
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 2
                resources:
                  - schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: 41aa4e47-01e2-4d85-a6bc-d88e18477011
                    externalId: Amy+test4@zuora.com
                    meta:
                      created: '2024-10-03T09:37:40.161Z'
                      resourceType: User
                      location: >-
                        http://localhost:9900/scim/v2/Users/bulk/41aa4e47-01e2-4d85-a6bc-d88e18477011
                    userName: Amy+test4@zuora.com
                    name:
                      formatted: Amy Lawrence
                      familyName: Amy
                      givenName: Lawrence
                    displayName: Amy Lawrence
                    preferredLanguage: en
                    locale: en-US
                    active: true
                    emails:
                      - value: updated2@example.com
                        display: updated2@example.com
                        type: work
                        primary: true
                    roles:
                      - value: USER
                        display: USER
                    urn:zuora:scim:schemas:1.0:UserExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      status: ACTIVE
                      ssoEnabled: true
                      region: EU
                  - schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: 8b40ccce-5fb7-4643-9b78-e194fe5303e6
                    externalId: Amy+test3@zuora.com
                    meta:
                      created: '2024-10-03T09:37:39.851Z'
                      resourceType: User
                      location: >-
                        http://localhost:9900/scim/v2/Users/bulk/8b40ccce-5fb7-4643-9b78-e194fe5303e6
                    userName: Amy+test3@zuora.com
                    name:
                      formatted: Amy Lawrence
                      familyName: Amy
                      givenName: Lawrence
                    displayName: Amy Lawrence
                    preferredLanguage: en
                    locale: en-US
                    active: true
                    emails:
                      - value: updated3@example.com
                        display: updated3@example.com
                        type: work
                        primary: true
                    roles:
                      - value: USER
                        display: USER
                    urn:zuora:scim:schemas:1.0:UserExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      status: ACTIVE
                      ssoEnabled: true
                      region: EU
                startIndex: 1
                itemsPerPage: 2
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
                description: >-
                  The request was successful, but there is no content to return.
                  Typically used for operations like delete where no data is
                  returned.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful. For
                      unauthorized requests, this will be `false`.
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A description of why the request is unauthorized
                            (e.g., 'Invalid credentials').
                        code:
                          type: string
                          description: >-
                            A code representing the specific reason for the
                            unauthorized access (e.g., '90000011').
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: The timestamp when the error occurred, in ISO 8601 format.
                  status:
                    type: integer
                    description: >-
                      The HTTP status code for the error, which will be `403`
                      for Forbidden.
                  error:
                    type: string
                    description: A short description of the error (e.g., 'Forbidden').
                  message:
                    type: string
                    description: >-
                      A detailed message explaining why access was denied (e.g.,
                      'Admin access denied').
                  path:
                    type: string
                    description: >-
                      The API endpoint path where the error occurred (e.g.,
                      '/scim/v2/Users').
  /scim/v2/Users/delete:
    servers:
      - url: https://one.zuora.com
        description: OneID SCIM API Server
    post:
      tags:
        - SCIM
      summary: Delete a list of users
      description: |
        Sets multiple users to deactivate.
        The value of the `id` should be the user's corresponding user ID.
      operationId: deleteAListOfUsers
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
                format: uuid
              example:
                - ebc229f7-aef2-44ad-8e5f-9d1cf0b4c724
                - bb5c5d37-0707-4aee-b4b2-c818f4b3503b
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                type: string
                minLength: 36
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
            Zuora-Track-Id:
              schema:
                type: string
              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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resources:
                    type: array
                    items:
                      type: object
                      properties:
                        schemas:
                          type: array
                          items:
                            type: string
                        externalId:
                          type: string
                          nullable: true
                          description: >-
                            An external identifier associated with the resource,
                            if available.
                        id:
                          type: string
                          nullable: true
                          description: The unique identifier assigned to the resource.
                        meta:
                          type: object
                          nullable: true
                          properties:
                            resourceType:
                              type: string
                              description: The type of resource (e.g., 'User').
                            location:
                              type: string
                              description: The URL where the resource can be accessed.
                            created:
                              type: string
                              description: >
                                The creation date and time when the resource was
                                created.
                              format: dateTime
                        schemaUrns:
                          type: array
                          items:
                            type: string
                          description: >-
                            A list of URNs for SCIM schemas that this resource
                            conforms to.
                  externalId:
                    type: string
                    nullable: true
                    description: >-
                      An external identifier associated with the collection of
                      resources, if available.
                  id:
                    type: string
                    nullable: true
                    description: The unique identifier for the collection of resources.
                  itemsPerPage:
                    type: integer
                    format: int32
                    description: The number of items returned per page in the response.
                  meta:
                    nullable: true
                    type: object
                    properties:
                      resourceType:
                        type: string
                        description: >-
                          The type of resource for the collection (e.g.,
                          'User').
                      location:
                        type: string
                        description: >-
                          The URL where the collection of resources can be
                          accessed.
                  schemas:
                    type: array
                    uniqueItems: true
                    items:
                      type: string
                    description: >-
                      A list of URNs for SCIM schemas applicable to the
                      collection of resources.
                  startIndex:
                    type: integer
                    format: int32
                    description: >-
                      The index of the first item in the current page of
                      results.
                  totalResults:
                    type: integer
                    format: int64
                    description: The total number of results available across all pages.
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:ListResponse
                id: null
                externalId: null
                meta: null
                totalResults: 2
                resources:
                  - schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: ebc229f7-aef2-44ad-8e5f-9d1cf0b4c724
                    meta:
                      created: '2024-02-19T08:23:08.488Z'
                      resourceType: User
                      location: >-
                        http://localhost:9900/scim/v2/Users/delete/ebc229f7-aef2-44ad-8e5f-9d1cf0b4c724
                    userName: 0392538e-caf3-4125-aa1d-82fe1f5132b3
                    name:
                      formatted: Amy Lawrence
                      familyName: Amy
                      givenName: Lawrence
                    displayName: Amy Lawrence
                    preferredLanguage: en
                    locale: en-US
                    active: false
                    emails:
                      - value: 0392538e-caf3-4125-aa1d-82fe1f5132b3@zuora.com
                        display: 0392538e-caf3-4125-aa1d-82fe1f5132b3@zuora.com
                        type: work
                        primary: true
                    roles:
                      - value: USER
                        display: USER
                    urn:zuora:scim:schemas:1.0:UserExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      status: INACTIVE
                      ssoEnabled: false
                      region: US
                startIndex: 1
                itemsPerPage: 2
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of URNs for SCIM schemas that this resource
                      conforms to.
                  id:
                    type: string
                    description: The unique identifier for the resource.
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                        description: The date and time when the resource was created.
                      resourceType:
                        type: string
                        description: The type of the resource (e.g., 'User').
                      location:
                        type: string
                        description: The URL where the resource can be accessed.
                  userName:
                    type: string
                    description: The username of the user.
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                        description: The full name of the user, formatted for display.
                      familyName:
                        type: string
                        description: The user's family (last) name.
                      givenName:
                        type: string
                        description: The user's given (first) name.
                  displayName:
                    type: string
                    description: The display name of the user.
                  preferredLanguage:
                    type: string
                    description: The preferred language of the user.
                  locale:
                    type: string
                    description: >-
                      The locale of the user, typically in the format
                      'language-COUNTRY' (e.g., 'en-US').
                  active:
                    type: boolean
                    description: Indicates whether the user is active.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The email address.
                        display:
                          type: string
                          description: A human-readable form of the email address.
                        type:
                          type: string
                          description: The type of email address (e.g., 'work', 'home').
                        primary:
                          type: boolean
                          description: Indicates whether this is the primary email address.
                    description: A list of email addresses associated with the user.
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The unique identifier for the group.
                        display:
                          type: string
                          description: The display name of the group.
                    description: A list of groups the user is a member of.
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The role assigned to the user.
                        display:
                          type: string
                          description: The display name of the role.
                    description: A list of roles assigned to the user.
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of URNs for SCIM schemas that this extension
                          conforms to.
                      organizationId:
                        type: string
                        description: >-
                          The identifier for the organization to which the user
                          belongs.
                      status:
                        type: string
                        description: The status of the user (e.g., 'ACTIVE', 'INACTIVE').
                      ssoEnabled:
                        type: boolean
                        description: >-
                          Indicates whether Single Sign-On (SSO) is enabled for
                          the user.
                      region:
                        type: string
                        description: >-
                          The region or geographic location associated with the
                          user.
                example:
                  application/json:
                    value:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                        - urn:ietf:params:scim:schemas:core:2.0:User
                      id: 791aad21-0036-4138-b9b0-350516bac4ac
                      meta:
                        created: '2023-07-13T06:15:25.836Z'
                        resourceType: User
                        location: >-
                          http://localhost:9900/scim/v2/Users/791aad21-0036-4138-b9b0-350516bac4ac
                      userName: username2
                      name:
                        formatted: Jane Doe
                        familyName: Doe
                        givenName: Jane
                      displayName: Jane Doe
                      preferredLanguage: en
                      locale: en-US
                      active: false
                      emails:
                        - value: jane.doe@example.com
                          display: jane.doe@example.com
                          type: work
                          primary: true
                      groups:
                        - value: group2
                          display: Group 2
                      roles:
                        - value: USER
                          display: USER
                      urn:zuora:scim:schemas:1.0:UserExtension:
                        schemas:
                          - urn:zuora:scim:schemas:1.0:UserExtension
                        organizationId: org2
                        status: INACTIVE
                        ssoEnabled: false
                        region: EU
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful. A value of
                      `false` indicates that an error occurred.
                    example: false
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A human-readable message describing the error or
                            reason for the failure.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            A specific error code representing the type of
                            error. This code can be used for programmatic error
                            handling.
                          example: '90000011'
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: >-
                      The date and time when the error occurred, formatted
                      according to ISO 8601.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: >-
                      The HTTP status code associated with the error response.
                      Indicates the type of error that occurred.
                    example: 403
                  error:
                    type: string
                    description: >-
                      A short, descriptive name for the error. Often corresponds
                      to the HTTP status code.
                    example: Forbidden
                  message:
                    type: string
                    description: >-
                      A detailed message describing the error that occurred.
                      This message is intended to help the client understand the
                      nature of the problem.
                    example: Admin access denied
                  path:
                    type: string
                    description: >-
                      The URI path of the request that resulted in the error.
                      This can help identify which resource or endpoint caused
                      the issue.
                    example: /scim/v2/Users/delete
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Users/delete
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                      enum:
                        - urn:ietf:params:scim:api:messages:2.0:Error
                    description: >-
                      A list of URNs indicating the schemas that describe the
                      structure of the error response. This provides information
                      on the format and content of the error message.
                  status:
                    type: string
                    description: >-
                      A string representation of the HTTP status code indicating
                      the error. This helps in identifying the type of error
                      that occurred.
                  detail:
                    type: string
                    description: >-
                      A detailed message providing additional context or
                      explanation about the error. This helps in understanding
                      the specific issue or reason for the error.
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
  /scim/v2/Users/{id}:
    servers:
      - url: https://one.zuora.com
        description: OneID SCIM API Server
    get:
      tags:
        - SCIM
      summary: Retrieve a user
      description: |
        Retrieves a single user resource.
        The value of the <id> should be the user's corresponding user ID.
      operationId: getASpecificUser
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the user to retrieve.
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.

                  Note that only the following MIME types support gzipped
                  responses:
                    - `application/json`
                    - `application/xml`
                    - `text/html`
                    - `text/csv`
                    - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                    description: >-
                      A list of schema URNs that define the structure and
                      attributes of the user resource.
                  id:
                    type: string
                    description: The unique identifier for the user resource.
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                        description: The date and time when the user resource was created.
                      resourceType:
                        type: string
                        description: The type of resource (e.g., 'User').
                      location:
                        type: string
                        description: >-
                          The URL where the user resource can be accessed or
                          retrieved.
                  userName:
                    type: string
                    description: The user’s unique username.
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                        description: >-
                          The full name of the user, including both given and
                          family names.
                      familyName:
                        type: string
                        description: The family name (surname) of the user.
                      givenName:
                        type: string
                        description: The given name (first name) of the user.
                  displayName:
                    type: string
                    description: >-
                      The display name of the user, used for user interface
                      purposes.
                  preferredLanguage:
                    type: string
                    description: >-
                      The preferred language for the user, specified using a
                      language code (e.g., 'en').
                  locale:
                    type: string
                    description: >-
                      The locale of the user, specified using a locale code
                      (e.g., 'en-US').
                  active:
                    type: boolean
                    description: Indicates whether the user account is active.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The email address of the user.
                        display:
                          type: string
                          description: The email address displayed in the user interface.
                        type:
                          type: string
                          description: The type of email address (e.g., 'work', 'home').
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this email address is the primary
                            email for the user.
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: >-
                            The identifier of the group to which the user
                            belongs.
                        display:
                          type: string
                          description: The display name of the group.
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The role assigned to the user.
                        display:
                          type: string
                          description: The display name of the role.
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of schema URNs specific to Zuora’s user
                          extension schema.
                      organizationId:
                        type: string
                        description: >-
                          The identifier for the organization to which the user
                          belongs.
                      status:
                        type: string
                        description: The status of the user account (e.g., 'ACTIVE').
                      ssoEnabled:
                        type: boolean
                        description: >-
                          Indicates whether Single Sign-On (SSO) is enabled for
                          the user.
                      region:
                        type: string
                        description: The region associated with the user (e.g., 'EU').
              examples:
                user:
                  summary: Example of a user response
                  value:
                    schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: eb48a32d-2fe6-48d1-8a18-797919f3810a
                    meta:
                      created: '2023-07-13T06:15:25.836Z'
                      resourceType: User
                      location: >-
                        http://localhost:9900/scim/v2/Users/eb48a32d-2fe6-48d1-8a18-797919f3810a
                    userName: Amy+555
                    name:
                      formatted: Amy Lawrence
                      familyName: Amy
                      givenName: Lawrence
                    displayName: Amy Lawrence
                    preferredLanguage: en
                    locale: en-US
                    active: true
                    emails:
                      - value: asmurugesan+555@zuora.com
                        display: asmurugesan+555@zuora.com
                        type: work
                        primary: true
                    groups:
                      - value: 7f5c248e-44e8-48d3-bacc-b5bd1253c2e4
                        display: ''
                    roles:
                      - value: USER
                        display: USER
                    urn:zuora:scim:schemas:1.0:UserExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId: rc141dc2-901e-4813-a25d-ef480cff1e26
                      status: ACTIVE
                      ssoEnabled: false
                      region: EU
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                UnauthorizedError:
                  summary: Unauthorized example response
                  value:
                    success: false
                    reasons:
                      - message: Unauthorized
                        code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              examples:
                ForbiddenError:
                  summary: Forbidden example response
                  value:
                    timestamp: '2023-07-28T10:47:07.931+00:00'
                    status: 403
                    error: Forbidden
                    message: Admin access denied
                    path: /scim/v2/Users/00000000-0000-0000-000000000000
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                NotFoundError:
                  summary: Not Found example response
                  value:
                    schemas:
                      - urn:ietf:params:scim:api:messages:2.0:Error
                    status: '404'
                    detail: Resource not found
    put:
      tags:
        - SCIM
      summary: Update a user
      description: >
        Updates an existing user resource, overwriting all values for a user
        even if an attribute is empty or not provided.

        If an attribute that had been set previously is left blank during a PUT
        operation, the new value will be blank in accordance with the data type
        of the attribute and the storage provider.

        Deactivated users can be re-enabled by setting the active attribute to
        true. The value of the <id> should be the user's corresponding user ID.
      operationId: updateASpecificUser
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the user to be updated.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                id:
                  type: string
                  nullable: true
                externalId:
                  type: string
                meta:
                  type: object
                  properties:
                    created:
                      type: string
                      format: date-time
                    resourceType:
                      type: string
                    location:
                      type: string
                userName:
                  type: string
                name:
                  type: object
                  properties:
                    formatted:
                      type: string
                    familyName:
                      type: string
                    givenName:
                      type: string
                displayName:
                  type: string
                preferredLanguage:
                  type: string
                locale:
                  type: string
                active:
                  type: boolean
                emails:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                groups:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                      display:
                        type: string
                roles:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                      display:
                        type: string
                urn:zuora:scim:schemas:1.0:UserExtension:
                  type: object
                  properties:
                    schemas:
                      type: array
                      items:
                        type: string
                    organizationId:
                      type: string
                    status:
                      type: string
                    ssoEnabled:
                      type: boolean
                    region:
                      type: string
            example:
              schemas:
                - urn:zuora:scim:schemas:1.0:UserExtension
                - urn:ietf:params:scim:schemas:core:2.0:User
              id: 4ae68f98-2762-4001-b95c-34569b413e8e
              externalId: Amy+test5
              meta:
                created: '2023-01-04T18:48:30.180Z'
                resourceType: User
                location: >-
                  http://localhost:9900/scim/v2/Users/4ae68f98-2762-4001-b95c-34569b413e8e
              userName: Amy+test6
              name:
                formatted: Amy Lawrence
                familyName: Amy
                givenName: Lawrence
              displayName: Amy Lawrence
              preferredLanguage: en
              locale: en-US
              active: true
              emails:
                - value: Amy+test5-updated@zuora.com
              groups:
                - value: 0fb99576-2154-4d96-a6cb-384dd430f45f
                  display: Amy Test
              roles:
                - value: USER
                  display: USER
              urn:zuora:scim:schemas:1.0:UserExtension:
                schemas:
                  - urn:zuora:scim:schemas:1.0:UserExtension
                organizationId: ec141dc2-901e-4813-a25d-ef480cff1e26
                status: ACTIVE
                ssoEnabled: true
                region: EU
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique identifier for the user resource.
                  userName:
                    type: string
                    description: The user’s unique username.
                  displayName:
                    type: string
                    description: >-
                      The display name of the user, typically used in user
                      interfaces.
                  active:
                    type: boolean
                    description: Indicates whether the user account is currently active.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The email address of the user.
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this email address is the primary
                            email for the user.
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                        description: The type of resource, e.g., 'User'.
                      created:
                        type: string
                        format: date-time
                        description: The date and time when the user resource was created.
                      lastModified:
                        type: string
                        format: date-time
                        description: >-
                          The date and time when the user resource was last
                          modified.
              example:
                id: '123456'
                userName: johndoe
                displayName: John Doe
                active: true
                emails:
                  - value: johndoe@example.com
                    primary: true
                meta:
                  resourceType: User
                  created: '2023-01-01T12:00:00Z'
                  lastModified: '2023-01-01T12:00:00Z'
                schemas:
                  - urn:zuora:scim:schemas:1.0:UserExtension
                  - urn:ietf:params:scim:schemas:core:2.0:User
                totalResults: 1
                resources:
                  - schemas:
                      - urn:zuora:scim:schemas:1.0:UserExtension
                      - urn:ietf:params:scim:schemas:core:2.0:User
                    id: 4ae68f98-2762-4001-b95c-34569b413e8e
                    externalId: Amy+test6
                    meta:
                      created: '2024-10-03T10:22:09.727Z'
                      resourceType: User
                      location: >-
                        http://localhost:9900/scim/v2/Users/4ae68f98-2762-4001-b95c-34569b413e8e
                    userName: assingh151@zuora.com
                    name:
                      formatted: Amy Lawrence
                      familyName: Amy
                      givenName: Lawrence
                    displayName: Amy Lawrence
                    preferredLanguage: en
                    locale: en-US
                    active: true
                    emails:
                      - value: Amy+test5-updated@zuora.com
                        display: Amy+test5-updated@zuora.com
                        type: work
                        primary: true
                    roles:
                      - value: USER
                        display: USER
                    urn:zuora:scim:schemas:1.0:UserExtension:
                      schemas:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                      organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                      status: ACTIVE
                      ssoEnabled: true
                      region: EU
                startIndex: 1
                itemsPerPage: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              example:
                timestamp: '2023-07-28T10:47:07.931+00:00'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Users/00000000-0000-0000-000000000000
        '404':
          description: Not Found
          content:
            application/json:
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:Error
                status: '404'
                detail: Resource not found
    delete:
      tags:
        - SCIM
      summary: Delete a user
      description: |
        Deactivates a specific user identified by the user ID.
      operationId: deleteASpecificUser
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the user to delete.
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
          description: Unique key used to ensure idempotent behavior.
        - name: Accept-Encoding
          in: header
          required: false
          schema:
            type: string
          description: >
            Indicates the response's preferred content encoding. Supported
            values are `gzip` and `identity`.
        - name: Content-Encoding
          in: header
          required: false
          schema:
            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.
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              schema:
                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.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
            RateLimit-Limit:
              schema:
                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:
              schema:
                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:
              schema:
                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:
              schema:
                type: string
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
            Zuora-Track-Id:
              schema:
                type: string
              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.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique identifier for the user resource.
                  userName:
                    type: string
                    description: The unique username of the user.
                  displayName:
                    type: string
                    description: >-
                      The display name of the user, used for user interfaces and
                      profile views.
                  active:
                    type: boolean
                    description: >-
                      Indicates whether the user account is active (true) or
                      inactive (false).
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The email address associated with the user.
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this email address is the primary
                            one for the user.
                  meta:
                    type: object
                    properties:
                      resourceType:
                        type: string
                        description: The type of the resource, e.g., 'User'.
                      created:
                        type: string
                        format: date-time
                        description: The date and time when the user resource was created.
                      lastModified:
                        type: string
                        format: date-time
                        description: >-
                          The date and time when the user resource was last
                          modified.
              example:
                id: '123456'
                userName: johndoe
                displayName: John Doe
                active: true
                emails:
                  - value: johndoe@example.com
                    primary: true
                meta:
                  resourceType: User
                  created: '2023-01-01T12:00:00Z'
                  lastModified: '2023-01-01T12:00:00Z'
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
              example:
                message: User successfully deleted.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful. For a 401
                      Unauthorized response, this will be false.
                    example: false
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A message describing the reason for the
                            authorization failure.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            An application-specific error code indicating the
                            nature of the authorization issue.
                          example: '90000011'
              example:
                success: false
                reasons:
                  - message: Unauthorized
                    code: '90000011'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: >-
                      The date and time when the error occurred, in ISO 8601
                      format.
                    example: '2023-07-28T10:47:07.931Z'
                  status:
                    type: integer
                    description: >-
                      The HTTP status code for the response. For a 403 Forbidden
                      response, this will be 403.
                    example: 403
                  error:
                    type: string
                    description: A short, general description of the error.
                    example: Forbidden
                  message:
                    type: string
                    description: >-
                      A detailed message explaining why access is forbidden,
                      such as lack of permissions.
                    example: Admin access denied
                  path:
                    type: string
                    description: The request path that triggered the error.
                    example: /scim/v2/Users/123
              example:
                timestamp: '2023-07-28T10:47:07.931Z'
                status: 403
                error: Forbidden
                message: Admin access denied
                path: /scim/v2/Users/123
    patch:
      tags:
        - SCIM
      summary: Partially update a user
      description: >
        Updates an existing user resource, overwriting values for specified
        attributes.

        The value of the {id} should be the user's corresponding user ID.
        Attributes that are not provided in the request will remain unchanged.
        Updating a value to " " will clear and remove the field from the user's
        profile.
      operationId: partialUpdateASpecificUser
      parameters:
        - name: id
          in: path
          required: true
          description: User ID to update
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                schemas:
                  type: array
                  items:
                    type: string
                    enum:
                      - urn:ietf:params:scim:api:messages:2.0:PatchOp
                Operations:
                  type: array
                  items:
                    type: object
                    properties:
                      op:
                        type: string
                        enum:
                          - replace
                          - add
                          - remove
                          - copy
                          - move
                          - test
                      path:
                        type: string
                      value:
                        type: object
                        properties:
                          emails:
                            type: array
                            items:
                              type: object
                              properties:
                                value:
                                  type: string
                                  format: email
                                display:
                                  type: string
                                type:
                                  type: string
                                  enum:
                                    - work
                                    - home
                                    - other
                                primary:
                                  type: boolean
              required:
                - schemas
                - Operations
              example:
                schemas:
                  - urn:ietf:params:scim:api:messages:2.0:PatchOp
                Operations:
                  - op: replace
                    path: /emails
                    value:
                      emails:
                        - value: updatedEmail@zuora.com
                          display: updatedEmail@zuora.com
                          type: home
                          primary: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: string
                      enum:
                        - urn:zuora:scim:schemas:1.0:UserExtension
                        - urn:ietf:params:scim:schemas:core:2.0:User
                    description: >-
                      A list of schema URNs that are applicable to the user
                      resource. This helps to identify the structure and format
                      of the returned data.
                  id:
                    type: string
                    description: The unique identifier for the user resource.
                  meta:
                    type: object
                    properties:
                      created:
                        type: string
                        format: date-time
                        description: >-
                          The timestamp when the user resource was created, in
                          ISO 8601 format.
                      resourceType:
                        type: string
                        description: >-
                          The type of the resource, in this case, it is always
                          'User' for user resources.
                      location:
                        type: string
                        description: >-
                          The URL where the full representation of the user
                          resource can be retrieved.
                  userName:
                    type: string
                    description: >-
                      The username for the user. This is a unique identifier for
                      the user in the system.
                  name:
                    type: object
                    properties:
                      formatted:
                        type: string
                        description: >-
                          The full name of the user formatted as a single string
                          (e.g., 'John Doe').
                      familyName:
                        type: string
                        description: The family name (or surname) of the user.
                      givenName:
                        type: string
                        description: The given name (or first name) of the user.
                  displayName:
                    type: string
                    description: The display name of the user, which may be used in UIs.
                  preferredLanguage:
                    type: string
                    description: The preferred language of the user for communication.
                  locale:
                    type: string
                    description: >-
                      The locale of the user, typically a language code combined
                      with a region (e.g., 'en-US').
                  active:
                    type: boolean
                    description: Indicates whether the user account is active or not.
                  emails:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The email address of the user.
                        display:
                          type: string
                          description: >-
                            A display name for the email address, typically the
                            same as the email value.
                        type:
                          type: string
                          description: >-
                            The type of the email address (e.g., 'work',
                            'home').
                        primary:
                          type: boolean
                          description: >-
                            Indicates whether this email address is the primary
                            address for the user.
                  groups:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: >-
                            The unique identifier for the group the user belongs
                            to.
                        display:
                          type: string
                          description: The display name of the group.
                  roles:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          description: The role assigned to the user.
                        display:
                          type: string
                          description: A display name for the role.
                  urn:zuora:scim:schemas:1.0:UserExtension:
                    type: object
                    properties:
                      schemas:
                        type: array
                        items:
                          type: string
                          enum:
                            - urn:zuora:scim:schemas:1.0:UserExtension
                        description: >-
                          A list of schema URNs that are specific to Zuora's
                          extended user schema.
                      organizationId:
                        type: string
                        description: >-
                          The unique identifier for the organization to which
                          the user belongs.
                      status:
                        type: string
                        description: >-
                          The current status of the user (e.g., ACTIVE,
                          INACTIVE).
                      ssoEnabled:
                        type: boolean
                        description: >-
                          Indicates whether Single Sign-On (SSO) is enabled for
                          this user.
                      region:
                        type: string
              example:
                schemas:
                  - urn:zuora:scim:schemas:1.0:UserExtension
                  - urn:ietf:params:scim:schemas:core:2.0:User
                id: 4ae68f98-2762-4001-b95c-34569b413e8e
                externalId: assingh151@zuora.com
                meta:
                  created: '2024-10-03T10:22:09.727Z'
                  resourceType: User
                  location: >-
                    http://localhost:9900/scim/v2/Users/4ae68f98-2762-4001-b95c-34569b413e8e/4ae68f98-2762-4001-b95c-34569b413e8e
                userName: assingh151@zuora.com
                name:
                  formatted: Amy Lawrence
                  familyName: Amy
                  givenName: Lawrence
                displayName: Amy Lawrence
                preferredLanguage: en
                locale: en-US
                active: true
                emails:
                  - value: updatedEmail@zuora.com
                    display: updatedEmail@zuora.com
                    type: work
                    primary: true
                roles:
                  - value: USER
                    display: USER
                urn:zuora:scim:schemas:1.0:UserExtension:
                  schemas:
                    - urn:zuora:scim:schemas:1.0:UserExtension
                  organizationId: 5619df2e-fa8c-47fa-9c1e-16ab5af4936e
                  status: ACTIVE
                  ssoEnabled: true
                  region: EU
        '204':
          description: No Content
        '401':
          description: Unauthorized - The request lacks valid authentication credentials.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Indicates whether the request was successful. For
                      unauthorized responses, this is always false.
                    example: false
                  reasons:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          description: >-
                            A human-readable message explaining the reason for
                            the unauthorized response.
                          example: Unauthorized
                        code:
                          type: string
                          description: >-
                            A specific error code associated with the
                            unauthorized response. This code can be used for
                            programmatic handling of the error.
                          example: '90000011'
                example:
                  success: false
                  reasons:
                    - message: Unauthorized
                      code: '90000011'
        '403':
          description: >-
            Forbidden - The server understands the request but refuses to
            authorize it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    description: >-
                      The date and time when the error occurred, in ISO 8601
                      format.
                    example: '2023-07-28T10:47:07.931+00:00'
                  status:
                    type: integer
                    description: >-
                      The HTTP status code of the response, which is 403 for
                      forbidden errors.
                    example: 403
                  error:
                    type: string
                    description: >-
                      A short description of the error type. For forbidden
                      errors, this is always 'Forbidden'.
                    example: Forbidden
                  message:
                    type: string
                    description: >-
                      A detailed message explaining why the request was
                      forbidden. This might include additional context about
                      access control issues.
                    example: Admin access denied
                  path:
                    type: string
                    description: >-
                      The path of the request that resulted in the error. This
                      helps identify which resource or endpoint was being
                      accessed when the error occurred.
                    example: /scim/v2/Users/00000000-0000-0000-0000-000000000000
                example:
                  timestamp: '2023-07-28T10:47:07.931+00:00'
                  status: 403
                  error: Forbidden
                  message: Admin access denied
                  path: /scim/v2/Users/00000000-0000-0000-0000-000000000000
  /objects/definitions/default:
    post:
      description: "You can post custom object definitions with the request body schema described below. \n\nThis operation also allows you to use the [List custom object definitions](https://developer.zuora.com/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace) response schema as its request schema. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can make a [List custom object definitions](https://developer.zuora.com/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace) call in your old tenant and then use its response directly as the request of this operation in the new tenant to import all the custom objects from the old tenant.\n\nThe `label` field is the UI label of the custom object. The `object` field contains the API Name of the custom object.\n\n### Limitations \n\nThis custom object definition has the following limitations:\n\n* The maximum number of characters for the Custom Object API Name (`object`) is 64.\n* The maximum number of characters for the Custom Object Label (`label`) is\t64.\n* The maximum number of characters for the Custom Object Description 250.\n* The maximum number of custom fields in an custom object\tis 50.\n* The maximum number of characters for the custom field API name is\t64.\n* The maximum number of characters for the custom field label (`label`) is\t64.\n* The maximum number of characters for the custom field Description\tis 250.\n* The maximum number of picklist or multiselect options is 250.\n* The maximum length of characters for the Text field is 255.\n* The maximum length of characters for the Long Text field is from 256 to 8,192.\n* The maximum number of digits to the left of the decimal point for the Number field is 13, and to the right is 9.\n"
      operationId: POST_CustomObjectDefinitions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCustomObjectDefinitionsRequest'
        description: The custom object definitions to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create custom object definitions
      tags:
        - Custom Object Definitions
    get:
      description: >
        Get all custom objects definitions for a given tenant. If you want to
        copy all the existing custom objects from an old tenant to a new tenant,
        you can call this operation in your old tenant and then use its response
        directly as the request of the [Create custom object
        definitions](https://developer.zuora.com/api-references/api/operation/POST_CustomObjectDefinitions)
        call in the new tenant to import all the custom objects from the old
        tenant.
      operationId: GET_AllCustomObjectDefinitionsInNamespace
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >
            If you set `select` to `type`, the response will only contain the
            `type` of each custom object.
          in: query
          name: select
          required: false
          schema:
            enum:
              - type
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List custom object definitions
      tags:
        - Custom Object Definitions
  /objects/migrations:
    post:
      description: >
        Updates a custom object definition by posting migration resource to
        initiate the migration of definitions.


        ### Limitations


        Updating custom field definition has the following limitations:
          
        * You can only have one action per update request.

        * You cannot delete fields from custom objects that contain records.

        * You can only add required fields to custom objects with no records.

        * You can change optional fields to required only on the custom objects
        with no records.


        ### Note


        The bulk deletion of custom fields on standard and custom objects is
        temporarily unavailable as we refine the Custom Field feature.


        You can still delete custom fields individually during this refinement
        process. If you want to delete multiple custom fields, ensure that you
        send each deletion request only after receiving the response for the
        previous request.


        The bulk deletion capability will be restored once the refinement is
        complete.
      operationId: POST_UpdateCustomObjectDefinition
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/MigrationUpdateCustomObjectDefinitionsRequest
        description: Migration resource for object and namespace changes.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/MigrationUpdateCustomObjectDefinitionsResponse
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a custom object definition
      tags:
        - Custom Object Definitions
  /objects/definitions/default/{object}:
    get:
      description: |
        Retrieves the custom object definition by type for the given tenant.
      operationId: GET_CustomObjectDefinitionByType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectDefinition'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Resource Request-URI not found.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a custom object definition
      tags:
        - Custom Object Definitions
    delete:
      description: >
        Deletes the custom object definition for the provided type.


        **Note:** A custom object definition can only be deleted if no record of
        this custom object type exists.
      operationId: Delete_CustomObjectDefinitionByType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                description: The URI of the deleted custom object definition
                example: /objects/definitions/default/test_custom_object
                format: uri
                type: string
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a custom object definition
      tags:
        - Custom Object Definitions
  /objects/records/default/{object}:
    post:
      description: >
        Creates custom object records with the given type.


        Upon creating records of a custom object type, the 200 response contains
        a list of records that have been successfully processed and stored.


        ### Limitations


        This call has the following limitations:
          
        * The maximum number of records that you can create by one call is
        1,000.

        * The storage of empty strings in records is not supported.

        * Null values must be formatted as the following example:
          ```
          {
            "records": [
              {
                "fieldName__c": null
              }
            ]
          }
          ```
        * When creating or updating custom object records with relationship-type
        fields, Zuora verifies the related objects against the transactional
        databases, which are updated in near real-time. The record creation or
        modification fails upon unsuccessful verifications. <br />If the related
        objects are newly created in your tenant, it might need some time for
        the transactional database synchronization.
      operationId: POST_CustomObjectRecords
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              Partial success turned off:
                value:
                  records:
                    - DeviceId__c: '10101010'
                      OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d
              Partial success turned on:
                value:
                  allowPartialSuccess: true
                  records:
                    - DeviceId__c: '10101010'
                      OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d
                    - DeviceId__c: '10101011'
                      OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d
            schema:
              $ref: '#/components/schemas/PostCustomObjectRecordsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                Partial success turned off:
                  value:
                    records:
                      - Id: 9ef0b1a0-e398-46aa-856f-76273b0d2988
                        type: Vehicle
                        DeviceId__c: '10101010'
                        OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d
                        CreatedById: 8ad084a67f9c7138017fab8a8b511b5a
                        UpdatedById: 8ad084a67f9c7138017fab8a8b511b5a
                        CreatedDate: '2024-07-09T06:41:17.377Z'
                        UpdatedDate: '2024-07-09T06:41:17.377Z'
                    unprocessedRecords: []
                Partial success turned on:
                  value:
                    error:
                      code: 71012520
                      message: >-
                        Request contains invalid record that failed validation
                        against the object schema.
                      details:
                        - code: 71012526
                          message: >-
                            Json input does not match schema. Error: Field
                            [DeviceId__c] should be string type but received
                            integer.
                          record:
                            Id: 6d96fbde-213c-43c3-bbef-9b777b050a94
                            DeviceId__c: '10101011'
                            OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d
                    records:
                      - Id: 9ef0b1a0-e398-46aa-856f-76273b0d2988
                        type: Vehicle
                        DeviceId__c: '10101010'
                        OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d
                        CreatedById: 8ad084a67f9c7138017fab8a8b511b5a
                        UpdatedById: 8ad084a67f9c7138017fab8a8b511b5a
                        CreatedDate: '2024-07-09T06:41:17.377Z'
                        UpdatedDate: '2024-07-09T06:41:17.377Z'
                    unprocessedRecords: []
              schema:
                $ref: '#/components/schemas/PostCustomObjectRecordsResponse'
          description: >
            OK


            The 200 response indicates that the records have been partially or
            completely created.


            * If the `allowPartialSuccess` flag is set to `false`, the 200
            response indicates that all object records have been successfully
            created.

            * If the `allowPartialSuccess` flag is set to `true`, the 200
            response indicates that some records might not be succesffully
            created and the error information might be contained in the response
            body.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordsErrorResponse'
          description: Failed schema validation
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse401Record'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordsThrottledResponse'
          description: Internal error. Retry the returned records.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create custom object records
      tags:
        - Custom Object Records
    get:
      description: >
        Lists all object records of the given type. You can also use the `q`
        query parameter to filter the output records.



        ### Custom Objects read consistency


        Custom Objects support eventually consistency. When you read custom
        object records, the response might not reflect the result of a recently
        completed operation and might include some stale data. The operations
        include creating, updating, and deleting custom object records.  If you
        repeat your read request after a short time, the response should return
        the latest data.


        For example, if you create five records and perform a query that these
        five records satisfy the query conditions, there might be a delay before
        these records can be returned in the query result.
      operationId: GET_AllRecordsForCustomObjectType
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
        - description: >
            The query string to filter the records of a custom object. See <a
            href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-object-record-management/query-syntax-of-custom-object-records"
            target="_blank">Query syntax of custom object records</a> for more
            information.


            Note that the `q` parameter only applies to filterable fields.
          in: query
          name: q
          required: false
          schema:
            type: string
        - description: >
            UUIDs of the records to be queried. Each UUID must be a string of 36
            characters. For example:


            `GET
            /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1`
          in: query
          name: ids
          required: false
          schema:
            type: string
        - description: The number of records returned per page in the response.
          in: query
          name: pageSize
          required: false
          schema:
            maximum: 1000
            minimum: 1
            type: integer
        - description: >-
            The `cursor` points to the last record of the previous result set.
            The cursor record is not included in the query result. The call
            returns the first page if `cursor` is not provided and `pageSize` is
            valid.
          in: query
          name: cursor
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCustomObjectRecordsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List records for a custom object
      tags:
        - Custom Object Records
  /objects/records/default/{object}/{id}:
    get:
      description: |
        Retrieves a record of a given type by ID.
      operationId: GET_CustomObjectRecordByID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
        - description: Id identifier in uuid form
          in: path
          name: id
          required: true
          schema:
            format: uuid
            maxLength: 36
            minLength: 36
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordWithAllFields'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Not exist
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a custom object record
      tags:
        - Custom Object Records
    put:
      description: >
        Updates a record of the given type and ID.


        ### Limitations


        * The storage of empty strings in records is not supported.

        * Null values must be formatted as the following example:
          ```
          {
            "records": [
              {
                "fieldName__c": null
              }
            ]
          }
          ```
        * When creating or updating custom object records with relationship-type
        fields, Zuora verifies the related objects against the transactional
        databases, which are updated in near real-time. The record creation or
        modification fails upon unsuccessful verifications. <br />If the related
        objects are newly created in your tenant, it might need some time for
        the transactional database synchronization.
      operationId: PUT_CustomObjectRecord
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_If_Match'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
        - description: Id identifier in uuid form
          in: path
          name: id
          required: true
          schema:
            format: uuid
            maxLength: 36
            minLength: 36
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordWithAllFields'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Object record does not exist
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a custom object record
      tags:
        - Custom Object Records
    patch:
      description: >
        Updates one or many fields of a custom object record. Patch update uses
        JSON Merge Patch as specified in [RFC
        7386](https://tools.ietf.org/html/rfc7386).


        ### Limitations


        * The storage of empty strings in records is not supported.

        * Null values must be formatted as the following example:
          ```
          {
            "records": [
              {
                "fieldName__c": null
              }
            ]
          }
          ```
        * When creating or updating custom object records with relationship-type
        fields, Zuora verifies the related objects against the transactional
        databases, which are updated in near real-time. The record creation or
        modification fails upon unsuccessful verifications. <br />If the related
        objects are newly created in your tenant, it might need some time for
        the transactional database synchronization.
      operationId: Patch_PartialUpdateCustomObjectRecord
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
        - description: Id identifier in uuid form
          in: path
          name: id
          required: true
          schema:
            format: uuid
            maxLength: 36
            minLength: 36
            type: string
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordWithAllFields'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Object record does not exist
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Partially update a custom object record
      tags:
        - Custom Object Records
    delete:
      description: "Deletes a custom object record of the given type and ID.\n\nNote that 200 response will be returned under either of the following conditions:\n* The record is identified and successfully deleted\n* The record could not be found\n\nNote that\_the record is deleted immediately and, therefore, will not be retained upon successful deletion.\n"
      operationId: Delete_CustomObjectRecordByID
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
        - description: Id identifier in uuid form
          in: path
          name: id
          required: true
          schema:
            format: uuid
            maxLength: 36
            minLength: 36
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                description: The URI of the deleted custom object record.
                example: >-
                  /objects/records/default/test_custom_object/3a437f0b-fa7a-45bf-a9a5-2187a5a13ec0
                format: uri
                type: string
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a custom object record
      tags:
        - Custom Object Records
  /objects/batch/default/{object}:
    post:
      description: >
        Makes a batch update or delete of custom object records.


        ### Limitations


        This call has the following limitations:


        * The maximum number of records that you can update by one call is
        1,000.

        * The maximum number of records that you can delete by one call is
        1,000.

        * The storage of empty strings in records is not supported.

        * Null values must be formatted as the following example:
          ```
          {
            "action": {
              "type": "update",
              "records": {
                "64edb2a5-2796-4e95-9559-846f8636a01b": {
                  "fieldName__c": null
                }
              }
            }
          }
          ```
        * When creating or updating custom object records with relationship-type
        fields, Zuora verifies the related objects against the transactional
        databases, which are updated in near real-time. The record creation or
        modification fails upon unsuccessful verifications. <br />If the related
        objects are newly created in your tenant, it might need some time for
        the transactional database synchronization.
      operationId: POST_CustomObjectRecordsBatchUpdateOrDelete
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: >-
            Specifies the custom object's API name as object. It is
            case-sensitive.
          in: path
          name: object
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectRecordBatchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse
          description: >
            OK


            For the bacth `delete` action, it indicates the batch records have
            been successfully deleted.


            For the batch `update` action, it indicates that the batch records
            have been partially or completely updated.


            * If the `allowPartialSuccess` flag is set to `false`, the 200
            response indicates that all object records have been successfully
            updated.

            * If the `allowPartialSuccess` flag is set to `true`, the 200
            response indicates that some records might not be succesffully
            updated and the error information might be contained in the response
            body.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordsErrorResponse'
          description: >
            Failed schema validation


            For the batch `update` action, the 400 response only returns when
            the `allowPartialSuccess` flag is set to `false` and the batch
            records have failed schema validation.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse401Record'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectRecordsThrottledResponse'
          description: Internal error. Retry the returned records.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update or delete custom object records
      tags:
        - Custom Object Records
  /objects/jobs:
    post:
      description: >
        Submits a bulk job request for a bulk operation on the specified custom
        object records. A succcessful call returns a newly created bulk job. The
        job ID can be used to poll the job status or upload the CSV file if it
        is a `create` or `update` job.


        ### Limits

        This custom object bulk jobs have the following limits:

        * The concurrent bulk job limit per tenant is 5. Bulk jobs in
        `accepted`, `pending`, or `in_progress` status are counted towards the
        concurrent bulk job limit.

        * The bulk job execuation order is not guaranteed, which means the bulk
        job that you submit ealier may be executed later.  

        * Only the users that have the "Delete Custom Objects" permission can
        create a `delete` bulk job. Only the users that have the "Edit Custom
        Objects" permission can create a `create` or `update` bulk job. See
        [Platform
        Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions)
        for more information.
      operationId: POST_CustomObjectBulkJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomObjectBulkJobRequest'
        description: Custom Objects bulk job request
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectBulkJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71013020
                    message: Bad Request
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '403':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71012514
                    message: User does not have permission to delete custom objects.
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Submit a custom object bulk job
      tags:
        - Custom Object Jobs
    get:
      description: |
        Lists all custom object bulk jobs submitted by your tenant.
      operationId: GET_AllCustomObjectBulkJobs
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: The number of records returned per page in the response.
          in: query
          name: pageSize
          required: false
          schema:
            default: 25
            maximum: 100
            type: integer
        - description: >-
            The `cursor` points to the last job of the previous result set. The
            cursor job is not included in this query result. The call returns
            the first page if `cursor` is not provided and `pageSize` is valid.
          in: query
          name: cursor
          required: false
          schema:
            type: string
        - description: The status of bulk jobs to be retrieved.
          in: query
          name: status
          required: false
          schema:
            enum:
              - pending
              - accepted
              - in_progress
              - completed
              - failed
              - cancelled
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectBulkJobResponseCollection'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all custom object bulk jobs
      tags:
        - Custom Object Jobs
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X GET -H "Authorization: Bearer
            e5cb941a9b1f47838b4085b4d5e00415" -H "Content-Type:
            application/json"
            "https://rest.zuora.com/objects/jobs?pageSize=2&cursor=a9e9a58d-0a11-4685-b1ab-99521dbc20a1"
  /objects/jobs/{id}:
    get:
      description: >
        Retrieves the custom object bulk job details by job ID.


        Only the users that have the "View Custom Objects" permission can
        retrieve custom object bulk jobs. See [Platform
        Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions)
        for more information.
      operationId: GET_CustomObjectBulkJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: The ID of the custom object bulk job to be retrieved.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomObjectBulkJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71013040
                    message: Not Found.
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Bulk job not found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a custom object bulk job
      tags:
        - Custom Object Jobs
  /objects/jobs/{id}/files:
    post:
      description: >
        Uploads a `.csv` file for a custom object bulk job to create or update
        custom object records. The job must be in `pending` status. Only one
        file is allowed per job. Each file supports only one type of operation,
        with an `id` column required for update operations. The job will start
        once the upload is finished.


        Only the users that have the "Edit Custom Objects" permission can upload
        files to custom object bulk jobs. See [Platform
        Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions)
        for more information.
      operationId: POST_UploadFileForCustomObjectBulkJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: The `Content-Type` of the request must be `text/csv`.
          in: header
          name: Content-Type
          required: true
          schema:
            type: string
        - description: The ID of the custom object bulk job that the file is uploaded to.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          text/csv:
            schema:
              description: >-
                The CSV file to be uploaded. The file must be encoded in UTF-8
                and the file size limit is 15 MB.
              type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    CreatedById: 2c92c0f96a07409d016a0a58ab1172ec
                    CreatedDate: '2021-03-10T00:05:54.207Z'
                    Id: 5112347a-f7a1-4373-99df-c082984de7be
                    UpdatedById: 2c92c0f96a07409d016a0a58ab1172ec
                    UpdatedDate: '2021-03-10T00:08:15.539Z'
                    namespace: default
                    object: vehicle
                    operation: create
                    processingTime: 0
                    recordsProcessed: 0
                    status: in_progress
              schema:
                $ref: '#/components/schemas/CustomObjectBulkJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71013620
                    message: Bad Request
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '403':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71012515
                    message: User does not have permission to create custom objects.
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71013040
                    message: Not Found.
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Job not found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Upload a file for a custom object bulk job
      tags:
        - Custom Object Jobs
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            e5cb941a9b1f47838b4085b4d5e00415" -H "Content-Type: text/csv"
            --data-binary "@CustomObjectRecords.csv"
            "https://rest.zuora.com/objects/jobs/5112347a-f7a1-4373-99df-c082984de7be/files"
  /objects/jobs/{id}/errors:
    get:
      description: |
        Lists all errors for a custom object bulk job.
      operationId: GET_CustomObjectBulkJobErrors
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: The ID of the custom object bulk job that you retrieve errors for.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CustomObjectBulkJobErrorResponseCollection
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71013040
                    message: Not Found.
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Job not found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all errors for a custom object bulk job
      tags:
        - Custom Object Jobs
  /objects/jobs/{id}/cancel:
    patch:
      description: >
        Cancel a custom object bulk job. Note that you can cancel a custom
        object bulk job only if the job status is `accepted` or `pending`.
      operationId: PATCH_CustomObjectBulkJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            API version that determines the response schema. The default version
            is used if this parameter is not included. Specify `Zuora-Version`
            in the request header if you expect a specific response schema.
          in: header
          name: Zuora-Version
          required: false
          schema:
            format: date
            type: string
        - description: The ID of the custom object bulk job that you want to cancel.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    CreatedById: 11e64eef-ada8-786d-9658-00259058c29c
                    CreatedDate: '2022-12-01T21:24:04.337Z'
                    Id: 7f19b861-5ec7-479b-935c-fcfbd6477655
                    UpdatedById: 0fdfc048-0a9e-433f-ad23-d50e31448b2e
                    UpdatedDate: '2022-12-01T21:37:43.212Z'
                    namespace: default
                    object: jobtest
                    operation: create
                    processingTime: 0
                    recordsProcessed: 0
                    status: cancelled
              schema:
                $ref: '#/components/schemas/CustomObjectBulkJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71013620
                    message: Bad Request
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 71013040
                    message: >-
                      Job not found for id
                      '7006ce52-91c9-11ed-a1eb-0242ac120002'.
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Job not found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a custom object bulk job
      tags:
        - Custom Object Jobs
  /system-health/api-requests/volume-summary:
    get:
      description: >
        Returns volume summary of
        [API](https://knowledgecenter.zuora.com/Central_Platform/API) usage that
        generated by your Zuora tenant within a specified time range.


        You can filter the summary by API path name and http method.
      operationId: GET_SystemHealthApiVolumeSummary
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            Filters the volume summary by API path name.


            You can refer to the api listed in the [API System Health
            Dashboard](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard)
            for the path name. Example: `/v1/accounts/{account-key}`.
          in: query
          name: path
          required: false
          schema:
            type: string
        - description: |
            Filters the volume summary by http method. Example: `POST`.
          in: query
          name: httpMethod
          required: false
          schema:
            type: string
        - description: |
            Start time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - description: |
            End time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-29T09:07+0800`.
          in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - error: 0
                        httpMethod: DELETE
                        path: /notifications/notification-definitions
                        success: 10
                        total: 10
                      - error: 20
                        httpMethod: GET
                        path: /query/jobs/{job-id}
                        success: 10
                        total: 30
                      - ...
              schema:
                $ref: '#/components/schemas/GetApiVolumeSummaryResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    error: Bad Request
                    message: Timezone is different between 'startTime' and 'endTime'.
                    path: /system-health/api-requests/volume-summary
                    status: 400
                    timestamp: '2022-09-29T05:54:46.007+00:00'
              schema:
                $ref: '#/components/schemas/SystemHealthErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List API volume summary records
      tags:
        - API Health
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/api-requests/volume-summary?startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800' \ 
              -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'
  /system-health/api-requests/failures:
    get:
      description: >
        Returns failure records of API usage that are generated by your Zuora
        tenant within a specified time range.



        You can filter the failure records by one or multiple of the following
        fields:
          - API path name
          - HTTP method
          - Response code 
          - Request ID
          - Track ID
      operationId: getSystemHealthApiFailureRecords
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            Filters the volume summary by API path name.



            You can refer to the API listed in the [API System Health
            Dashboard](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard)

            for the path name.
          in: query
          name: path
          required: false
          example: /v1/accounts/{account-key}
          schema:
            type: string
        - description: |
            Filters the volume summary by http method.
          in: query
          name: httpMethod
          required: false
          example: POST
          schema:
            type: string
        - description: |
            Filters the volume summary by response code.
          in: query
          name: responseCode
          required: false
          example: INVALID_TYPE
          schema:
            type: string
        - description: |
            Filters the volume summary by request ID.
          in: query
          name: requestId
          required: false
          schema:
            type: string
        - description: |
            Filters the volume summary by track ID.
          in: query
          name: trackId
          required: false
          schema:
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: *operator* *field_name*.


            If you do not specify any sortable field, the response data is
            sorted by the `timerange` field in descending order.



            *operator* is used to mark the order of sequencing. The operator is
            optional. 

            If you only specify the sortable field without any operator, the
            response data is sorted in descending order by this field.  


            - The `-` operator indicates an ascending order.

            - The `+` operator indicates a descending order. 


            *field_name* indicates the name of a sortable field. 

            The supported sortable fields of this operation are as below:

            - `timerange`

            - `latency`

            - `http_method`

            - `http_status`

            - `api`
          in: query
          example: sort=+latency
          name: sort
          required: false
          schema:
            type: string
        - description: |
            Start time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ`.
          in: query
          name: startTime
          example: 2022-09-22T09:07+0800
          required: true
          schema:
            format: date-time
            type: string
        - description: |
            End time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ`
          in: query
          name: endTime
          required: true
          example: 2022-09-29T09:07+0800
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - tracing_identifier: null
                        latency: 104
                        ip: 52.36.201.144
                        response_body: '{"size":0,"records":[],"done":true}'
                        http_method: GET
                        request_body: ''
                        user_id: 2c92a0fd56368ec20156445b4a79554d
                        track_id: null
                        request_path: /v1/object/invoice/2c92c8fb7d37d586017d3c28f6925850
                        http_status: '404'
                        zuora_response_code: NOT_FOUND
                        api: /v1/object/invoice/{id}
                        request_id: 42a18d47-9759-447c-ad57-79aa633487c9
                        user_agent: Apache-HttpClient/4.5 (Java/1.8.0_342)
                        timestamp: '2025-01-19T06:43:51Z'
                        status: Error
                      - tracing_identifier: null
                        latency: 104
                        ip: 52.36.201.144
                        response_body: '{"size":0,"records":[],"done":true}'
                        http_method: GET
                        request_body: ''
                        user_id: 2c92a0fd56368ec20156445b4a79554d
                        track_id: null
                        request_path: /v1/object/invoice/2c92c8fb7d37d586017d3c28f6925850
                        http_status: '404'
                        zuora_response_code: NOT_FOUND
                        api: /v1/object/invoice/{id}
                        request_id: 42a18d47-9759-447c-ad57-79aa633487c9
                        user_agent: Apache-HttpClient/4.5 (Java/1.8.0_342)
                        timestamp: '2025-01-19T06:43:51Z'
                        status: Error
                    nextPage: >-
                      /system-health/api-requests/failures?startTime=2024-08-01T09:07+0800&endTime=2024-08-05T09:07+0800&limit=10&page=2
              schema:
                $ref: '#/components/schemas/GetApiFailureRecordResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    error: Bad Request
                    message: Timezone is different between 'startTime' and 'endTime'.
                    path: /system-health/api-requests/volume-summary
                    status: 400
                    timestamp: '2022-09-29T05:54:46.007+00:00'
              schema:
                $ref: '#/components/schemas/SystemHealthErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
      summary: List API failure records
      tags:
        - API Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: >-
            curl -i -X GET
            'https://rest.zuora.com/system-health/api-requests/failures?startTime=2024-09-22T09:07+0800&endTime=2024-09-23T09:07+0800&page=1&limit=10&sort=-timestamp'
            \

            -H 'Authorization: Bearer 2c129bd58623470a8a8b713d26477c97'
  /system-health/api-requests/details:
    get:
      description: >
        Returns records of API usage that are generated by your Zuora tenant
        within a specified time range.



        You can filter the records by one or multiple of the following fields:
          - API path name
          - HTTP method
          - Response code 
          - Request ID
          - Track ID
      operationId: getSystemHealthApiPerformanceRecords
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            Filters the volume summary by API path name.



            You can refer to the API listed in the [API System Health
            Dashboard](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard)

            for the path name.
          in: query
          name: path
          required: false
          example: /v1/accounts/{account-key}
          schema:
            type: string
        - description: |
            Filters the volume summary by http method.
          in: query
          name: httpMethod
          required: false
          example: POST
          schema:
            type: string
        - description: |
            Filters the volume summary by response code.
          in: query
          name: responseCode
          required: false
          example: INVALID_TYPE
          schema:
            type: string
        - description: |
            Filters the volume summary by request ID.
          in: query
          name: requestId
          required: false
          schema:
            type: string
        - description: |
            Filters the volume summary by track ID.
          in: query
          name: trackId
          required: false
          schema:
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: *operator* *field_name*.


            If you do not specify any sortable field, the response data is
            sorted by the `timerange` field in descending order.



            *operator* is used to mark the order of sequencing. The operator is
            optional. 

            If you only specify the sortable field without any operator, the
            response data is sorted in descending order by this field.  


            - The `-` operator indicates an ascending order.

            - The `+` operator indicates a descending order. 


            *field_name* indicates the name of a sortable field. 

            The supported sortable fields of this operation are as below:

            - `timerange`

            - `latency`

            - `http_method`

            - `http_status`

            - `api`
          in: query
          example: sort=+latency
          name: sort
          required: false
          schema:
            type: string
        - description: |
            Start time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ`.
          in: query
          name: startTime
          example: 2022-09-22T09:07+0800
          required: true
          schema:
            format: date-time
            type: string
        - description: |
            End time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ`
          in: query
          name: endTime
          required: true
          example: 2022-09-29T09:07+0800
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - tracing_identifier: null
                        latency: 1913
                        ip: 52.0.173.190
                        response_body: >-
                          {"code":"REQUEST_EXCEEDED_LIMIT","message":"Your total
                          number of concurrent requests have exceeded the limit
                          allowed by the system. Please resubmit your request
                          later."}
                        http_method: POST
                        request_body: null
                        user_id: 4028e4883824800301382f1817921f3d
                        track_id: null
                        request_path: /apps/services/a/68.0
                        http_status: 429
                        zuora_response_code: TOO_MANY_REQUESTS
                        api: soap
                        request_id: 628fc2f4-8ab4-4e2d-bfd4-eb15fd4d2f52
                        user_agent: Axis2
                        timestamp: '2025-01-04T13:10:53Z'
                        status: Error
                      - tracing_identifier: null
                        latency: 50218
                        ip: 52.52.63.58
                        response_body: null
                        http_method: POST
                        request_body: null
                        user_id: 4028e4883824800301382f1817922f3d
                        track_id: null
                        request_path: soap:login
                        http_status: 200
                        zuora_response_code: Success
                        api: soap:login
                        request_id: 34f4ce61-67be-42f5-bee5-c2665a905dfa
                        user_agent: Axis2
                        timestamp: '2025-01-01T18:03:49Z'
                        status: Success
                    nextPage: >-
                      /system-health/api-requests/details?startTime=2024-08-01T09:07+0800&endTime=2024-08-05T09:07+0800&limit=10&page=2
              schema:
                $ref: '#/components/schemas/GetApiPerformanceDetailResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    error: Bad Request
                    message: Timezone is different between 'startTime' and 'endTime'.
                    path: /system-health/api-requests/volume-summary
                    status: 400
                    timestamp: '2022-09-29T05:54:46.007+00:00'
              schema:
                $ref: '#/components/schemas/SystemHealthErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
      summary: List API usage detail records
      tags:
        - API Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: >-
            curl -i -X GET
            'https://rest.zuora.com/system-health/api-requests/details?startTime=2024-09-22T09:07+0800&endTime=2024-09-23T09:07+0800&page=1&limit=10&sort=-timestamp'
            \

            -H 'Authorization: Bearer 2c129bd58623470a8a8b713d26477c97'
  /system-health/billing-documents/volume-summary:
    get:
      description: >
        Returns a summary of billing documents generated within a specified time
        range, including invoices and credit memos, and the total number of
        accounts that failed to process.
      operationId: GET_SystemHealthBillingDocVolumeSummary
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Start time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - description: |
            End time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - totalFailedAccounts: 10
                        totalGeneratedCreditMemos: 50
                        totalGeneratedInvoices: 100
              schema:
                $ref: '#/components/schemas/GetBillingDocVolumeSummaryResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    error: Bad Request
                    message: Timezone is different between 'startTime' and 'endTime'.
                    path: /system-health/billing-doc/volume-summary
                    status: 400
                    timestamp: '2022-09-29T05:54:46.007+00:00'
              schema:
                $ref: '#/components/schemas/SystemHealthErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List billing document volume summary records
      tags:
        - Bill Run Health
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/billing-documents/volume-summary?startTime=2022-09-22T09:07-0800&endTime=2022-09-24T09:07-0800' \ 
              -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'
  /system-health/payments/volume-summary:
    get:
      description: >
        Returns a summary of electronic payments handled by your Zuora tenant
        within a specified time range.


        You can filter the summary by payment gateway type and payment method
        type.
      operationId: GET_SystemHealthPaymentVolumeSummary
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            Filters the volume summary by payment gateway type. Example:
            `Adyen`.
          in: query
          name: paymentGatewayType
          required: false
          schema:
            type: string
        - description: >
            Filters the volume summary by payment method type. Example:
            `CreditCard`.
          in: query
          name: paymentMethodType
          required: false
          schema:
            type: string
        - description: |
            Start time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - description: |
            End time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - error: 80
                        paymentGatewayType: Sample
                        paymentMethodType: CreditCard
                        success: 20
                        total: 100
                      - error: 10
                        paymentGatewayType: Adyen
                        paymentMethodType: CreditCard
                        success: 190
                        total: 200
                      - ...
              schema:
                $ref: '#/components/schemas/GetPaymentVolumeSummaryResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    error: Bad Request
                    message: Timezone is different between 'startTime' and 'endTime'.
                    path: /system-health/payments/volume-summary
                    status: 400
                    timestamp: '2022-09-29T05:54:46.007+00:00'
              schema:
                $ref: '#/components/schemas/SystemHealthErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List payment volume summary records
      tags:
        - Electronic Payments Health
      x-code-samples:
        - label: Curl
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/payments/volume-summary?paymentGatewayType=string&paymentMethodType=string&startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800' \
              -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'
  /system-health/payments/details:
    get:
      description: >
        Returns System Health Electronic Payments records that are generated by
        your Zuora tenant within a specified time range.



        You can filter the failure records by one or multiple of the following
        fields:
          - payment gateway type
          - payment method type
          - payment status
          - payment gateway response code
          - currency
      operationId: getSystemHealthPaymentRecords
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: >
            Filters the volume summary by payment gateway type. Example:
            `Adyen`.
          in: query
          name: paymentGatewayType
          required: false
          schema:
            type: string
        - description: >
            Filters the volume summary by payment method type. Example:
            `CreditCard`.
          in: query
          name: paymentMethodType
          required: false
          schema:
            type: string
        - description: |
            Filters the volume summary by Payment Status. Example: `Error`.
          in: query
          name: paymentStatus
          required: false
          schema:
            type: string
        - description: >-
            Filters the volume summary by Payment Gateway Response Code.
            Example: `Declined`.
          in: query
          name: paymentGatewayResponseCode
          required: false
          schema:
            type: string
        - description: 'Filters the volume summary by currency. Example: `INR`.'
          in: query
          name: currency
          required: false
          schema:
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: *operator* *field_name*.


            If you do not specify any sortable field, the response data is
            sorted by the `timerange` field in descending order.



            *operator* is used to mark the order of sequencing. The operator is
            optional. 

            If you only specify the sortable field without any operator, the
            response data is sorted in descending order by this field.  


            - The `-` operator indicates an ascending order.

            - The `+` operator indicates a descending order. 


            *field_name* indicates the name of a sortable field. 

            The supported sortable fields of this operation are as below:

            - `timestamp`

            - `latency`

            - `status`

            - `http_method`
          in: query
          example: sort=-latency
          name: sort
          required: false
          schema:
            type: string
        - description: |
            Start time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - description: |
            End time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - payment_method_type: CreditCardReferenceTransaction
                        amount: 750000
                        payment_status: Error
                        source_type: PaymentRun
                        payment_gateway_response_code: '12'
                        payment_gateway_response_msg: Not enough balance
                        request_duration: 2094
                        payment_number: P-IDN-00077028
                        payment_id: 8a128a9c93d4070e0194339b8d8b300b
                        zuora_response_code: Declined
                        currency: Rupiah
                        source_id: PR-00151770
                        payment_gateway_type: Adyen
                        payment_date: '2025-01-05'
                      - payment_method_type: CreditCardReferenceTransaction
                        amount: 750000
                        payment_status: Error
                        source_type: PaymentRun
                        payment_gateway_response_code: '12'
                        payment_gateway_response_msg: Not enough balance
                        request_duration: 2094
                        payment_number: P-IDN-00077028
                        payment_id: 8a128a9c93d4070e0194339b8d8b300b
                        zuora_response_code: Declined
                        currency: Rupiah
                        source_id: PR-00151770
                        payment_gateway_type: Adyen
                        payment_date: '2025-01-05'
                    nextPage: >-
                      /system-health/payments/details?startTime=2025-01-01T09:07+0800&endTime=2025-01-30T09:07+0800&pageSize=1&sort=amount&page=4
              schema:
                $ref: '#/components/schemas/GetPaymentRecordsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    error: Bad Request
                    message: Timezone is different between 'startTime' and 'endTime'.
                    path: /system-health/payments/volume-summary
                    status: 400
                    timestamp: '2022-09-29T05:54:46.007+00:00'
              schema:
                $ref: '#/components/schemas/SystemHealthErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List payment system health records
      tags:
        - Electronic Payments Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: >-
            curl -i -X 
            'https://rest.zuora.com/system-health/payments/details?startTime=2024-09-22T09:07+0800&endTime=2024-09-23T09:07+0800&pageSize=1&sort=amount&page=3'
            \

            --header 'Authorization: Bearer bfc0f973d84d47cb4ddff1b1cd3a61b0'
  /system-health/tax/details:
    get:
      description: >
        Returns System Health Electronic records that are generated by your
        Zuora tenant within a specified time range.



        You can filter the failure records by one or multiple of the following
        fields:
          - vendorName
          - eventType
          - status
      operationId: getSystemHealthTaxRecords
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: |
            Filters the records by vendor name.
          in: query
          name: vendorName
          required: false
          schema:
            type: string
        - description: |
            Filters the tax records by event type.
          in: query
          name: eventType
          required: false
          schema:
            type: string
        - description: |
            Filters the tax records by status.
          in: query
          name: status
          required: false
          schema:
            type: string
        - description: >
            This parameter restricts the order of the data returned in the
            response. You can use this parameter to supply a dimension you want
            to sort on.


            A sortable field uses the following form: *operator* *field_name*.


            If you do not specify any sortable field, the response data is
            sorted by the `timerange` field in descending order.



            *operator* is used to mark the order of sequencing. The operator is
            optional. 

            If you only specify the sortable field without any operator, the
            response data is sorted in descending order by this field.  


            - The `-` operator indicates an ascending order.

            - The `+` operator indicates a descending order. 


            *field_name* indicates the name of a sortable field. 

            The supported sortable fields of this operation are as below:

            - `timestamp`

            - `total_duration`

            - `vendor_duration`

            - `status`

            - `document_number`
          in: query
          example: sort=-total_duration
          name: sort
          required: false
          schema:
            type: string
        - description: |
            Start time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: startTime
          required: true
          schema:
            format: date-time
            type: string
        - description: |
            End time of the volume summary.

            Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`.
          in: query
          name: endTime
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - error_message: ''
                        document_number: INV419655124
                        vendor_name: AvaTax
                        event_source: avalara
                        error_category: ''
                        account_id: 8a1283368cd9a250018cee13373471a7
                        event_type: taxGenerate
                        total_duration: 145
                        zuora_request_id: 881cf248-5c26-4ca2-b984-8426faf05a22
                        account_name: Amy Lawrence's Account
                        vendor_duration: 145
                        sub_error_category: ''
                        status: success
                        timestamp: '2025-01-10T04:08:58'
                      - error_message: ''
                        document_number: INV519605124
                        vendor_name: AvaTax
                        event_source: avalara
                        error_category: ''
                        account_id: 8a1283368cd9a250018cee13373471a7
                        event_type: taxGenerate
                        total_duration: 149
                        zuora_request_id: 881cf248-5c26-4cq2-b984-8426faf05a22
                        account_name: Amy Lawrence's Account
                        vendor_duration: 145
                        sub_error_category: ''
                        status: success
                        timestamp: '2025-01-10T04:08:58'
                    nextPage: >-
                      /system-health/tax/details?pageSize=1&startTime=2025-01-10T09:07+0800&endTime=2025-01-12T09:07+0800&sort=-timestamp&page=3
              schema:
                $ref: '#/components/schemas/GetTaxRecordsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    error: Bad Request
                    message: Timezone is different between 'startTime' and 'endTime'.
                    path: /system-health/payments/volume-summary
                    status: 400
                    timestamp: '2022-09-29T05:54:46.007+00:00'
              schema:
                $ref: '#/components/schemas/SystemHealthErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List tax system health records
      tags:
        - Tax Health
      x-code-samples:
        - label: cURL
          lang: curl
          source: |
            curl -i -X GET \
              'https://rest.zuora.com/system-health/tax/details?startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800' \
              -H 'Authorization: Bearer 7la16g11ga6g47099dc0605d7a175836'
  /workflows/versions/{version_id}:
    delete:
      description: >
        Delete a workflow version based on the version id. 


        ### User Access Permission

        You must be assigned the **Workflow Manage Access** permission to run
        this operation.
      operationId: DELETE_WorkflowVersion
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The unique id of the workflow version.
          in: path
          name: version_id
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 113
                    success: true
              schema:
                $ref: '#/components/schemas/DeleteWorkflowSuccess'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '403':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: invalid
                        status: 403
                        title: Cannot delete the active version of a workflow.
              schema:
                $ref: '#/components/schemas/DeleteWorkflowError'
          description: Cannot delete the active version of a workflow.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a workflow version
      tags:
        - Workflows
  /workflows:
    get:
      description: >
        Retrieves a list of workflow definitions available in your Zuora tenant.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.   
      operationId: GET_Workflows
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            If set to true, the operation retrieves workflows that have the
            callout trigger enabled. If set to false, the operation retrieves
            workflows that have the callout trigger disabled. If not specified,
            the operation will not use this filter.
          in: query
          name: callout_trigger
          required: false
          schema:
            type: boolean
        - description: >
            A CRON expession that specifies a schedule (for example, `0 0 * *
            *`). If specified, the operation retrieves the workflow that is run
            based on the specified schedule.
          in: query
          name: interval
          required: false
          schema:
            type: string
        - description: >
            If specified, the operation retrieves the workflow that is in the
            specified name.
          in: query
          name: name
          required: false
          schema:
            type: string
        - description: >
            If set to true, the operation retrieves workflows that have the
            ondemand trigger enabled. If set to false, the operation retrieves
            workflows that have the ondemand trigger disabled. If not specified,
            the operation will not use this filter.
          in: query
          name: ondemand_trigger
          required: false
          schema:
            type: boolean
        - description: >
            If set to true, the operation retrieves workflows that have the
            scheduled trigger enabled. If set to false, the operation retrieves
            workflows that have the scheduled trigger disabled. If not specfied,
            the operation will not use this filter.
          in: query
          name: scheduled_trigger
          required: false
          schema:
            type: boolean
        - description: >
            If you want to retrieve only the workflows on a specific page, you
            can specify the `page` number in the query.
          in: query
          name: page
          required: false
          schema:
            default: 1
            type: integer
        - description: >
            The number of workflows shown in a single call. If the `page`
            parameter is not specified, the operation will return only the first
            page of results. If there are multiple pages of results, use it with
            the `page` parameter to get the results on subsequent pages. The
            maximum value is 50.
          in: query
          name: page_length
          required: false
          schema:
            default: 20
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - active_version:
                          description: ''
                          id: 49
                          status: Active
                          type: Workflow::Setup
                          version: 0.0.1
                        calloutTrigger: true
                        createdAt: '2019-05-31T14:52:38.171Z'
                        description: ''
                        id: 48
                        interval: null
                        latest_inactive_verisons:
                          - calloutTrigger: true
                            createdAt: '2021-09-22T19:30:52.350Z'
                            description: ''
                            id: 50
                            interval: ''
                            name: test
                            ondemandTrigger: true
                            priority: Medium
                            scheduledTrigger: false
                            status: Inactive
                            timezone: Sydney
                            type: Workflow::Setup
                            updatedAt: '2021-09-22T19:30:52.350Z'
                            version: 0.0.2
                          - calloutTrigger: true
                            createdAt: '2021-09-22T19:30:52.350Z'
                            description: ''
                            id: 51
                            interval: ''
                            name: test
                            ondemandTrigger: true
                            priority: Medium
                            scheduledTrigger: false
                            status: Inactive
                            timezone: Sydney
                            type: Workflow::Setup
                            updatedAt: '2021-09-22T19:30:52.350Z'
                            version: 0.0.3
                        name: New test workflow
                        ondemandTrigger: true
                        scheduledTrigger: false
                        status: Active
                        timezone: null
                        updatedAt: '2019-06-03T21:02:26.694Z'
                    pagination:
                      next_page: https://rest.zuora.com/workflows?page=2&page_length=1
                      page: 1
                      page_length: 1
              schema:
                $ref: '#/components/schemas/GetWorkflowsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List workflows
      tags:
        - Workflows
  /workflows/import:
    post:
      description: >
        Create a new workflow definition and its first version using the
        exported JSON document of an existing workflow version.


        ### User Access Permission

        You must be assigned the **Workflow Manage Access** permission to run
        this operation.
      operationId: POST_WorkflowImport
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The unique id of the workflow definition to under.
          in: query
          name: workflow_definition_id
          required: false
          schema:
            type: integer
        - description: >-
            The version number of the new workflow version to import. Must be
            greater than any existing version numbers.
          in: query
          name: version
          required: false
          schema:
            type: string
        - description: >-
            Indicates whether the imported version is an active version. Default
            to be false.
          in: query
          name: activate
          required: false
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POSTWorkflowDefinitionImportRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 3373
                    name: Checking Workflow
                    description: ''
                    type: Workflow::Setup
                    version: 0.0.1
                    ondemandTrigger: true
                    calloutTrigger: false
                    scheduledTrigger: false
                    interval: ''
                    timezone: ''
                    createdAt: '2019-10-03T14:14:39.139Z'
                    updatedAt: '2019-10-03T14:14:39.139Z'
              schema:
                $ref: '#/components/schemas/Workflow'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Import a workflow
      tags:
        - Workflows
  /workflows/metrics.json:
    get:
      description: >
        Gets workflow task usage sorted by day within a specified time frame.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.        
      operationId: GET_WorkflowsUsages
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            The start date of the usage data that you want to get. For example,
            2019-01-01.
          in: query
          name: startDate
          required: true
          schema:
            format: date
            type: string
        - description: >
            The end date of the usage data that you want to get. For example,
            2019-12-31.
          in: query
          name: endDate
          required: true
          schema:
            format: date
            type: string
        - description: >
            The type of metric that you want to get. Currently, only `taskCount`
            is supported. `taskCount` is the amount of task runs.
          in: query
          name: metrics
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    metrics:
                      - date: '2019-01-16'
                        values:
                          taskCount: 1417
                      - date: '2019-08-02'
                        values:
                          taskCount: 24
                      - date: '2019-05-23'
                        values:
                          taskCount: 2
              schema:
                $ref: '#/components/schemas/UsagesResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve workflow task usage
      tags:
        - Workflows
  /workflows/tasks:
    get:
      description: >
        Retrieves a list of workflow tasks available in your Zuora tenant.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.
      operationId: GET_WorkflowsTasks
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            If specified, the operation retrieves the task that is with
            specified id.
          in: query
          name: id
          required: false
          schema:
            type: string
        - description: >
            If specified, the operation retrieves tasks that is in the specified
            name.
          in: query
          name: name
          required: false
          schema:
            type: string
        - description: >
            If set to true, the operation retrieves workflows that have the
            scheduled trigger enabled. If set to false, the operation retrieves
            workflows that have the scheduled trigger disabled. If not specfied,
            the operation will not use this filter.
          in: query
          name: instance
          required: false
          schema:
            type: boolean
        - description: >
            If specified, the operation retrieves tasks that is the specified
            type.
          in: query
          name: action_type
          required: false
          schema:
            type: string
        - description: >
            If specified, the operation retrieves tasks with the specified
            object.
          in: query
          name: object
          required: false
          schema:
            type: string
        - description: >
            If specified, the operation retrieves tasks with the specified
            object id.
          in: query
          name: object_id
          required: false
          schema:
            type: string
        - description: >
            If specified, the operation retrieves tasks with the specified api
            call type used.
          in: query
          name: call_type
          required: false
          schema:
            type: string
        - description: >
            If specified, the operation retrieves tasks that for the specified
            workflow id.
          in: query
          name: workflow_id
          required: false
          schema:
            type: string
        - description: >
            If specified, the operation retrieves tasks that with the specified
            filter tags. Use the following syntax to specify multiple tags:
            `tags[]=tag_value_1&tags[]=tag_value_2`.


            **Note:** All the workflow tasks that have any of the specified tags
            will be listed in the response body.
          explode: false
          in: query
          name: tags
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - description: >
            If you want to retrieve only the workflows on a specific page, you
            can specify the `page` number in the query.
          in: query
          name: page
          required: false
          schema:
            default: 1
            type: integer
        - description: >
            The number of workflow tasks shown in a single call. If the `page`
            parameter is not specified, the operation will return only the first
            page of results. If there are multiple pages of results, use it with
            the `page` parameter to get the results on subsequent pages. The
            maximum value is 100.
          in: query
          name: page_length
          required: false
          schema:
            default: 20
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - action_type: If
                        call_type: SOAP
                        data:
                          Callout:
                            RequestBody:
                              queryString: >-
                                Select Id From Contact Where LastName = 'Drew'
                                AND FirstName = 'Nancy' AND  WorkEmail =
                                'nancy@xyz.com'
                            RequestHeaders:
                              Content-Type: application/json
                            ResponseBody:
                              message: |
                                An unexpected error occurred
                            ResponseCode: 500
                            ResponseHeaders:
                              cache-control:
                                - max-age=0, no-cache, no-store
                              connection:
                                - close
                              content-type:
                                - text/plain; charset=UTF-8
                              date:
                                - Thu, 19 Sep 2019 12:35:43 GMT
                              expires:
                                - Thu, 19 Sep 2019 12:35:43 GMT
                              pragma:
                                - no-cache
                              server:
                                - kong/0.9.9
                              x-n:
                                - S
                            URL: https://rest.apisandbox.zuora.com/v1/action/query
                          Files:
                            XML_52881.xml:
                              name: JSONData_xslt.xml
                              object_class: Workflow
                              size: 0.011725425720214844
                          Tasks:
                            Previous:
                              ErrorClass: WorkflowError::Callout
                              ErrorReason: Callout response was 500 after 1 tries.
                              Id: 2770
                              Status: Error
                          Workflow:
                            ExecutionDate: '2019-09-19'
                            ExecutionDateTime: '2019-09-19T12:35:37'
                            LastRunDate: '2019-09-19'
                            LastRunDateTime: '2019-09-19T12:34:41'
                            WorkflowRunUser: test-user
                        end_time: '2019-09-19T12:35:43.942Z'
                        error: null
                        error_class: null
                        error_details: null
                        id: 2771
                        instance: true
                        name: If
                        object: null
                        object_id: null
                        original_task_id: 2582
                        original_workflow_id: 416
                        parameters:
                          if_clause: "{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}"
                          strict_variables: 'true'
                        start_time: '2019-09-19T12:35:43.857Z'
                        status: Success
                        tags: []
                        workflow_id: 476
                    pagination:
                      next_page: >-
                        https://rest.zuora.com/workflows/tasks?page=2&page_length=1
                      page: 1
                      page_length: 1
              schema:
                $ref: '#/components/schemas/TasksResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List workflow tasks
      tags:
        - Workflows
  /workflows/tasks/batch_update:
    put:
      description: >
        Updates a group of workflow tasks.


        ### User Access Permission

        You must be assigned the **Workflow Manage Access** permission to run
        this operation.
      operationId: PUT_WorkflowsTasksUpdate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutTasksRequest'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - action_type: If
                        call_type: SOAP
                        data:
                          Callout:
                            RequestBody:
                              queryString: >-
                                Select Id From Contact Where LastName = 'Drew'
                                AND FirstName = 'Nancy' AND  WorkEmail =
                                'nancy@xyz.com'
                            RequestHeaders:
                              Content-Type: application/json
                            ResponseBody:
                              message: |
                                An unexpected error occurred
                            ResponseCode: 500
                            ResponseHeaders:
                              cache-control:
                                - max-age=0, no-cache, no-store
                              connection:
                                - close
                              content-type:
                                - text/plain; charset=UTF-8
                              date:
                                - Thu, 19 Sep 2019 12:35:43 GMT
                              expires:
                                - Thu, 19 Sep 2019 12:35:43 GMT
                              pragma:
                                - no-cache
                              server:
                                - kong/0.9.9
                              x-n:
                                - S
                            URL: https://rest.apisandbox.zuora.com/v1/action/query
                          Files:
                            XML_52881.xml:
                              name: JSONData_xslt.xml
                              object_class: Workflow
                              size: 0.011725425720214844
                          Tasks:
                            Previous:
                              ErrorClass: WorkflowError::Callout
                              ErrorReason: Callout response was 500 after 1 tries.
                              Id: 2770
                              Status: Error
                          Workflow:
                            ExecutionDate: '2019-09-19'
                            ExecutionDateTime: '2019-09-19T12:35:37'
                            LastRunDate: '2019-09-19'
                            LastRunDateTime: '2019-09-19T12:34:41'
                            WorkflowRunUser: test-user
                        end_time: '2019-09-19T12:35:43.942Z'
                        error: null
                        error_class: null
                        error_details: null
                        id: 2771
                        instance: true
                        name: If
                        object: null
                        object_id: null
                        original_task_id: 2582
                        original_workflow_id: 416
                        parameters:
                          if_clause: "{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}"
                          strict_variables: 'true'
                        start_time: '2019-09-19T12:35:43.857Z'
                        status: Success
                        tags: []
                        workflow_id: 476
                    pagination:
                      page: null
                      page_length: null
              schema:
                $ref: '#/components/schemas/TasksResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: Task
                        status: 400
                        title: Data not present or not in array.
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
          description: |
            Bad Request for one of the following reasons:
            * Data is missing
            * Data is empty or not an array
            * Data has more than 50 tasks
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: Task
                        status: 404
                        title: Missing ids for tasks.
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
          description: One or more tasks are missing the required `id` field
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update workflow tasks
      tags:
        - Workflows
  /workflows/tasks/{task_id}:
    get:
      description: >
        Retrieves a specific workflow task by its ID.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.
      operationId: GET_WorkflowsTask
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The unique ID of the task.
          in: path
          name: task_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    action_type: If
                    call_type: SOAP
                    data:
                      Callout:
                        RequestBody:
                          queryString: >-
                            Select Id From Contact Where LastName = 'Drew' AND
                            FirstName = 'Nancy' AND  WorkEmail = 'nancy@xyz.com'
                        RequestHeaders:
                          Content-Type: application/json
                        ResponseBody:
                          message: |
                            An unexpected error occurred
                        ResponseCode: 500
                        ResponseHeaders:
                          cache-control:
                            - max-age=0, no-cache, no-store
                          connection:
                            - close
                          content-type:
                            - text/plain; charset=UTF-8
                          date:
                            - Thu, 19 Sep 2019 12:35:43 GMT
                          expires:
                            - Thu, 19 Sep 2019 12:35:43 GMT
                          pragma:
                            - no-cache
                          server:
                            - kong/0.9.9
                          x-n:
                            - S
                        URL: https://rest.apisandbox.zuora.com/v1/action/query
                      Files:
                        XML_52881.xml:
                          name: JSONData_xslt.xml
                          object_class: Workflow
                          size: 0.011725425720214844
                      Tasks:
                        Previous:
                          ErrorClass: WorkflowError::Callout
                          ErrorReason: Callout response was 500 after 1 tries.
                          Id: 2770
                          Status: Error
                      Workflow:
                        ExecutionDate: '2019-09-19'
                        ExecutionDateTime: '2019-09-19T12:35:37'
                        LastRunDate: '2019-09-19'
                        LastRunDateTime: '2019-09-19T12:34:41'
                        WorkflowRunUser: test-user
                    end_time: '2019-09-19T12:35:43.942Z'
                    error: null
                    error_class: null
                    error_details: null
                    id: 2771
                    instance: true
                    name: If
                    object: null
                    object_id: null
                    original_task_id: 2582
                    original_workflow_id: 416
                    parameters:
                      if_clause: "{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}"
                      strict_variables: 'true'
                    start_time: '2019-09-19T12:35:43.857Z'
                    status: Success
                    tags: []
                    workflow_id: 476
              schema:
                $ref: '#/components/schemas/Task'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a workflow task
      tags:
        - Workflows
  /workflows/tasks/{task_id}/rerun:
    post:
      description: >
        Reruns a specific workflow task by its ID.


        ### User Access Permission

        You must be assigned the **Workflow Run Access** permission to run this
        operation.
      operationId: POST_WorkflowsTaskRerun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The unique ID of the task.
          in: path
          name: task_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    action_type: If
                    call_type: SOAP
                    data:
                      Callout:
                        RequestBody:
                          queryString: >-
                            Select Id From Contact Where LastName = 'Drew' AND
                            FirstName = 'Nancy' AND  WorkEmail = 'nancy@xyz.com'
                        RequestHeaders:
                          Content-Type: application/json
                        ResponseBody:
                          message: |
                            An unexpected error occurred
                        ResponseCode: 500
                        ResponseHeaders:
                          cache-control:
                            - max-age=0, no-cache, no-store
                          connection:
                            - close
                          content-type:
                            - text/plain; charset=UTF-8
                          date:
                            - Thu, 19 Sep 2019 12:35:43 GMT
                          expires:
                            - Thu, 19 Sep 2019 12:35:43 GMT
                          pragma:
                            - no-cache
                          server:
                            - kong/0.9.9
                          x-n:
                            - S
                        URL: https://rest.apisandbox.zuora.com/v1/action/query
                      Files:
                        XML_52881.xml:
                          name: JSONData_xslt.xml
                          object_class: Workflow
                          size: 0.011725425720214844
                      Tasks:
                        Previous:
                          ErrorClass: WorkflowError::Callout
                          ErrorReason: Callout response was 500 after 1 tries.
                          Id: 2770
                          Status: Error
                      Workflow:
                        ExecutionDate: '2019-09-19'
                        ExecutionDateTime: '2019-09-19T12:35:37'
                        LastRunDate: '2019-09-19'
                        LastRunDateTime: '2019-09-19T12:34:41'
                        WorkflowRunUser: test-user
                    end_time: '2019-09-19T12:35:43.942Z'
                    error: null
                    error_class: null
                    error_details: null
                    id: 2771
                    instance: true
                    name: If
                    object: null
                    object_id: null
                    original_task_id: 2582
                    original_workflow_id: 416
                    parameters:
                      if_clause: "{% if 0 > 1 %}\r\nTrue\r\n{% else %}\r\nFalse\r\n{% endif %}"
                      strict_variables: 'true'
                    start_time: '2019-09-19T12:35:43.857Z'
                    status: Success
                    tags: []
                    workflow_id: 476
              schema:
                $ref: '#/components/schemas/Task'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Rerun a workflow task
      tags:
        - Workflows
  /workflows/workflow_runs/{workflow_run_id}:
    get:
      description: >
        Retrieves information about a specific workflow run by its ID.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.
      operationId: GET_Workflow_Run
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The unique ID of a workflow run. For example, 19080.
          in: path
          name: workflow_run_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    cpuTime: '19:01:04'
                    createdAt: 2019-09-10 19:32:21 UTC
                    finishedAt: 2019-09-10 19:33:34 UTC
                    id: 19063
                    name: WF-19027-00000032
                    originalWorkflowId: 19027
                    runTime: 64.513026
                    status: Finished
                    tasks:
                      error: 0
                      pending: 0
                      processing: 0
                      queued: 0
                      stopped: 0
                      success: 4
                      total: 4
                    type: Workflow::Instance
                    updatedAt: 2019-09-10 19:33:34 UTC
              schema:
                $ref: '#/components/schemas/GetWorkflowResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a workflow run
      tags:
        - Workflows
  /workflows/{workflow_id}:
    delete:
      description: >
        Deletes a specific workflow by its ID.


        ### User Access Permission

        You must be assigned the **Workflow Manage Access** permission to run
        this operation.
      operationId: DELETE_Workflow
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The unique ID of a workflow definition. For example, 19080.
          in: path
          name: workflow_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 19080
                    success: true
              schema:
                $ref: '#/components/schemas/DeleteWorkflowSuccess'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - >-
                        Invalid ID / Multiple objects returned - SchemaId: 2
                        InstanceId: 2 ObjectId: 19080
              schema:
                $ref: '#/components/schemas/DeleteWorkflowError'
          description: The workflow for the given id does not exist
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete a workflow
      tags:
        - Workflows
    get:
      description: >
        Retrieves information about a specific workflow by its ID.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.
      operationId: GET_Workflow
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The unique ID of a workflow definition. For example, 19080.
          in: path
          name: workflow_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    active_version:
                      description: ''
                      id: 49
                      status: Active
                      type: Workflow::Setup
                      version: 0.0.1
                    calloutTrigger: true
                    createdAt: '2021-09-22T19:30:52.350Z'
                    description: ''
                    id: 2
                    interval: ''
                    name: test
                    ondemandTrigger: true
                    priority: Medium
                    scheduledTrigger: false
                    status: Active
                    timezone: Sydney
                    updatedAt: '2021-09-22T19:30:52.350Z'
              schema:
                $ref: '#/components/schemas/WorkflowDefinition'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a workflow
      tags:
        - Workflows
    patch:
      description: >
        Updates a specific workflow by its ID, which allows you to [configure
        the settings of a
        workflow](https://knowledgecenter.zuora.com/CE_Workflow/Using_Workflow/B_Configure_a_Workflow)
        via API.


        ### User Access Permission

        You must be assigned the **Workflow Manage Access** permission to run
        this operation.
      operationId: PATCH_UpdateWorkflow
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The unique ID of a workflow definition. For example, 19080.
          in: path
          name: workflow_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                active_workflow_version_id:
                  description: >
                    The id of a version. This version will then be set to the
                    active version of the workflow definition.
                  type: integer
                description:
                  description: |
                    The description of the workflow defintion
                  type: string
                name:
                  description: |
                    The name of the workflow definition
                  type: string
                status:
                  description: >
                    Can be `Active` or `Inactive`. Active workfow definitions
                    run like normal. Inactive workflow definitions cannot be
                    run.
                  type: string
              type: object
              example:
                description: Retrieve and update products
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 265
                    name: Refresh products
                    description: Retrieve and update products
                    status: Active
                    ondemandTrigger: true
                    calloutTrigger: true
                    scheduledTrigger: false
                    interval: null
                    timezone: null
                    createdAt: '2021-02-04T13:39:10.530+08:00'
                    updatedAt: '2021-07-23T11:43:48.576+08:00'
                    active_version:
                      id: 265
                      description: the first description
                      type: Workflow::Setup
                      version: 0.0.1
                      status: Active
              schema:
                $ref: '#/components/schemas/WorkflowDefinition'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - >-
                        Invalid ID / Multiple objects returned - SchemaId: 2
                        InstanceId: 2 ObjectId: 19080
              schema:
                $ref: '#/components/schemas/DeleteWorkflowError'
          description: The workflow for the given id does not exist
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '422':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - fieldName: status
                        title: >-
                          on is not a valid status. Choose from Active or
                          Inactive
                      - fieldName: interval
                        title: >-
                          The entered cron interval is not valid, rebuild
                          schedule and submit again.
                    success: false
              schema:
                $ref: '#/components/schemas/ValidationErrors'
          description: >
            Bad Request for one of the following reasons:

            * The name or description fields are not strings.

            * The ondemand_trigger, callout_trigger, or scheduled_trigger fields
            are not booleans.

            * The timezone does not match one of the valid values in [this
            spread
            sheet](https://docs.google.com/spreadsheets/d/1skhepi-q5l9LyaMUPZjU_V9gzTphNMqNyV6ST5mygEo/edit?usp=sharing).

            * The priority is not one of High, Medium, or Low.

            * The status is not one of Active or Inactive.

            * The scheduled_trigger is set to true but a valid timezone and
            interval were not passed.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update a workflow
      tags:
        - Workflows
  /workflows/{workflow_id}/export:
    get:
      description: >

        Exports a workflow version into a JSON file. This file can be used to
        create a copy of this workflow version.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.
      operationId: GET_WorkflowExport
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The ID of the workflow definition to export.
          in: path
          name: workflow_id
          required: true
          schema:
            type: integer
        - description: >
            Default result is the active version of the workflow definition.
            Version number and 'latest' can be used to export a specific version
            of the workflow definition. 
          in: query
          name: version
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    linkages:
                      - linkage_type: Start
                        source_task_id: null
                        source_workflow_id: 286
                        target_task_id: 849
                    tasks:
                      - action_type: Callout
                        assignment: []
                        call_type: SOAP
                        concurrent_limit: 9999999
                        css:
                          left: 470px
                          top: 160px
                        error: null
                        error_class: null
                        error_details: null
                        id: 849
                        iterate_row_reference: null
                        name: Call Echo
                        object: null
                        object_batched_reference: null
                        object_id: null
                        original_task_id: null
                        original_workflow_id: null
                        parameters:
                          authorization:
                            type: none
                          body_type: raw
                          datas:
                            - key: ''
                              value: ''
                          headers:
                            - key: ''
                              value: ''
                          include_response_code: 'true'
                          method: GET
                          raw_body: ''
                          retry_rules:
                            current_retry_count: '0'
                            retry_count: '0'
                            retry_window: '30'
                          strict_variables: 'true'
                          url: http://scooterlabs.com/echo
                          validate_response: 'false'
                          validation:
                            status_codes:
                              - ''
                              - '200'
                            zuora_call: 'false'
                          validation_scheme: ''
                        priority: Medium
                        process_id: null
                        status: null
                        tags:
                          - ''
                        task_id: null
                    workflow:
                      call_type: null
                      callout_trigger: true
                      css:
                        left: 30px
                        top: 40px
                      data: {}
                      delete_ttl: 60
                      description: ''
                      finished_at: null
                      id: 286
                      interval: null
                      name: Call Echo
                      notifications: {}
                      ondemand_trigger: true
                      original_workflow_id: null
                      parameters: {}
                      priority: Medium
                      scheduled_trigger: false
                      started_at: null
                      status: null
                      sync_trigger: false
                      task_summary: {}
                      timezone: null
                      type: Workflow::Setup
                      version: 0.0.1
              schema:
                $ref: '#/components/schemas/ExportWorkflowVersionResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: invalid
                        status: 400
                        title: The input of version '1' is invalid.
              schema:
                properties:
                  errors:
                    description: The list of errors returned from the workflow
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                type: object
          description: The input of version is invalid.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: invalid
                        status: 400
                        title: Workflow version '1' is not found.
              schema:
                properties:
                  errors:
                    description: The list of errors returned from the workflow
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                type: object
          description: Workflow version is not found.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Export a workflow version
      tags:
        - Workflows
  /workflows/{workflow_id}/run:
    post:
      description: >
        Run a specified workflow. In the request body, you can include
        parameters that you want to pass to the workflow. For the parameters to
        be recognized and picked up by tasks in the workflow, you need to define
        the parameters first.


        **Note**: To run a workflow, do not use the following reserved words in
        the request body of the parameters.
         - `controller`
         - `action`
         - `id`
         - `user_email`
         - `user_token`
         - `format`

        ### User Access Permission

        You must be assigned the **Workflow Run Access** permission to run this
        operation.


        To learn about how to define parameters, see [Configure the settings of
        a
        workflow](https://knowledgecenter.zuora.com/CE_Workflow/Using_Workflow/B_Configure_a_Workflow).
      operationId: POST_Run_Workflow
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The ID of the workflow definition you want to run.
          in: path
          name: workflow_id
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              example:
                accountId: 4028905f5a87c0ff015a87d25ae90025
                paymentId: 4028905f5a87c0ff015a889ddfb800c0
              type: object
        description: Include parameters you want to pass to the workflow.
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    createdAt: 2019-09-19 18:25:33 UTC
                    id: 400
                    name: WF-396-00000003
                    originalWorkflowId: 396
                    status: Queued
                    type: Workflow::Instance
                    updatedAt: 2019-09-19 18:25:33 UTC
              schema:
                $ref: '#/components/schemas/WorkflowInstance'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: invalid
                        status: 400
                        title: Callout mode is not turned on in this workflow.
              schema:
                properties:
                  errors:
                    description: The list of errors returned from the workflow
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                type: object
          description: Callout not enabled for the workflow
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '406':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: invalid
                        status: 406
                        title: >-
                          Required field for Workflow-Message1 does not have a
                          set value. Ensure parameter 'Message' is present.
                    parameters:
                      workflow: {}
              schema:
                properties:
                  errors:
                    description: The list of errors returned from the workflow
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                  parameters:
                    description: >-
                      The request body that was originally provided to the run
                      API.
                type: object
          description: The provided body is missing one or more required parameters
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '409':
          content:
            application/json:
              examples:
                response:
                  value:
                    errors:
                      - code: invalid
                        status: 406
                        title: >-
                          Workflow WF-396-00000002 with Id 399 is an
                          instance/run.
              schema:
                properties:
                  errors:
                    description: The list of errors returned from the workflow
                    items:
                      $ref: '#/components/schemas/WorkflowError'
                    type: array
                type: object
          description: The provided workflow_id references a workflow instance
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
      summary: Run a workflow
      tags:
        - Workflows
  /workflows/{workflow_id}/versions:
    get:
      description: >
        Return a list of all workflow versions under a workflow definition


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.
      operationId: GET_WorkflowVersions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >-
            The unique id of the workflow definition to import a workflow
            version under.
          in: path
          name: workflow_id
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - calloutTrigger: true
                        createdAt: '2019-05-31T14:52:38.171Z'
                        description: ''
                        id: 48
                        interval: null
                        name: New test workflow
                        ondemandTrigger: true
                        scheduledTrigger: false
                        timezone: null
                        type: Workflow::Setup
                        updatedAt: '2019-06-03T21:02:26.694Z'
                        version: 0.0.1
                      - calloutTrigger: true
                        createdAt: '2019-05-31T14:52:38.171Z'
                        description: ''
                        id: 49
                        interval: null
                        name: New test workflow
                        ondemandTrigger: true
                        scheduledTrigger: false
                        timezone: null
                        type: Workflow::Setup
                        updatedAt: '2019-06-03T21:02:26.694Z'
                        version: 0.0.2
              schema:
                $ref: '#/components/schemas/GetVersionsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all versions of a workflow definition
      tags:
        - Workflows
  /workflows/{workflow_id}/versions/import:
    post:
      description: >
        Create a new workflow version under a workflow definition using the
        exported JSON document of an existing workflow version.


        ### User Access Permission

        You must be assigned the **Workflow Manage Access** permission to run
        this operation.
      operationId: POST_WorkflowVersionsImport
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >-
            The unique id of the workflow definition to import a workflow
            version under.
          in: path
          name: workflow_id
          required: true
          schema:
            type: integer
        - description: >-
            The version number of the new workflow version to import. Must be
            greater than any existing version numbers.
          in: query
          name: version
          required: true
          schema:
            type: string
        - description: >-
            Indicates whether the imported version is an active version. Default
            to be false.
          in: query
          name: activate
          required: false
          schema:
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              properties:
                linkages:
                  items:
                    $ref: '#/components/schemas/Linkage'
                  type: array
                tasks:
                  items:
                    $ref: '#/components/schemas/Task'
                  type: array
                workflow:
                  $ref: '#/components/schemas/DetailedWorkflow'
              type: object
              example:
                workflow:
                  id: 458
                  name: Checking Workflow
                  description: ''
                  type: Workflow::Setup
                  ondemand_trigger: true
                  callout_trigger: false
                  scheduled_trigger: false
                  interval: ''
                  timezone: ''
                  status: Active
                  version: 0.0.1
                tasks:
                  - id: 1418
                    name: Checking the Approval Email
                    parameters:
                      emailBody: >-
                        <body style=\font-family: Arial, sans-serif; margin:
                        20px; line-height: 1.6; color: #333;\>\n\t<p>
                        Hello,</p>\n\t<p>You have a pending approval. Please <a
                        href=\{{Data.Approval.approveLink}}\>approve</a> or <a
                        href=\{{Data.Approval.rejectLink}}\>reject</a>.</p>\n\t<p>Thanks</p>
                        \n</body>
                      senderName: Admin
                      senderEmail: workflow@zuora.com
                      approvalNote: ''
                      subjectEmail: This is the email to check if this email is working
                      delivery_method: email
                      email_approver_emails:
                        - admin@company.com
                    action_type: Approval
                    object: ''
                    object_id: ''
                    call_type: SOAP
                    task_id: null
                    concurrent_limit: 9999999
                    tags: []
                linkages:
                  - source_workflow_id: 458
                    source_task_id: null
                    target_task_id: 1418
                    linkage_type: Finish
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 3373
                    name: Checking Workflow
                    description: ''
                    status: Active
                    ondemandTrigger: true
                    calloutTrigger: false
                    scheduledTrigger: false
                    interval: ''
                    timezone: ''
                    createdAt: '2024-11-15T12:51:45.859+08:00'
                    updatedAt: '2024-11-15T12:51:45.859+08:00'
                    active_version:
                      id: 3373
                      description: ''
                      type: Workflow::Setup
                      version: 0.0.1
                      status: Inactive
              schema:
                $ref: '#/components/schemas/WorkflowDefinition'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Import a workflow version
      tags:
        - Workflows
  /workflows/workflow_runs/{workflow_run_id}/stop:
    put:
      tags:
        - Workflows
      summary: Stop a workflow run
      description: >
        Stop a specific workflow run by its ID.


        ### User Access Permission

        You must be assigned the **Workflow View Access** permission to run this
        operation.
      operationId: PUT_StopWorkflowRun
      parameters:
        - name: Accept-Encoding
          in: header
          description: >
            Include the `Accept-Encoding: gzip` header to compress responses as
            a gzipped file. It can significantly reduce the bandwidth required
            for a response.


            If 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.
          schema:
            type: string
        - name: Content-Encoding
          in: header
          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.
          schema:
            type: string
        - name: Authorization
          in: header
          description: >
            The value is in the `Bearer {token}` format where {token} is a valid
            OAuth token generated by calling [Create an OAuth
            token](https://developer.zuora.com/api-references/api/operation/createToken).
          required: true
          schema:
            type: string
        - name: Zuora-Entity-Ids
          in: header
          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.
          schema:
            type: string
        - name: Zuora-Org-Ids
          in: header
          description: >
            Comma separated IDs. If you have [Zuora
            Multi-Org](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Multi-Org)
            enabled,

            you 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.


            The 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.


            If the header is not set, the operation is performed in scope of the
            user's accessible orgs.
          schema:
            type: string
        - name: Zuora-Track-Id
          in: header
          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 (`'`).
          schema:
            maxLength: 64
            type: string
        - name: workflow_run_id
          in: path
          description: |
            The unique ID of a workflow run. For example, 19080.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopWorkflowRunSuccess'
              example:
                success: true
        '404':
          description: Cannot find a workflow run with id provided.
          headers:
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopWorkflowRunError'
              example:
                errors:
                  - code: Invalid
                    status: 404
                    title: Workflow run '19080' is not found
  /object-query/accounts:
    get:
      summary: List accounts
      description: >
        Lists accounts. You can use the query parameters to filter, expand, and
        sort the returned results.
      operationId: queryAccounts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountnumber
              - balance
              - batch
              - billcycleday
              - billtoid
              - communicationprofileid
              - crmid
              - currency
              - defaultpaymentmethodid
              - invoicetemplateid
              - lastinvoicedate
              - name
              - parentid
              - shiptoid
              - soldtoid
              - status
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - billto
                - soldto
                - shipto
                - defaultpaymentmethod
                - subscriptions
                - payments
                - refunds
                - creditmemos
                - debitmemos
                - invoices
                - usages
                - paymentmethods
                - subscriptions.rateplans
                - subscriptions.rateplans.rateplancharges
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountnumber
              - balance
              - batch
              - billcycleday
              - billtoid
              - communicationprofileid
              - crmid
              - currency
              - defaultpaymentmethodid
              - invoicetemplateid
              - lastinvoicedate
              - name
              - parentid
              - shiptoid
              - soldtoid
              - status
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTEyLTE2VDE3OjU1OjA1LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOWJlNDhkYjVhYmE3MDE4ZGI2MDQ3NzZkNDg1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountNumber: A00000130
                    allowInvoiceEdit: false
                    autoPay: false
                    balance: 7300
                    batch: Batch1
                    bcdSettingOption: ManualSet
                    billCycleDay: 1
                    billToId: 8ad08eb292f6328c019318dcd45521b1
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2024-11-10T17:35:45-08:00'
                    creditBalance: 0
                    currency: USD
                    id: 8ad08eb292f6328c019318dcd43821b0
                    invoiceDeliveryPrefsEmail: false
                    invoiceDeliveryPrefsPrint: false
                    invoiceTemplateId: 2c92c0f86cccaa59016cd5e0f500111d
                    lastInvoiceDate: '2025-03-21'
                    mrr: 2950
                    name: Bella Lawrence
                    partnerAccount: false
                    paymentMethodCascadingConsent: false
                    paymentTerm: Net 30
                    soldToId: 8ad08eb292f6328c019318dcd47421b3
                    status: Active
                    taxExemptStatus: 'No'
                    totalDebitMemoBalance: 0
                    totalInvoiceBalance: 7300
                    unappliedBalance: 0
                    unappliedCreditMemoAmount: 0
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-21T03:24:15-07:00'
              schema:
                type: object
                title: QueryAccountsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedAccount'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/accounts/{key}:
    get:
      summary: Retrieve an account
      description: |
        Retrieve the details of a specific Account object.
      operationId: queryAccountByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - billto
                - soldto
                - shipto
                - defaultpaymentmethod
                - subscriptions
                - payments
                - refunds
                - creditmemos
                - debitmemos
                - invoices
                - usages
                - paymentmethods
                - subscriptions.rateplans
                - subscriptions.rateplans.rateplancharges
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountNumber: A00000130
                allowInvoiceEdit: false
                autoPay: false
                balance: 7300
                batch: Batch1
                bcdSettingOption: ManualSet
                billCycleDay: 1
                billToId: 8ad08eb292f6328c019318dcd45521b1
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2024-11-10T17:35:45-08:00'
                creditBalance: 0
                currency: USD
                id: 8ad08eb292f6328c019318dcd43821b0
                invoiceDeliveryPrefsEmail: false
                invoiceDeliveryPrefsPrint: false
                invoiceTemplateId: 2c92c0f86cccaa59016cd5e0f500111d
                lastInvoiceDate: '2025-03-21'
                mrr: 2950
                name: Bella Lawrence
                partnerAccount: false
                paymentMethodCascadingConsent: false
                paymentTerm: Net 30
                soldToId: 8ad08eb292f6328c019318dcd47421b3
                status: Active
                taxExemptStatus: 'No'
                totalDebitMemoBalance: 0
                totalInvoiceBalance: 7300
                unappliedBalance: 0
                unappliedCreditMemoAmount: 0
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-21T03:24:15-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedAccount'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/amendments:
    get:
      summary: List amendments
      description: >
        Lists amendments. You can use the query parameters to filter, expand,
        and sort the returned results.
      operationId: queryAmendments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.


            Supported sortable fields: 
              - id
              - code
              - effectivedate
              - effectivepolicy
              - name
              - newrateplanid
              - removedrateplanid
              - status
              - subscriptionid
              - type
              - subtype
              - updateddate
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Amendment object does not support expanding any related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.
            Supported filterable fields: 
              - id
              - code
              - effectivedate
              - effectivepolicy
              - name
              - newrateplanid
              - removedrateplanid
              - status
              - subscriptionid
              - type
              - subtype
              - updateddate
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAyLTA2VDIzOjA5OjExLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmNmVhOWQ4Nzk0ZGE5Mzg2NGRmM2RiODU4MTcxOSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - bookingDate: '2025-02-01'
                    code: A-AM00000890
                    contractEffectiveDate: '2025-02-01'
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-25T06:26:14-07:00'
                    currentTermPeriodType: Month
                    customerAcceptanceDate: '2025-02-01'
                    effectiveDate: '2025-02-01'
                    id: f94fb52490e95cd65925cd7b733100b7
                    name: auto generated
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTermPeriodType: Month
                    serviceActivationDate: '2025-02-01'
                    status: Completed
                    type: Composite
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-25T06:26:14-07:00'
              schema:
                type: object
                title: QueryAmendmentsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedAmendment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/amendments/{key}:
    get:
      summary: Retrieve an amendment
      description: |
        Retrieve the details of a specific Amendment object.
      operationId: queryAmendmentByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Amendment object does not support expanding any related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                bookingDate: '2024-08-29'
                code: A-AM00000553
                contractEffectiveDate: '2024-08-29'
                createdById: 8ad09fc28193c189018194da28be74ba
                createdDate: '2024-08-29T00:31:37-07:00'
                currentTerm: 12
                currentTermPeriodType: Month
                customerAcceptanceDate: '2024-08-29'
                effectiveDate: '2024-08-29'
                id: 8ad097b49198384c01919d0c08d42c35
                name: auto generated
                renewalSetting: RENEW_WITH_SPECIFIC_TERM
                renewalTerm: 0
                renewalTermPeriodType: Month
                serviceActivationDate: '2024-08-29'
                status: Completed
                subscriptionId: 8ad08ae29198249d01919d00a4c93b18
                termStartDate: '2024-08-29'
                type: Cancellation
                updatedById: 8ad09fc28193c189018194da28be74ba
                updatedDate: '2024-08-29T00:31:37-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedAmendment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/billing-runs:
    get:
      summary: List bill runs
      description: >
        Lists bill runs. You can use the query parameters to filter, expand, and
        sort the returned results.
      operationId: queryBillingRuns
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - createdbyid
              - updateddate
              - billingrunnumber
              - executeddate
              - name
              - numberofaccounts
              - numberofinvoices
              - numberofcreditmemos
              - status
              - targetdate
              - batches
              - repeattype
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Bill Run object does not support expanding any related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.
            Supported filterable fields: 
              - id
              - createdbyid
              - updateddate
              - billingrunnumber
              - executeddate
              - name
              - numberofaccounts
              - numberofinvoices
              - numberofcreditmemos
              - status
              - targetdate
              - batches
              - repeattype
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTA4LTI4VDIzOjA1OjA0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxOTgyNDkyMDE5MTljYjdmNWNjMjgxZSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 2c92c0f87270a5970172747e289a5e66
                    autoEmail: false
                    autoPost: false
                    autoRenewal: true
                    billingRunNumber: BR-00000005
                    billingRunType: Regular
                    createdById: 2c92c0f97a98ca23017a990996124672
                    createdDate: '2022-04-25T19:08:32-07:00'
                    endDate: '2022-04-25T19:08:37-07:00'
                    executedDate: '2022-04-25T19:08:34-07:00'
                    id: 8ad0887e805061c8018063a09fe2685a
                    includeOrderLineItems: true
                    includeSubscriptions: true
                    invoiceDate: '2022-04-25'
                    invoicesEmailed: false
                    noEmailForZeroAmountInvoice: false
                    numberOfAccounts: 1
                    numberOfCreditMemos: 0
                    numberOfInvoices: 1
                    startDate: '2022-04-25T19:08:34-07:00'
                    status: Completed
                    targetDate: '2022-07-30'
                    targetType: SingleAccount
                    totalTime: 3384
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-02-06T23:10:15-08:00'
              schema:
                type: object
                title: QueryBillingRunsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedBillingRun'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/billing-runs/{key}:
    get:
      summary: Retrieve a bill run
      description: |
        Retrieve the details of a specific Bill Run object.
      operationId: queryBillingRunByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Bill Run object does not support expanding any related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f87270a5970172747e289a5e66
                autoEmail: false
                autoPost: false
                autoRenewal: true
                billingRunNumber: BR-00000005
                billingRunType: Regular
                createdById: 2c92c0f97a98ca23017a990996124672
                createdDate: '2022-04-25T19:08:32-07:00'
                endDate: '2022-04-25T19:08:37-07:00'
                executedDate: '2022-04-25T19:08:34-07:00'
                id: 8ad0887e805061c8018063a09fe2685a
                includeOrderLineItems: true
                includeSubscriptions: true
                invoiceDate: '2022-04-25'
                invoicesEmailed: false
                noEmailForZeroAmountInvoice: false
                numberOfAccounts: 1
                numberOfCreditMemos: 0
                numberOfInvoices: 1
                startDate: '2022-04-25T19:08:34-07:00'
                status: Completed
                targetDate: '2022-07-30'
                targetType: SingleAccount
                totalTime: 3384
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-02-06T23:10:15-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedBillingRun'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contacts:
    get:
      summary: List contacts
      description: >
        Lists contacts. You can use the query parameters to filter, expand, and
        sort the returned results.
      operationId: queryContacts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - country
              - firstname
              - lastname
              - personalemail
              - workemail
              - workphone
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Contact object does not support expanding any related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - country
              - firstname
              - lastname
              - personalemail
              - workemail
              - workphone
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTExLTEwVDA0OjQ3OjM2LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODc1OTkyZjYzMjhlMDE5MzE2MWQ5MWEzMjdlNiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8ad087599521829e0195226d641312bd
                    address1: 101 Redwood Shores Pkwy
                    city: Redwood City
                    country: United States
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-02-20T00:15:49-08:00'
                    firstName: Amy
                    id: 8ad087599521829e0195226d642112be
                    lastName: Lawrence
                    state: California
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-02-20T00:15:49-08:00'
                    workEmail: amy.lawrence@zuora.com
              schema:
                type: object
                title: QueryContactsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedContact'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contacts/{key}:
    get:
      summary: Retrieve a contact
      description: |
        Retrieve the details of a specific Contact object.
      operationId: queryContactByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Contact object does not support expanding any related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad087599521829e0195226d641312bd
                address1: 101 Redwood Shores Pkwy
                city: Redwood City
                country: United States
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-02-20T00:15:49-08:00'
                firstName: Amy
                id: 8ad087599521829e0195226d642112be
                lastName: Lawrence
                state: California
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-02-20T00:15:49-08:00'
                workEmail: amy.lawrence@zuora.com
              schema:
                $ref: '#/components/schemas/ExpandedContact'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memos:
    get:
      summary: List credit memos
      description: >
        Lists credit memos. You can use the query parameters to filter, expand,
        and sort the returned results.
      operationId: queryCreditMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - balance
              - einvoicestatus
              - memodate
              - memonumber
              - sourcetype
              - status
              - totalamount
              - invoiceid
              - accountid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - creditmemoitems
                - creditmemoitems.subscription
                - creditmemoitems.subscription.account
                - creditmemoapplications
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - balance
              - einvoicestatus
              - memodate
              - memonumber
              - sourcetype
              - status
              - totalamount
              - invoiceid
              - accountid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
              
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTA3LTIxVDIwOjEzOjQwLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODdkMjkwYzRiYjJhMDE5MGQ4NmUzNTkzNzAyZiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8ad09be48db5aba7018db604776d4854
                    appliedAmount: 112.43
                    autoApplyUponPosting: false
                    balance: 0
                    billToContactId: 8ad09be48db5aba7018db60477a84855
                    createdById: 8ad09fc28193c189018194da28be74ba
                    createdDate: '2024-08-28T23:32:58-07:00'
                    currency: USD
                    discountAmount: 0
                    exchangeRateDate: '2024-08-28'
                    excludeFromAutoApplyRules: false
                    id: 8ad097b49198384c01919cd658d21c46
                    invoiceId: 8ad084db909fae930190a12599477394
                    memoDate: '2024-09-27'
                    memoNumber: CM00000013
                    postedById: 8ad09fc28193c189018194da28be74ba
                    postedOn: '2024-08-28T23:32:58-07:00'
                    reasonCode: Write-off
                    refundAmount: 0
                    revenueImpacting: 'Yes'
                    reversed: false
                    sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145
                    source: AdhocFromInvoice
                    sourceType: Invoice
                    status: Posted
                    taxAmount: 0
                    taxAutoCalculation: true
                    totalAmount: 112.43
                    totalAmountWithoutTax: 112.43
                    totalTaxExemptAmount: 0
                    updatedById: 8ad09fc28193c189018194da28be74ba
                    updatedDate: '2024-08-28T23:32:59-07:00'
              schema:
                type: object
                title: QueryCreditMemosResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedCreditMemo'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memos/{key}:
    get:
      summary: Retrieve a credit memo
      description: |
        Retrieve the details of a specific Credit Memo object.
      operationId: queryCreditMemoByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - creditmemoitems
                - creditmemoitems.subscription
                - creditmemoitems.subscription.account
                - creditmemoapplications
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad09be48db5aba7018db604776d4854
                appliedAmount: 112.43
                autoApplyUponPosting: false
                balance: 0
                billToContactId: 8ad09be48db5aba7018db60477a84855
                createdById: 8ad09fc28193c189018194da28be74ba
                createdDate: '2024-08-28T23:32:58-07:00'
                currency: USD
                discountAmount: 0
                exchangeRateDate: '2024-08-28'
                excludeFromAutoApplyRules: false
                id: 8ad097b49198384c01919cd658d21c46
                invoiceId: 8ad084db909fae930190a12599477394
                memoDate: '2024-09-27'
                memoNumber: CM00000013
                postedById: 8ad09fc28193c189018194da28be74ba
                postedOn: '2024-08-28T23:32:58-07:00'
                reasonCode: Write-off
                refundAmount: 0
                revenueImpacting: 'Yes'
                reversed: false
                sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145
                source: AdhocFromInvoice
                sourceType: Invoice
                status: Posted
                taxAmount: 0
                taxAutoCalculation: true
                totalAmount: 112.43
                totalAmountWithoutTax: 112.43
                totalTaxExemptAmount: 0
                updatedById: 8ad09fc28193c189018194da28be74ba
                updatedDate: '2024-08-28T23:32:59-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedCreditMemo'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-applications:
    get:
      summary: List credit memo applications
      description: >
        Lists credit memo applications. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryCreditMemoApplications
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - effectivedate
              - accountid
              - applicationgroupid
              - debitmemoid
              - invoiceid
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - creditmemo
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - effectivedate
              - accountid
              - applicationgroupid
              - debitmemoid
              - invoiceid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTA4LTE5VDIyOjU1OjExLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxNjk4YjI4MDE5MTZlNWE4NTYyNTY1OCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8ad09be48db5aba7018db604776d4854
                    amount: 112.43
                    applicationGroupId: 8ad097b49198384c01919cd659b31c58
                    createdById: 8ad09fc28193c189018194da28be74ba
                    createdDate: '2024-08-28T23:32:59-07:00'
                    creditMemoId: 8ad097b49198384c01919cd658d21c46
                    effectiveDate: '2024-09-27'
                    id: 8ad097b49198384c01919cd659be1c64
                    updatedById: 8ad09fc28193c189018194da28be74ba
                    updatedDate: '2024-08-28T23:32:59-07:00'
              schema:
                type: object
                title: QueryCreditMemoApplicationsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedCreditMemoApplication'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-applications/{key}:
    get:
      summary: Retrieve a credit memo application
      description: |
        Retrieve the details of a specific Credit Memo Application object.
      operationId: queryCreditMemoApplicationByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - creditmemo
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad09be48db5aba7018db604776d4854
                amount: 112.43
                applicationGroupId: 8ad097b49198384c01919cd659b31c58
                createdById: 8ad09fc28193c189018194da28be74ba
                createdDate: '2024-08-28T23:32:59-07:00'
                creditMemoId: 8ad097b49198384c01919cd658d21c46
                effectiveDate: '2024-09-27'
                id: 8ad097b49198384c01919cd659be1c64
                updatedById: 8ad09fc28193c189018194da28be74ba
                updatedDate: '2024-08-28T23:32:59-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedCreditMemoApplication'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-items:
    get:
      summary: List credit memo items
      description: >
        Lists credit memo items. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryCreditMemoItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - excludeitembillingfromrevenueaccounting
              - sourceitemtype
              - chargenumber
              - subscriptionid
              - subscriptionnumber
              - invoiceitemid
              - rateplanchargeid
              - creditmemoid
              
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - credittaxationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - excludeitembillingfromrevenueaccounting
              - fulfillmentid
              - orderlineitemid
              - sourceitemtype
              - chargenumber
              - subscriptionid
              - subscriptionnumber
              - invoiceitemid
              - rateplanchargeid
              - creditmemoid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTA4LTE5VDIyOjU5OjU0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxNjk4YjI4MDE5MTZlNWE4NGU2NTY1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    amount: 105
                    amountWithoutTax: 105
                    appliedToOthersAmount: 105
                    beAppliedByOthersAmount: 0
                    chargeDate: '2024-08-28T23:32:58-07:00'
                    chargeName: Monthly Fee
                    createdById: 8ad09fc28193c189018194da28be74ba
                    createdDate: '2024-08-28T23:32:58-07:00'
                    creditFromItemId: 8ad084db909fae930190a12599697395
                    creditFromItemSource: InvoiceItem
                    creditMemoId: 8ad097b49198384c01919cd658d21c46
                    deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    excludeItemBillingFromRevenueAccounting: false
                    id: 8ad097b49198384c01919cd659211c4a
                    invoiceItemId: 8ad084db909fae930190a12599697395
                    numberOfDeliveries: 0
                    processingType: '0'
                    productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
                    quantity: 1
                    recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    reflectDiscountInNetAmount: false
                    revenueImpacting: 'Yes'
                    serviceEndDate: '2024-07-11'
                    serviceStartDate: '2024-07-11'
                    sku: SKUE-00000026
                    sourceItemType: InvoiceDetail
                    taxAmount: 0
                    taxExemptAmount: 0
                    taxMode: TaxExclusive
                    unappliedAmount: 0
                    unitOfMeasure: ''
                    unitPrice: 0
                    updatedById: 8ad09fc28193c189018194da28be74ba
                    updatedDate: '2024-08-28T23:33:00-07:00'
              schema:
                type: object
                title: QueryCreditMemoItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedCreditMemoItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/credit-memo-items/{key}:
    get:
      summary: Retrieve a credit memo item
      description: |
        Retrieve the details of a specific Credit Memo Item object.
      operationId: queryCreditMemoItemByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - credittaxationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                amount: 105
                amountWithoutTax: 105
                appliedToOthersAmount: 105
                beAppliedByOthersAmount: 0
                chargeDate: '2024-08-28T23:32:58-07:00'
                chargeName: Monthly Fee
                createdById: 8ad09fc28193c189018194da28be74ba
                createdDate: '2024-08-28T23:32:58-07:00'
                creditFromItemId: 8ad084db909fae930190a12599697395
                creditFromItemSource: InvoiceItem
                creditMemoId: 8ad097b49198384c01919cd658d21c46
                deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                excludeItemBillingFromRevenueAccounting: false
                id: 8ad097b49198384c01919cd659211c4a
                invoiceItemId: 8ad084db909fae930190a12599697395
                numberOfDeliveries: 0
                processingType: '0'
                productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
                quantity: 1
                recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                reflectDiscountInNetAmount: false
                revenueImpacting: 'Yes'
                serviceEndDate: '2024-07-11'
                serviceStartDate: '2024-07-11'
                sku: SKUE-00000026
                sourceItemType: InvoiceDetail
                taxAmount: 0
                taxExemptAmount: 0
                taxMode: TaxExclusive
                unappliedAmount: 0
                unitOfMeasure: ''
                unitPrice: 0
                updatedById: 8ad09fc28193c189018194da28be74ba
                updatedDate: '2024-08-28T23:33:00-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedCreditMemoItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/daily-consumption-summaries:
    get:
      summary: List daily consumption summaries
      description: >
        Lists daily consumption summaries. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryDailyConsumptionSummaries
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.
            Supported filterable fields: 
              - id
              - updateddate
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryDebitMemoItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDailyConsumptionSummary'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/daily-consumption-summaries/{key}:
    get:
      summary: Retrieve a daily consumption summary
      description: |
        Retrieve the details of a specific Daily Consumption Summary object.
      operationId: queryDailyConsumptionSummaryByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                chargeSegmentNumber: 2
                createdById: '00000000000000000000000000000003'
                createdDate: '2024-02-28T01:36:50-08:00'
                dailyConsumptionAmount: 0
                dailyGroupSummaryId: 1dc86d68f6095de88ad084f08858a719
                dailyTotalQuantity: 45
                id: 8ad093c18deeb97e018def12ea3b3fcb
                originChargeId: 8ad098317f3a75bf017f3edfbb402b57
                ratingResultId: 8ad093c18deeb97e018def12ea353fca
                transactionDate: '2023-05-16'
                updatedById: '00000000000000000000000000000003'
                updatedDate: '2024-02-28T01:36:50-08:00'
                usageChargeName: usage-per unit
                usageChargeNumber: C-00000274
              schema:
                $ref: '#/components/schemas/ExpandedDailyConsumptionSummary'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memos:
    get:
      summary: List debit memos
      description: >
        Lists debit memos. You can use the query parameters to filter, expand,
        and sort the returned results.
      operationId: queryDebitMemos
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - balance
              - creditmemoid
              - einvoicestatus
              - memodate
              - memonumber
              - sourcetype
              - status
              - totalamount
              - invoiceid
              - accountid      
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - debitmemoitems
                - debitmemoitems.subscription
                - debitmemoitems.subscription.account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - balance
              - creditmemoid
              - einvoicestatus
              - memodate
              - memonumber
              - sourcetype
              - status
              - totalamount
              - invoiceid
              - accountid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountId: 8ad09be48db5aba7018db604776d4854
                    autoPay: true
                    balance: 10
                    createdById: b243314d594646d3b2651aeedd4be47e
                    createdDate: '2024-08-19T23:14:11-07:00'
                    currency: USD
                    discountAmount: 0
                    dueDate: '2024-09-18'
                    id: 8ad093789169a0c001916e6be7cf7113
                    memoDate: '2024-08-19'
                    memoNumber: DM00000002
                    reasonCode: Correcting invoice error
                    source: AdhocFromPrpc
                    sourceType: Standalone
                    status: Draft
                    taxAmount: 0
                    taxAutoCalculation: true
                    taxStatus: Complete
                    totalAmount: 10
                    totalAmountWithoutTax: 10
                    totalTaxExemptAmount: 0
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-08-19T23:14:11-07:00'
              schema:
                type: object
                title: QueryDebitMemosResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDebitMemo'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memos/{key}:
    get:
      summary: Retrieve a debit memo
      description: |
        Retrieve the details of a specific Debit Memo object.
      operationId: queryDebitMemoByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - debitmemoitems
                - debitmemoitems.subscription
                - debitmemoitems.subscription.account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad09be48db5aba7018db604776d4854
                autoPay: true
                balance: 10
                createdById: b243314d594646d3b2651aeedd4be47e
                createdDate: '2024-08-19T23:14:11-07:00'
                currency: USD
                discountAmount: 0
                dueDate: '2024-09-18'
                id: 8ad093789169a0c001916e6be7cf7113
                memoDate: '2024-08-19'
                memoNumber: DM00000002
                reasonCode: Correcting invoice error
                source: AdhocFromPrpc
                sourceType: Standalone
                status: Draft
                taxAmount: 0
                taxAutoCalculation: true
                taxStatus: Complete
                totalAmount: 10
                totalAmountWithoutTax: 10
                totalTaxExemptAmount: 0
                updatedById: b243314d594646d3b2651aeedd4be47e
                updatedDate: '2024-08-19T23:14:11-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedDebitMemo'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memo-items:
    get:
      summary: List debit memo items
      description: >
        Lists debit memo items. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryDebitMemoItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - creditmemoitemid
              - excludeitembillingfromrevenueaccounting
              - sourceitemtype
              - chargenumber
              - subscriptionid
              - subscriptionnumber
              - invoiceitemid
              - productrateplanchargeid
              - rateplanchargeid
              - debitmemoid  
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - debittaxationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - creditmemoitemid
              - excludeitembillingfromrevenueaccounting
              - sourceitemtype
              - chargenumber
              - subscriptionid
              - subscriptionnumber
              - invoiceitemid
              - productrateplanchargeid
              - rateplanchargeid
              - debitmemoid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    amount: 10
                    amountWithoutTax: 10
                    appliedToOthersAmount: 0
                    balance: 10
                    beAppliedByOthersAmount: 0
                    chargeDate: '2024-08-19T23:14:11-07:00'
                    chargeName: Monthly Fee
                    createdById: b243314d594646d3b2651aeedd4be47e
                    createdDate: '2024-08-19T23:14:11-07:00'
                    debitMemoId: 8ad093789169a0c001916e6be7cf7113
                    deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    description: ''
                    excludeItemBillingFromRevenueAccounting: false
                    id: 8ad093789169a0c001916e6be8127114
                    itemSoldToContactId: 8ad09be48db5aba7018db60477a84855
                    processingType: '0'
                    productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
                    quantity: 1
                    recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    serviceEndDate: '2030-04-01'
                    serviceStartDate: '2024-05-21'
                    sku: SKUE-00000026
                    sourceItemType: ProductRatePlanCharge
                    taxAmount: 0
                    taxExemptAmount: 0
                    unitOfMeasure: ''
                    unitPrice: 10
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-08-19T23:14:11-07:00'
              schema:
                type: object
                title: QueryDebitMemoItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDebitMemoItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/debit-memo-items/{key}:
    get:
      summary: Retrieve a debit memo item
      description: |
        Retrieve the details of a specific Debit Memo Item object.
      operationId: queryDebitMemoItemByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - rateplancharge
                - subscriptionowner
                - debittaxationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                amount: 10
                amountWithoutTax: 10
                appliedToOthersAmount: 0
                balance: 10
                beAppliedByOthersAmount: 0
                chargeDate: '2024-08-19T23:14:11-07:00'
                chargeName: Monthly Fee
                createdById: b243314d594646d3b2651aeedd4be47e
                createdDate: '2024-08-19T23:14:11-07:00'
                debitMemoId: 8ad093789169a0c001916e6be7cf7113
                deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                description: ''
                excludeItemBillingFromRevenueAccounting: false
                id: 8ad093789169a0c001916e6be8127114
                itemSoldToContactId: 8ad09be48db5aba7018db60477a84855
                processingType: '0'
                productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
                quantity: 1
                recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                serviceEndDate: '2030-04-01'
                serviceStartDate: '2024-05-21'
                sku: SKUE-00000026
                sourceItemType: ProductRatePlanCharge
                taxAmount: 0
                taxExemptAmount: 0
                unitOfMeasure: ''
                unitPrice: 10
                updatedById: b243314d594646d3b2651aeedd4be47e
                updatedDate: '2024-08-19T23:14:11-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedDebitMemoItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/delivery-adjustments:
    get:
      summary: List delivery adjustments
      description: >
        Lists Delivery Adjustment objects. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryDeliveryAdjustments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - adjustmentnumber
              - creditmemonumber
              - creditmemoid
              - debitmemonumber
             - segmentid
             - chargeid
              - chargenumber
              - subscriptionid
             - subscriptionnumber
              - originalsubid
              - accountid
              - invoiceowneraccountid
             - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - adjustmentnumber
              - creditmemonumber
              - creditmemoid
              - debitmemonumber
             - segmentid
             - chargeid
              - chargenumber
              - subscriptionid
             - subscriptionnumber
              - originalsubid
             - accountid
             - invoiceowneraccountid
             - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTAzLTE5VDE1OjMzOjAzKzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwYTA0ZDhlNTU0ODNkMDE4ZTU1YTBjNzY4NDRiZSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8a90f13b8da1afeb018da27a1e7c1122
                    adjustmentNumber: ADJ-00000209
                    amount: -1.7
                    amountPerUnit: 1.7
                    billingDate: '2025-05-19'
                    chargeId: edcad42faf796eabde76eb9b87e30028
                    chargeNumber: C-00034922
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    createdDate: '2025-05-20T10:55:40+08:00'
                    creditMemoId: 8a90def796ead18a0196eb9e47164124
                    creditMemoNumber: CM00000698
                    date: '2025-05-12'
                    deferredAccountingCode: ''
                    deliveryDay: monday
                    id: 8a90def796ead18a0196eb9e465b4123
                    invoiceOwnerAccountId: 8a90f13b8da1afeb018da27a1e7c1122
                    numberOfDeliveries: 1
                    originalSubId: edcad42faf796eabde76eb9b87e30026
                    reason: ''
                    recognizedRevenueAccountingCode: ''
                    revenueRecognitionRuleName: ''
                    segmentId: edcad42faf796eabde76eb9b87e30028
                    status: Billed
                    subscriptionId: edcad42faf796eabde76eb9b87e30026
                    subscriptionNumber: A-S00004451
                    type: DeliveryCredit
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2025-05-20T10:55:40+08:00'
              schema:
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedDeliveryAdjustment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/delivery-adjustments/{key}:
    get:
      summary: Retrieve a delivery adjustment
      description: >
        Retrieves a Delivery Adjustment object. You can use the query parameters
        to filter, expand, and sort the returned results.
      operationId: queryDeliveryAdjustmentByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - in: path
          name: key
          required: true
          schema:
            type: string
          description: |
            ID or number of the delivery adjustment.
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields include: 
              - id
              - adjustmentnumber
              - creditmemonumber
              - creditmemoid
              - debitmemonumber
             - segmentid
             - chargeid
              - chargenumber
              - subscriptionid
             - subscriptionnumber
              - originalsubid
             - accountid
             - invoiceowneraccountid
             - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
             Supported sortable fields include: 
              - id
              - adjustmentnumber
              - creditmemonumber
              - creditmemoid
              - debitmemonumber
             - segmentid
             - chargeid
              - chargenumber
              - subscriptionid
             - subscriptionnumber
              - originalsubid
              - accountid
              - invoiceowneraccountid
             - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8a90f13b8da1afeb018da27a1e7c1122
                adjustmentNumber: ADJ-00000209
                amount: -1.7
                amountPerUnit: 1.7
                billingDate: '2025-05-19'
                chargeId: edcad42faf796eabde76eb9b87e30028
                chargeNumber: C-00034922
                createdById: 2c92c8f95e2d6ebb015e325df48e02da
                createdDate: '2025-05-20T10:55:40+08:00'
                creditMemoId: 8a90def796ead18a0196eb9e47164124
                creditMemoNumber: CM00000698
                date: '2025-05-12'
                deferredAccountingCode: ''
                deliveryDay: monday
                id: 8a90def796ead18a0196eb9e465b4123
                invoiceOwnerAccountId: 8a90f13b8da1afeb018da27a1e7c1122
                numberOfDeliveries: 1
                originalSubId: edcad42faf796eabde76eb9b87e30026
                reason: ''
                recognizedRevenueAccountingCode: ''
                revenueRecognitionRuleName: ''
                segmentId: edcad42faf796eabde76eb9b87e30028
                status: Billed
                subscriptionId: edcad42faf796eabde76eb9b87e30026
                subscriptionNumber: A-S00004451
                type: DeliveryCredit
                updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                updatedDate: '2025-05-20T10:55:40+08:00'
              schema:
                $ref: '#/components/schemas/ExpandedDeliveryAdjustment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/fulfillments:
    get:
      summary: List fulfillments
      description: >
        Lists Fulfillment objects. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryFulfillments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
             - updateddate
              
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - createddate
              - updateddate
              - orderlineitemid - fulfillmentnumber
             - state
             - externalid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTExLTEzVDIzOjA0OjQ5KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwZDdhODkzMjU2ZGZkMDE5MzI2MGU0NWNiMDBkYiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - billTargetDate: '2025-07-14'
                    createdById: a0933229dfcd41f3a977efa52be31667
                    createdDate: '2025-07-14T12:01:58+08:00'
                    excludeItemBillingFromRevenueAccounting: false
                    excludeItemBookingFromRevenueAccounting: false
                    fulfillmentDate: '2025-07-14'
                    fulfillmentNumber: F-00000166
                    fulfillmentType: Delivery
                    id: 8a90f48297fbc4bf01980718bd9a0034
                    orderLineItemId: 8a90ff9297fbc4ee01980714649212d6
                    quantity: 100
                    state: SentToBilling
                    updatedById: a0933229dfcd41f3a977efa52be31667
                    updatedDate: '2025-07-14T12:01:58+08:00'
              schema:
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedFulfillment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/fulfillments/{key}:
    get:
      summary: Retrieve a fulfillment
      description: >
        Retrieves a Fulfillment object. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryFulfillmentByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - in: path
          name: key
          required: true
          schema:
            type: string
          description: |
            ID or number of the fulfillment.
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
             - updateddate
              
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - createddate
              - updateddate
              - orderlineitemid - fulfillmentnumber
             - state
             - externalid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                billTargetDate: '2025-07-14'
                createdById: a0933229dfcd41f3a977efa52be31667
                createdDate: '2025-07-14T12:01:58+08:00'
                excludeItemBillingFromRevenueAccounting: false
                excludeItemBookingFromRevenueAccounting: false
                fulfillmentDate: '2025-07-14'
                fulfillmentNumber: F-00000166
                fulfillmentType: Delivery
                id: 8a90f48297fbc4bf01980718bd9a0034
                orderLineItemId: 8a90ff9297fbc4ee01980714649212d6
                quantity: 100
                state: SentToBilling
                updatedById: a0933229dfcd41f3a977efa52be31667
                updatedDate: '2025-07-14T12:01:58+08:00'
              schema:
                $ref: '#/components/schemas/ExpandedFulfillment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoices:
    get:
      summary: List invoices
      description: >
        Lists invoices. You can use the query parameters to filter, expand, and
        sort the returned results.
      operationId: queryInvoices
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - amount
              - balance
              - duedate
              - invoicedate
              - invoicenumber
              - reversed
              - sourceid
              - sourcetype
              - status
              - einvoicestatus     
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - account.shipto
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - invoiceitems
                - invoiceitems.subscription
                - invoiceitems.subscription.account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - amount
              - balance
              - duedate
              - invoicedate
              - invoicenumber
              - reversed
              - sourceid
              - sourcetype
              - status
              - einvoicestatus
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: MTA=
                data:
                  - accountId: 8ad0875995a3ed800195a43a2ea40437
                    adjustmentAmount: 0
                    amount: 7300
                    amountWithoutTax: 7300
                    autoPay: true
                    balance: 7300
                    billToContactId: 8ad0875995a3ed800195a43a2ed30438
                    comments: ''
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-21T01:42:47-07:00'
                    creditBalanceAdjustmentAmount: 0
                    creditMemoAmount: 0
                    currency: USD
                    dueDate: '2025-04-20'
                    id: 8ad0875995aa292e0195b7de80796305
                    includesOneTime: true
                    includesRecurring: true
                    includesUsage: true
                    invoiceDate: '2025-03-21'
                    invoiceNumber: INV00000255
                    paymentAmount: 0
                    paymentTerm: Net 30
                    postedBy: 2c92c0f972a852360172bbe22ac551b6
                    postedDate: '2025-03-21T01:42:47-07:00'
                    refundAmount: 0
                    reversed: false
                    sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145
                    source: API
                    sourceType: Subscription
                    status: Posted
                    targetDate: '2025-03-21'
                    taxAmount: 0
                    taxExemptAmount: 0
                    templateId: 2c92c0f86cccaa59016cd5e0f500111d
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-21T01:42:47-07:00'
              schema:
                type: object
                title: QueryInvoicesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedInvoice'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoices/{key}:
    get:
      summary: Retrieve an invoice
      description: |
        Retrieve the details of a specific Invoice object.
      operationId: queryInvoiceByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - account.shipto
                - billtocontact
                - billtocontactsnapshot
                - soldtocontactsnapshot
                - shiptocontactsnapshot
                - invoiceitems
                - invoiceitems.subscription
                - invoiceitems.subscription.account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad0875995a3ed800195a43a2ea40437
                adjustmentAmount: 0
                amount: 7300
                amountWithoutTax: 7300
                autoPay: true
                balance: 7300
                billToContactId: 8ad0875995a3ed800195a43a2ed30438
                comments: ''
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-21T01:42:47-07:00'
                creditBalanceAdjustmentAmount: 0
                creditMemoAmount: 0
                currency: USD
                dueDate: '2025-04-20'
                id: 8ad0875995aa292e0195b7de80796305
                includesOneTime: true
                includesRecurring: true
                includesUsage: true
                invoiceDate: '2025-03-21'
                invoiceNumber: INV00000255
                paymentAmount: 0
                paymentTerm: Net 30
                postedBy: 2c92c0f972a852360172bbe22ac551b6
                postedDate: '2025-03-21T01:42:47-07:00'
                refundAmount: 0
                reversed: false
                sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145
                source: API
                sourceType: Subscription
                status: Posted
                targetDate: '2025-03-21'
                taxAmount: 0
                taxExemptAmount: 0
                templateId: 2c92c0f86cccaa59016cd5e0f500111d
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-21T01:42:47-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedInvoice'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-items:
    get:
      summary: List invoice items
      description: >
        Lists invoice items. You can use the query parameters to filter, expand,
        and sort the returned results.


        **Note**: You must specify a `filter[]` query parameter to query invoice
        items.
      operationId: queryInvoiceItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - rateplanchargeid
              - invoiceid
              - accountingcode
              - chargedate
              - chargenumber
              - excludeitembillingfromrevenueaccounting
              - servicestartdate
              - serviceenddate
              - sourceitemtype
              - subscriptionid
              - subscriptionnumber
              - productrateplanchargeid
              - bookingreference
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoice
                - subscription
                - subscriptionowner
                - taxationitems
                - rateplancharge
                - orderlineitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - rateplanchargeid
              - invoiceid
              - accountingcode
              - chargedate
              - chargenumber
              - excludeitembillingfromrevenueaccounting
              - fulfillmentid
              - servicestartdate
              - serviceenddate
              - sourceitemtype
              - subscriptionid
              - subscriptionnumber
              - productrateplanchargeid
              - bookingreference
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: MTA=
                data:
                  - accountId: 2c92c0f87270a5970172747e289a5e66
                    accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    accountingCode: Subscription Revenue
                    appliedToInvoiceItemId: 8ad0875995cd65b60195cd7b76771f12
                    balance: 0
                    billToContactId: 2c92c0f87270a5970172747e28aa5e67
                    chargeAmount: -200
                    chargeDate: '2025-03-25T06:26:15-07:00'
                    chargeName: Percentage discount
                    chargeNumber: C-00000522
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-25T06:26:15-07:00'
                    defaultPaymentMethodId: 2c92c0f872bc58ec0172c06fe2f07422
                    deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    description: ''
                    discountAmount: 0
                    excludeItemBillingFromRevenueAccounting: false
                    id: 8ad0875995cd65b60195cd7b76771f13
                    invoiceId: 8ad0875995cd65b60195cd7b76621f03
                    itemSoldToContactId: 2c92c0f87270a5970172747e28aa5e67
                    numberOfDeliveries: 0
                    processingType: '1'
                    productId: 8ad08ea194da7ba00194df52a41f04c6
                    productRatePlanChargeId: f94f16628be952195f3522404efb0010
                    productRatePlanId: f94fbebf61e952182765223a7a1d0000
                    quantity: 1
                    ratePlanChargeId: f94fb52490e95cd65925cd7b737600c1
                    ratePlanId: f94fb52490e95cd65925cd7b73df00c6
                    recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    reflectDiscountInNetAmount: false
                    sKU: SKU-001
                    serviceEndDate: '2025-02-28'
                    serviceStartDate: '2025-02-01'
                    soldToContactId: 2c92c0f87270a5970172747e28aa5e67
                    sourceItemType: SubscriptionComponent
                    subscriptionId: f94fb52490e95cd65925cd7b737400bd
                    subscriptionNumber: A-S00000159
                    subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
                    taxAmount: 0
                    taxExemptAmount: 0
                    uOM: ''
                    unitPrice: 20
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-25T06:26:16-07:00'
              schema:
                type: object
                title: QueryInvoiceItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedInvoiceItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-items/{key}:
    get:
      summary: Retrieve an invoice item
      description: |
        Retrieve the details of a specific Invoice Item object.
      operationId: queryInvoiceItemByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoice
                - subscription
                - subscriptionowner
                - taxationitems
                - rateplancharge
                - orderlineitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f87270a5970172747e289a5e66
                accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                accountingCode: Subscription Revenue
                appliedToInvoiceItemId: 8ad0875995cd65b60195cd7b76771f12
                balance: 0
                billToContactId: 2c92c0f87270a5970172747e28aa5e67
                chargeAmount: -200
                chargeDate: '2025-03-25T06:26:15-07:00'
                chargeName: Percentage discount
                chargeNumber: C-00000522
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-25T06:26:15-07:00'
                defaultPaymentMethodId: 2c92c0f872bc58ec0172c06fe2f07422
                deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                description: ''
                discountAmount: 0
                excludeItemBillingFromRevenueAccounting: false
                id: 8ad0875995cd65b60195cd7b76771f13
                invoiceId: 8ad0875995cd65b60195cd7b76621f03
                itemSoldToContactId: 2c92c0f87270a5970172747e28aa5e67
                numberOfDeliveries: 0
                processingType: '1'
                productId: 8ad08ea194da7ba00194df52a41f04c6
                productRatePlanChargeId: f94f16628be952195f3522404efb0010
                productRatePlanId: f94fbebf61e952182765223a7a1d0000
                quantity: 1
                ratePlanChargeId: f94fb52490e95cd65925cd7b737600c1
                ratePlanId: f94fb52490e95cd65925cd7b73df00c6
                recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                reflectDiscountInNetAmount: false
                sKU: SKU-001
                serviceEndDate: '2025-02-28'
                serviceStartDate: '2025-02-01'
                soldToContactId: 2c92c0f87270a5970172747e28aa5e67
                sourceItemType: SubscriptionComponent
                subscriptionId: f94fb52490e95cd65925cd7b737400bd
                subscriptionNumber: A-S00000159
                subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
                taxAmount: 0
                taxExemptAmount: 0
                uOM: ''
                unitPrice: 20
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-25T06:26:16-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedInvoiceItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-schedules:
    get:
      summary: List invoice schedules
      description: >
        Lists invoice schedules. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryInvoiceSchedules
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - nextrundate
              - number
              - accountid
              - status
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoicescheduleitems
                - invoicescheduleitems.invoice
                - invoicescheduleitems.creditmemo
                - invoiceschedulebookings
                - invoiceschedulebookings.order
                - invoiceschedulebookings.subscription
                - rateplancharges
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - nextrundate
              - number
              - accountid
              - status
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWQYXJ0aWFsbHlQcm9jZXNzZWQiLCJvcmRlckJ5pZWxkIjoiU3RhdHVzIiwib3JkZXIiOiJBU0MifX0seyJ2YWx1ZSI6IjZjNDAwYTk0N2FiOTE2NTgwMjM3MTlhYjk2Iiwib3JkZXJCeSI6eyJmaWVsZCI6IklkIIiOiJBU0MifX1d
                data:
                  - accountId: 8a90d6128dfe2666018e08990ccb1267
                    actualAmount: 25
                    additionalSubscriptionsToBill: '[]'
                    billedAmount: 0
                    createdById: 09539a92259e4f0886d67ed036798c96
                    createdDate: '2025-04-07T02:33:50-07:00'
                    currency: EUR
                    id: 06e21039c80241a280e6e65e73b6f3dd
                    nextRunDate: '2025-08-29'
                    notes: ''
                    number: IS-00000032
                    status: Pending
                    totalAmount: 25
                    unbilledAmount: 25
                    updatedById: 09539a92259e4f0886d67ed036798c96
                    updatedDate: '2025-04-07T02:33:51-07:00'
              schema:
                type: object
                title: QueryInvoiceSchedulesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedInvoiceSchedule'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/invoice-schedules/{key}:
    get:
      summary: Retrieve an invoice schedule
      description: |
        Retrieves the details of a specific Invoice Schedule object.
      operationId: queryInvoiceScheduleByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoicescheduleitems
                - invoicescheduleitems.invoice
                - invoicescheduleitems.creditmemo
                - invoiceschedulebookings
                - invoiceschedulebookings.order
                - invoiceschedulebookings.subscription
                - rateplancharges
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8a90d6128dfe2666018e08990ccb1267
                actualAmount: 25
                additionalSubscriptionsToBill: '[]'
                billedAmount: 0
                createdById: 09539a92259e4f0886d67ed036798c96
                createdDate: '2025-04-07T02:33:50-07:00'
                currency: EUR
                id: 06e21039c80241a280e6e65e73b6f3dd
                nextRunDate: '2025-08-29'
                notes: ''
                number: IS-00000032
                status: Pending
                totalAmount: 25
                unbilledAmount: 25
                updatedById: 09539a92259e4f0886d67ed036798c96
                updatedDate: '2025-04-07T02:33:51-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedInvoiceSchedule'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-actions:
    get:
      summary: List order actions
      description: >
        Lists order actions. You can use the query parameters to filter, expand,
        and sort the returned results.
      operationId: queryOrderActions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - subscriptionversionamendmentid
              - orderid
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - order
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - subscriptionversionamendmentid
              - orderid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAyLTE5VDIzOjMwOjE1LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYjUyNDljMTk1MjE4MjdiNTIyNDNhY2QzMGQyZiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - autoRenew: true
                    contractEffectiveDate: '2025-02-01'
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-25T06:26:14-07:00'
                    currentTerm: 12
                    currentTermPeriodType: Month
                    customerAcceptanceDate: '2025-02-01'
                    id: f94fb52490e95cd65925cd7b733100b8
                    orderId: f94fb52490e95cd65925cd7b733100b6
                    renewSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerm: 12
                    renewalTermPeriodType: Month
                    sequence: 0
                    serviceActivationDate: '2025-02-01'
                    subscriptionId: f94fb52490e95cd65925cd7b737400bd
                    subscriptionNumber: A-S00000159
                    subscriptionVersionAmendmentId: f94fb52490e95cd65925cd7b733100b7
                    termType: TERMED
                    type: CreateSubscription
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-25T06:26:14-07:00'
              schema:
                type: object
                title: QueryOrderActionsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedOrderAction'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-actions/{key}:
    get:
      summary: Retrieve an order action
      description: |
        Retrieve the details of a specific Order Action object.
      operationId: queryOrderActionByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - order
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                autoRenew: true
                contractEffectiveDate: '2025-02-01'
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-25T06:26:14-07:00'
                currentTerm: 12
                currentTermPeriodType: Month
                customerAcceptanceDate: '2025-02-01'
                id: f94fb52490e95cd65925cd7b733100b8
                orderId: f94fb52490e95cd65925cd7b733100b6
                renewSetting: RENEW_WITH_SPECIFIC_TERM
                renewalTerm: 12
                renewalTermPeriodType: Month
                sequence: 0
                serviceActivationDate: '2025-02-01'
                subscriptionId: f94fb52490e95cd65925cd7b737400bd
                subscriptionNumber: A-S00000159
                subscriptionVersionAmendmentId: f94fb52490e95cd65925cd7b733100b7
                termType: TERMED
                type: CreateSubscription
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-25T06:26:14-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedOrderAction'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-line-items:
    get:
      summary: List order line items
      description: >
        Lists order line items. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryOrderLineItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - itemname
              - itemnumber
              - itemstate
              - itemtype
              - orderid
              - productcode
              - productrateplanchargeid
              - uom
              - relatedsubscriptionnumber
              - inlinediscounttype
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoiceitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - itemname
              - itemnumber
              - itemstate
              - itemtype
              - orderid
              - productcode
              - productrateplanchargeid
              - billtoid
              - soldto
              - owneraccountid
              - invoiceowneraccountid
              - uom
              - relatedsubscriptionnumber
              - originalorderid
              - originalordernumber
              - originalorderlineitemid
              - inlinediscounttype
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
              
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDIzLTA2LTI4VDAzOjM5OjM1LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOGQyOTg4ZmNlYjE4MDE4OTAxOTY0ZjAzMDI1MyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - amount: 23
                    amountPerUnit: 23
                    amountWithoutTax: 23
                    billTargetDate: '2024-10-24'
                    billToId: 8ad093788fa4fba0018faaaa88d418ae
                    billToSnapshotId: 8ad093788fa4fba0018faaaa88d518af
                    billingRule: TriggerAsFulfillmentOccurs
                    createdById: 2c92c0f87270a597017273cf21dc64d4
                    createdDate: '2024-10-24T00:47:36-07:00'
                    currency: USD
                    deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    discount: 0
                    excludeItemBillingFromRevenueAccounting: false
                    excludeItemBookingFromRevenueAccounting: false
                    id: 8ad09be492b9e1480192bd7ecbf95a96
                    inlineDiscountPerUnit: 0
                    inlineDiscountType: None
                    invoiceOwnerAccountId: 8ad093788fa4fba0018faaaa88b618aa
                    invoiceTemplateId: 2c92c0f86cccaa59016cd5e0f500111d
                    isAllocationEligible: false
                    isUnbilled: false
                    itemCategory: Sales
                    itemName: testOLIItem
                    itemNumber: '1'
                    itemState: Booked
                    itemType: Fee
                    listPrice: 23
                    listPricePerUnit: 23
                    orderId: 8ad09be492b9e1480192bd7ecb9f5a8f
                    originalOrderDate: '2024-10-24'
                    ownerAccountId: 8ad093788fa4fba0018faaaa88b618aa
                    paymentTerm: Due Upon Receipt
                    quantity: 1
                    quantityAvailableForReturn: 0
                    quantityFulfilled: 0
                    quantityPendingFulfillment: 1
                    recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e108da1207
                    requiresFulfillment: true
                    revenueRecognitionRule: Recognize daily over time
                    sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145
                    soldTo: 8ad093788fa4fba0018faaaa88d418ae
                    soldToSnapshotId: 8ad093788fa4fba0018faaaa88d518af
                    transactionDate: '2024-10-24'
                    transactionEndDate: '2024-10-24'
                    transactionStartDate: '2024-10-24'
                    updatedById: 2c92c0f87270a597017273cf21dc64d4
                    updatedDate: '2024-10-24T00:47:36-07:00'
              schema:
                type: object
                title: QueryOrderLineItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedOrderLineItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/order-line-items/{key}:
    get:
      summary: Retrieve an order line item
      description: |
        Retrieve the details of a specific Order Line Item object.
      operationId: queryOrderLineItemByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - invoiceitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                amount: 23
                amountPerUnit: 23
                amountWithoutTax: 23
                billTargetDate: '2024-10-24'
                billToId: 8ad093788fa4fba0018faaaa88d418ae
                billToSnapshotId: 8ad093788fa4fba0018faaaa88d518af
                billingRule: TriggerAsFulfillmentOccurs
                createdById: 2c92c0f87270a597017273cf21dc64d4
                createdDate: '2024-10-24T00:47:36-07:00'
                currency: USD
                deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                discount: 0
                excludeItemBillingFromRevenueAccounting: false
                excludeItemBookingFromRevenueAccounting: false
                id: 8ad09be492b9e1480192bd7ecbf95a96
                inlineDiscountPerUnit: 0
                inlineDiscountType: None
                invoiceOwnerAccountId: 8ad093788fa4fba0018faaaa88b618aa
                invoiceTemplateId: 2c92c0f86cccaa59016cd5e0f500111d
                isAllocationEligible: false
                isUnbilled: false
                itemCategory: Sales
                itemName: testOLIItem
                itemNumber: '1'
                itemState: Booked
                itemType: Fee
                listPrice: 23
                listPricePerUnit: 23
                orderId: 8ad09be492b9e1480192bd7ecb9f5a8f
                originalOrderDate: '2024-10-24'
                ownerAccountId: 8ad093788fa4fba0018faaaa88b618aa
                paymentTerm: Due Upon Receipt
                quantity: 1
                quantityAvailableForReturn: 0
                quantityFulfilled: 0
                quantityPendingFulfillment: 1
                recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e108da1207
                requiresFulfillment: true
                revenueRecognitionRule: Recognize daily over time
                sequenceSetId: 2c92c0f86cccaa59016cd5e0faa91145
                soldTo: 8ad093788fa4fba0018faaaa88d418ae
                soldToSnapshotId: 8ad093788fa4fba0018faaaa88d518af
                transactionDate: '2024-10-24'
                transactionEndDate: '2024-10-24'
                transactionStartDate: '2024-10-24'
                updatedById: 2c92c0f87270a597017273cf21dc64d4
                updatedDate: '2024-10-24T00:47:36-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedOrderLineItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/orders:
    get:
      summary: List orders
      description: >
        Lists orders. You can use the query parameters to filter, expand, and
        sort the returned results.
      operationId: queryOrders
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - orderdate
              - ordernumber
              - accountid
              - status
              - invoicescheduleid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - orderlineitems
                - orderlineitems.invoiceitems
                - orderactions
                - orderactions.subscription
                - orderactions.subscription.rateplans
                - orderactions.subscription.rateplans.rateplancharges
          description: >-
            Allows you to expand responses by including related object
            information in a single call.


            **Note**: For draft and scheduled orders, information on the
            subscription, rate plan, and rate plan charges is not available nor
            displayed until the following conditions are met:

            - A scheduled order is executed and its status is changed to
            `completed`. 

            - A draft order is activated and its status is changed to `pending`
            or `completed`.


            For example, if an order is in the `scheduled` or `draft` status,
            information on the subscription, rate plan, and rate plan charges is
            not displayed.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - orderdate
              - ordernumber
              - accountid
              - status
              - invoicescheduleid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryOrdersResponse
                description: ''
                nullable: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedOrders'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/orders/{key}:
    get:
      summary: Retrieve an order
      description: |
        Retrieve the details of a specific Order object.
      operationId: queryOrdersByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - orderlineitems
                - orderlineitems.invoiceitems
                - orderactions
                - orderactions.subscription
                - orderactions.subscription.rateplans
                - orderactions.subscription.rateplans.rateplancharges
          description: >-
            Allows you to expand responses by including related object
            information in a single call.


            **Note**: For draft and scheduled orders, information on the
            subscription, rate plan, and rate plan charges is not available nor
            displayed until the following conditions are met:

            - A scheduled order is executed and its status is changed to
            `completed`. 

            - A draft order is activated and its status is changed to `pending`
            or `completed`.


            For example, if an order is in the `scheduled` or `draft` status,
            information on the subscription, rate plan, and rate plan charges is
            not displayed.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.
            Supported filterable fields: 
              - id
              - updateddate
              - orderdate
              - ordernumber
              - accountid
              - status
              - invoicescheduleid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f87270a5970172747e289a5e66
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdByMigration: false
                createdDate: '2025-03-25T06:26:14-07:00'
                description: >-
                  One Time Volume charge will be billed immediately, but
                  recurring charge delayed until specified date, 15 days later.
                  The specific date override changes the default -bill on the
                  Contract Effective Date behavior- defined on the charge in the
                  product catalog.
                id: f94fb52490e95cd65925cd7b733100b6
                orderDate: '2025-02-01'
                orderNumber: O-00000895
                reversionOrder: false
                state: Complete
                status: Completed
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-25T06:26:15-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedOrders'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payments:
    get:
      summary: List payments
      description: >
        Lists payments. You can use the query parameters to filter, expand, and
        sort the returned results.  
      operationId: queryPayments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - amount
              - effectivedate
              - gatewayorderid
              - gatewaystate
              - paymentmethodid
              - paymentmethodsnapshotid
              - paymentnumber
              - referenceid
              - source
              - sourcename
              - status
              - unappliedamount
              - createddate
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - paymentapplications
                - paymentscheduleitempayments
                - paymentscheduleitempayments.paymentscheduleitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - amount
              - effectivedate
              - gatewayorderid
              - gatewaystate
              - paymentmethodid
              - paymentmethodsnapshotid
              - paymentnumber
              - referenceid
              - source
              - sourcename
              - status
              - unappliedamount
              - createddate
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTA3LTIxVDIyOjUxOjUwLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTcwNDkwYzRlNTk3MDE5MGQ4ZmYwNmJkMzNlMCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8ad09be48db5aba7018db604776d4854
                    amount: 14.99
                    appliedAmount: 14.99
                    appliedCreditBalanceAmount: 0
                    bankIdentificationNumber: '411111'
                    comment: ''
                    createdById: 8ad09fc28193c189018194da28be74ba
                    createdDate: '2024-08-29T00:53:29-07:00'
                    currency: USD
                    effectiveDate: '2024-08-29'
                    gateway: test
                    gatewayResponse: This transaction has been approved by Test gateway.
                    gatewayResponseCode: approve
                    gatewayState: Submitted
                    id: 8ad097b49198384c01919d200fb53143
                    isStandalone: false
                    lastEmailDateTime: '2024-08-29T00:53:32-07:00'
                    paymentMethodId: 8ad084db90a5e73b0190c02783f552fa
                    paymentMethodSnapshotId: 8ad097b49198384c01919d200fab3141
                    paymentNumber: P-00000026
                    prepayment: false
                    referenceId: '3217674.800792635'
                    refundAmount: 0
                    source: Manually
                    status: Processed
                    submittedOn: '2024-08-29T00:53:30-07:00'
                    type: Electronic
                    unappliedAmount: 0
                    updatedById: 8ad09fc28193c189018194da28be74ba
                    updatedDate: '2024-08-29T00:53:30-07:00'
              schema:
                type: object
                title: QueryPaymentsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPayment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payments/{key}:
    get:
      summary: Retrieve a payment
      description: |
        Retrieve the details of a specific Payment object.
      operationId: queryPaymentByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - paymentapplications
                - paymentscheduleitempayments
                - paymentscheduleitempayments.paymentscheduleitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad09be48db5aba7018db604776d4854
                amount: 14.99
                appliedAmount: 14.99
                appliedCreditBalanceAmount: 0
                bankIdentificationNumber: '411111'
                comment: ''
                createdById: 8ad09fc28193c189018194da28be74ba
                createdDate: '2024-08-29T00:53:29-07:00'
                currency: USD
                effectiveDate: '2024-08-29'
                gateway: test
                gatewayResponse: This transaction has been approved by Test gateway.
                gatewayResponseCode: approve
                gatewayState: Submitted
                id: 8ad097b49198384c01919d200fb53143
                isStandalone: false
                lastEmailDateTime: '2024-08-29T00:53:32-07:00'
                paymentMethodId: 8ad084db90a5e73b0190c02783f552fa
                paymentMethodSnapshotId: 8ad097b49198384c01919d200fab3141
                paymentNumber: P-00000026
                prepayment: false
                referenceId: '3217674.800792635'
                refundAmount: 0
                source: Manually
                status: Processed
                submittedOn: '2024-08-29T00:53:30-07:00'
                type: Electronic
                unappliedAmount: 0
                updatedById: 8ad09fc28193c189018194da28be74ba
                updatedDate: '2024-08-29T00:53:30-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedPayment'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-applications:
    get:
      summary: List payment applications
      description: >
        Lists payment applications. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryPaymentApplications
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - effectivedate
              - accountid
              - paymentid
              - applicationgroupid
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - payment
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - effectivedate
              - accountid
              - paymentid
              - applicationgroupid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTA4LTI4VDIzOjQzOjU1LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkxOTgyNDkyMDE5MTljZTA1ZDA5MzU1MCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8ad0875992f6328e0193161d917527e5
                    accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    applicationGroupId: 8ad0980c92f64cda019318c7d84d46dc
                    applyAmount: 100
                    billingDocumentOwnerId: 8ad0875992f6328e0193161d917527e5
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2024-11-10T17:12:50-08:00'
                    effectiveDate: '2024-11-10'
                    id: 8ad0980c92f64cda019318c7d84d46de
                    invoiceId: 8ad08eb292f6328c019316356a7d5ab3
                    paymentApplicationStatus: Processed
                    paymentId: 8ad0980c92f64cda019318c7d82d46da
                    unappliedPaymentAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2024-11-10T17:12:50-08:00'
              schema:
                type: object
                title: QueryPaymentApplicationsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentApplication'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-applications/{key}:
    get:
      summary: Retrieve a payment application
      description: |
        Retrieve the details of a specific Payment Application object.
      operationId: queryPaymentApplicationByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - payment
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad0875992f6328e0193161d917527e5
                accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                applicationGroupId: 8ad0980c92f64cda019318c7d84d46dc
                applyAmount: 100
                billingDocumentOwnerId: 8ad0875992f6328e0193161d917527e5
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2024-11-10T17:12:50-08:00'
                effectiveDate: '2024-11-10'
                id: 8ad0980c92f64cda019318c7d84d46de
                invoiceId: 8ad08eb292f6328c019316356a7d5ab3
                paymentApplicationStatus: Processed
                paymentId: 8ad0980c92f64cda019318c7d82d46da
                unappliedPaymentAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2024-11-10T17:12:50-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedPaymentApplication'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-methods:
    get:
      summary: List payment methods
      description: >
        Lists payment methods. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryPaymentMethods
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - achaccountname
              - achbankname
              - achcountry
              - active
              - issystem
              - businessidentificationcode
              - country
              - creditcardexpirationmonth
              - creditcardexpirationyear
              - creditcardmasknumber
              - lasttransactiondatetime
              - paypalbaid
              - type
                    
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - achaccountname
              - achbankname
              - achcountry
              - active
              - issystem
              - businessidentificationcode
              - country
              - creditcardexpirationmonth
              - creditcardexpirationyear
              - creditcardmasknumber
              - lasttransactiondatetime
              - paypalbaid
              - type
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTA3LTE4VDIxOjIxOjMxLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODFkZDkwYzRiYWZlMDE5MGM5Mzk0NDQ0N2I5NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - active: false
                    bankIdentificationNumber: '411111'
                    cardBrand: Visa
                    cardClass: Credit
                    cardIssuingBank: UNKNOWN
                    cardIssuingCountry: ZZ
                    cardProductType: Consumer_Card
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-16T18:51:00-07:00'
                    creditCardExpirationMonth: 12
                    creditCardExpirationYear: 2028
                    creditCardHolderName: Amy Lawrence
                    creditCardMaskNumber: '************1111'
                    creditCardType: Visa
                    id: 8ad0869995911c870195a1cc10fb7930
                    isCompany: false
                    isSystem: false
                    lastTransactionDateTime: '2025-03-16T18:51:00-07:00'
                    lastTransactionStatus: Approved
                    numConsecutiveFailures: 0
                    paymentMethodStatus: Active
                    totalNumberOfErrorPayments: 0
                    totalNumberOfProcessedPayments: 0
                    type: CreditCard
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-16T18:51:00-07:00'
                    useDefaultRetryRule: true
              schema:
                type: object
                title: QueryPaymentMethodsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentMethod'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-methods/{key}:
    get:
      summary: Retrieve a payment method
      description: |
        Retrieve the details of a specific Payment Method object.
      operationId: queryPaymentMethodByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                active: false
                bankIdentificationNumber: '411111'
                cardBrand: Visa
                cardClass: Credit
                cardIssuingBank: UNKNOWN
                cardIssuingCountry: ZZ
                cardProductType: Consumer_Card
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-16T18:51:00-07:00'
                creditCardExpirationMonth: 12
                creditCardExpirationYear: 2028
                creditCardHolderName: Amy Lawrence
                creditCardMaskNumber: '************1111'
                creditCardType: Visa
                id: 8ad0869995911c870195a1cc10fb7930
                isCompany: false
                isSystem: false
                lastTransactionDateTime: '2025-03-16T18:51:00-07:00'
                lastTransactionStatus: Approved
                numConsecutiveFailures: 0
                paymentMethodStatus: Active
                totalNumberOfErrorPayments: 0
                totalNumberOfProcessedPayments: 0
                type: CreditCard
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-16T18:51:00-07:00'
                useDefaultRetryRule: true
              schema:
                $ref: '#/components/schemas/ExpandedPaymentMethod'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-method-snapshots:
    get:
      summary: List payment method snapshots
      description: >
        Lists payment method snapshots. You can use the query parameters to
        filter, expand, and sort the returned results.


        **Note**: You must specify a `filter[]` query parameter to query payment
        method snapshots.
      operationId: queryPaymentMethodSnapshots
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - country
              - creditcardcountry
              - paymentmethodid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Method Snapshot object does not support expanding any
            related objects.
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - country
              - creditcardcountry
              - paymentmethodid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountId: 2c92c0f87270a5970172747e289a5e66
                    achAbaCode: '11111111111111111111'
                    achAccountName: Amy Lawrence
                    achAccountNumberMask: '************7777'
                    achAccountType: BusinessChecking
                    achBankName: abc
                    createdDate: '2020-07-14T01:58:56-07:00'
                    creditCardAddress1: ''
                    creditCardAddress2: ''
                    creditCardCity: ''
                    creditCardCountry: Brazil
                    creditCardPostalCode: ''
                    creditCardState: ''
                    email: ''
                    id: 2c92c0fa732df2a001734c8c68073a21
                    isCompany: false
                    lastTransactionDateTime: '2020-07-13T01:11:16-07:00'
                    lastTransactionStatus: Approved
                    numConsecutiveFailures: 0
                    paymentMethodId: 2c92c0f872bc58ec0172c06fe2f07422
                    paymentMethodStatus: Active
                    phone: ''
                    totalNumberOfErrorPayments: 0
                    totalNumberOfProcessedPayments: 5
                    type: ACH
                    updatedDate: '2020-07-14T01:58:56-07:00'
                    useDefaultRetryRule: true
              schema:
                type: object
                title: QueryPaymentMethodSnapshotsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-method-snapshots/{key}:
    get:
      summary: Retrieve a payment method snapshot
      description: |
        Retrieve the details of a specific Payment Method Snapshot object.
      operationId: queryPaymentMethodSnapshotByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Method Snapshot object does not support expanding any
            related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f87270a5970172747e289a5e66
                achAbaCode: '11111111111111111111'
                achAccountName: Amy Lawrence
                achAccountNumberMask: '************7777'
                achAccountType: BusinessChecking
                achBankName: abc
                createdDate: '2020-07-14T01:58:56-07:00'
                creditCardAddress1: ''
                creditCardAddress2: ''
                creditCardCity: ''
                creditCardCountry: Brazil
                creditCardPostalCode: ''
                creditCardState: ''
                email: ''
                id: 2c92c0fa732df2a001734c8c68073a21
                isCompany: false
                lastTransactionDateTime: '2020-07-13T01:11:16-07:00'
                lastTransactionStatus: Approved
                numConsecutiveFailures: 0
                paymentMethodId: 2c92c0f872bc58ec0172c06fe2f07422
                paymentMethodStatus: Active
                phone: ''
                totalNumberOfErrorPayments: 0
                totalNumberOfProcessedPayments: 5
                type: ACH
                updatedDate: '2020-07-14T01:58:56-07:00'
                useDefaultRetryRule: true
              schema:
                $ref: '#/components/schemas/ExpandedPaymentMethodSnapshot'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-runs:
    get:
      summary: List payment runs
      description: >
        Lists payment runs. You can use the query parameters to filter, expand,
        and sort the returned results.
      operationId: queryPaymentRuns
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - executeddate
              - numberofpayments
              - paymentrunnumber
              - status
              - targetdate
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Run object does not support expanding any related
            objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - executeddate
              - numberofpayments
              - paymentrunnumber
              - status
              - targetdate
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - applyCreditBalance: false
                    autoApplyCreditMemo: false
                    autoApplyUnappliedPayment: false
                    billingRunId: BR-00000018
                    collectPayment: true
                    consolidatedPayment: false
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2023-06-09T03:16:33-07:00'
                    currency: '1'
                    endDate: '2023-06-09T03:16:35-07:00'
                    executedDate: '2023-06-09T03:16:35-07:00'
                    id: 8ad08d29889f71e901889fa868cf70ef
                    numberOfCreditBalanceAdjustments: 0
                    numberOfCreditMemos: 0
                    numberOfDebitMemos: 0
                    numberOfDebitMemosUnprocessed: 0
                    numberOfErrors: 0
                    numberOfInvoices: 0
                    numberOfPayments: 0
                    numberOfUnprocessed: 0
                    numberofUnappliedPayments: 0
                    paymentRunNumber: PR-00000002
                    processPaymentWithClosedPM: false
                    runDate: '2022-07-01'
                    status: Completed
                    targetDate: '2022-07-01'
                    totalExecutionTime: 535
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2023-06-09T03:16:35-07:00'
              schema:
                type: object
                title: QueryPaymentRunsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentRun'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-runs/{key}:
    get:
      summary: Retrieve a payment run
      description: |
        Retrieve the details of a specific Payment Run object.
      operationId: queryPaymentRunByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Run object does not support expanding any related
            objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                applyCreditBalance: false
                autoApplyCreditMemo: false
                autoApplyUnappliedPayment: false
                billingRunId: BR-00000018
                collectPayment: true
                consolidatedPayment: false
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2023-06-09T03:16:33-07:00'
                currency: '1'
                endDate: '2023-06-09T03:16:35-07:00'
                executedDate: '2023-06-09T03:16:35-07:00'
                id: 8ad08d29889f71e901889fa868cf70ef
                numberOfCreditBalanceAdjustments: 0
                numberOfCreditMemos: 0
                numberOfDebitMemos: 0
                numberOfDebitMemosUnprocessed: 0
                numberOfErrors: 0
                numberOfInvoices: 0
                numberOfPayments: 0
                numberOfUnprocessed: 0
                numberofUnappliedPayments: 0
                paymentRunNumber: PR-00000002
                processPaymentWithClosedPM: false
                runDate: '2022-07-01'
                status: Completed
                targetDate: '2022-07-01'
                totalExecutionTime: 535
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2023-06-09T03:16:35-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedPaymentRun'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedules:
    get:
      summary: List payment schedules
      description: >
        Lists payment schedules. You can use the query parameters to filter,
        expand, and sort the returned results.  
      operationId: queryPaymentSchedules
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - number
              - accountid
              - invoiceid
              - debitmemoid
              - occurrences
              - status
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Schedule object does not support expanding any related
            objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - number
              - accountid
              - invoiceid
              - debitmemoid
              - occurrences
              - status
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDIzLTAyLTA3VDIwOjUwOjQyLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOGUxYTg2MjU1MTc2MDE4NjJmNWM1MGRjMjFhNyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 2c92c0f86ac39714016ad3e985c270c8
                    createdById: 2c92c09467cada0a0167cc79e59c0884
                    createdDate: '2023-02-07T20:50:24-08:00'
                    description: Payment Schedule 1
                    id: 8ad08e1a8625517601862f5c50dc21a7
                    invoiceId: 8ad098887fd49533017fde9722806ac9
                    number: PS-00000002
                    occurrences: 3
                    period: Weekly
                    prepayment: false
                    runHour: 2
                    startDate: '2025-02-09'
                    status: Active
                    totalAmount: 0
                    totalPaymentsErrored: 0
                    totalPaymentsProcessed: 0
                    updatedById: 2c92c09467cada0a0167cc79e59c0884
                    updatedDate: '2023-02-07T20:50:42-08:00'
              schema:
                type: object
                title: QueryPaymentSchedulesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentSchedule'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedules/{key}:
    get:
      summary: Retrieve a payment schedule
      description: |
        Retrieve the details of a specific Payment Schedule object.
      operationId: queryPaymentScheduleByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Schedule object does not support expanding any related
            objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f86ac39714016ad3e985c270c8
                createdById: 2c92c09467cada0a0167cc79e59c0884
                createdDate: '2023-02-07T20:50:24-08:00'
                description: Payment Schedule 1
                id: 8ad08e1a8625517601862f5c50dc21a7
                invoiceId: 8ad098887fd49533017fde9722806ac9
                number: PS-00000002
                occurrences: 3
                period: Weekly
                prepayment: false
                runHour: 2
                startDate: '2025-02-09'
                status: Active
                totalAmount: 0
                totalPaymentsErrored: 0
                totalPaymentsProcessed: 0
                updatedById: 2c92c09467cada0a0167cc79e59c0884
                updatedDate: '2023-02-07T20:50:42-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedPaymentSchedule'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedule-items:
    get:
      summary: List payment schedule items
      description: >
        Lists Payment Schedule Item objects. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryPaymentScheduleItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - number
              - accountid
              - invoiceid
              - debitmemoid
              - paymentscheduleid
              - scheduleddate
              - status
              - paymentid
              - cancellationreason
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - paymentscheduleitempayments
                - paymentscheduleitempayments.payment
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Schedule Item object does not support expanding any
            related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - number
              - accountid
              - invoiceid
              - debitmemoid
              - paymentscheduleid
              - scheduleddate
              - status
              - paymentid
              - cancellationreason
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAyLTE2VDIwOjU2OjM0LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwODY5Yzk1MDFkMTU1MDE5NTEyNDNlNmI2NTliNCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 2c92c0f86ac39714016ad3e985c270c8
                    amount: 2.78
                    balance: 0
                    createdById: 2c92c09467cada0a0167cc79e59c0884
                    createdDate: '2025-02-16T20:56:34-08:00'
                    currency: USD
                    description: ''
                    id: 8ad0869c9501d15501951243e6a85999
                    invoiceId: 8ad098887fd49533017fde9722806ac9
                    number: '8'
                    paymentId: 8ad0975e95b883840195bca74e596721
                    paymentScheduleId: 8ad0869c9501d15501951243e68a5991
                    prepayment: false
                    runHour: 0
                    scheduledDate: '2025-03-22'
                    status: Processed
                    updatedById: 2c92c09467cada0a0167cc79e59c0884
                    updatedDate: '2025-03-22T00:00:37-07:00'
              schema:
                type: object
                title: QueryPaymentScheduleItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPaymentScheduleItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/payment-schedule-items/{key}:
    get:
      summary: Retrieve a payment schedule item
      description: |
        Retrieve the details of a specific Payment Schedule Item object.
      operationId: queryPaymentScheduleItemByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - paymentscheduleitempayments
                - paymentscheduleitempayments.payment
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Payment Schedule Item object does not support expanding any
            related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f86ac39714016ad3e985c270c8
                amount: 2.78
                balance: 0
                createdById: 2c92c09467cada0a0167cc79e59c0884
                createdDate: '2025-02-16T20:56:34-08:00'
                currency: USD
                description: ''
                id: 8ad0869c9501d15501951243e6a85999
                invoiceId: 8ad098887fd49533017fde9722806ac9
                number: '8'
                paymentId: 8ad0975e95b883840195bca74e596721
                paymentScheduleId: 8ad0869c9501d15501951243e68a5991
                prepayment: false
                runHour: 0
                scheduledDate: '2025-03-22'
                status: Processed
                updatedById: 2c92c09467cada0a0167cc79e59c0884
                updatedDate: '2025-03-22T00:00:37-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedPaymentScheduleItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balances:
    get:
      summary: List prepaid balances
      description: >
        Lists Prepaid Balance objects. You can use the query parameters to
        filter, expand, and sort the returned results.  
      operationId: queryPrepaidBalances
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - startdate
              - accountid
              - origsubscriptionid
              - uom
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - origsubscription
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - startdate
              - accountid
              - origsubscriptionid
              - uom
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountId: 8ad0889d89969bdd01899b3c286907d4
                    balance: 10
                    createdById: 0df518966a824517b146ccd1eb780b20
                    createdDate: '2024-02-20T22:03:27-08:00'
                    endDate: '2026-02-21'
                    id: 8ad09be48dc99a2b018dca430ad45679
                    name: A-S00000125_Each
                    origSubscriptionId: 8ad09be48dc99a2b018dca4309925663
                    prepaidBalanceState: ACTIVE
                    prepaidType: 0
                    startDate: '2025-02-21'
                    totalFund: 10
                    uOM: Each
                    updatedById: 0df518966a824517b146ccd1eb780b20
                    updatedDate: '2024-02-20T22:03:27-08:00'
                  - accountId: 2c92c0f87270a5970172747e289a5e66
                    balance: 120
                    createdById: 2c92c0f87270a597017273cf21dc64d4
                    createdDate: '2023-04-03T00:39:32-07:00'
                    endDate: '2026-01-01'
                    id: 8ad098f08736f8100187460e90b02056
                    name: A-S00000021_Each
                    origSubscriptionId: 8ad08cbd8736ed1d0187460e8d4e231f
                    prepaidBalanceState: ACTIVE
                    prepaidType: 0
                    startDate: '2025-01-01'
                    totalFund: 120
                    uOM: Each
                    updatedById: 2c92c0f87270a597017273cf21dc64d4
                    updatedDate: '2023-04-03T00:39:32-07:00'
              schema:
                type: object
                title: QueryPrepaidBalancesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPrepaidBalance'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balances/{key}:
    get:
      summary: Retrieve a prepaid balance
      description: |
        Retrieve the details of a specific Prepaid Balance object.
      operationId: queryPrepaidBalanceByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - origsubscription
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad0889d89969bdd01899b3c286907d4
                balance: 10
                createdById: 0df518966a824517b146ccd1eb780b20
                createdDate: '2024-02-20T22:03:27-08:00'
                endDate: '2026-02-21'
                id: 8ad09be48dc99a2b018dca430ad45679
                name: A-S00000125_Each
                origSubscriptionId: 8ad09be48dc99a2b018dca4309925663
                prepaidBalanceState: ACTIVE
                prepaidType: 0
                startDate: '2025-02-21'
                totalFund: 10
                uOM: Each
                updatedById: 0df518966a824517b146ccd1eb780b20
                updatedDate: '2024-02-20T22:03:27-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedPrepaidBalance'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-funds:
    get:
      summary: List prepaid balance funds
      description: >
        Lists prepaid balance funds. You can use the query parameters to filter,
        expand, and sort the returned results.  
      operationId: queryPrepaidBalanceFunds
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - enddate
              - prepaidbalanceid
              - sourceid
              - startdate
              - vpsummaryid
                
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - source
                - vpsummary
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - enddate
              - prepaidbalanceid
              - sourceid
              - startdate
              - vpsummaryid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDIzLTA0LTAzVDAwOjM5OjMyLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOThmMDg3MzZmODEwMDE4NzQ2MGU5MGU2MjA2MSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8ad0889d89969bdd01899b3c286907d4
                    balance: 10
                    chargeSegmentNumber: 1
                    createdById: 0df518966a824517b146ccd1eb780b20
                    createdDate: '2024-02-20T22:03:27-08:00'
                    done: 0
                    endDate: '2025-02-21'
                    fundSourceType: CHARGE
                    fundedBalance: 10
                    fundingPrice: 12
                    id: 8ad09be48dc99a2b018dca430aeb567b
                    originalFundingPrice: 12
                    originalTotalBalance: 0
                    prepaidBalanceId: 8ad09be48dc99a2b018dca430ad45679
                    priority: 50
                    rolloverApplyOption: ApplyLast
                    rolloverCount: 0
                    sourceId: 8ad09be48dc99a2b018dca430a0a566f
                    startDate: '2024-02-21'
                    totalBalance: 0
                    totalBilled: 0
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2024-12-19T23:27:57-08:00'
                    vpSummaryId: 8ad09be48dc99a2b018dca430aea567a
              schema:
                type: object
                title: QueryPrepaidBalanceFundsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPrepaidBalanceFund'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-funds/{key}:
    get:
      summary: Retrieve a prepaid balance fund
      description: |
        Retrieve the details of a specific Prepaid Balance Fund object.
      operationId: queryPrepaidBalanceFundByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - source
                - vpsummary
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad0889d89969bdd01899b3c286907d4
                balance: 10
                chargeSegmentNumber: 1
                createdById: 0df518966a824517b146ccd1eb780b20
                createdDate: '2024-02-20T22:03:27-08:00'
                done: 0
                endDate: '2025-02-21'
                fundSourceType: CHARGE
                fundedBalance: 10
                fundingPrice: 12
                id: 8ad09be48dc99a2b018dca430aeb567b
                originalFundingPrice: 12
                originalTotalBalance: 0
                prepaidBalanceId: 8ad09be48dc99a2b018dca430ad45679
                priority: 50
                rolloverApplyOption: ApplyLast
                rolloverCount: 0
                sourceId: 8ad09be48dc99a2b018dca430a0a566f
                startDate: '2024-02-21'
                totalBalance: 0
                totalBilled: 0
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2024-12-19T23:27:57-08:00'
                vpSummaryId: 8ad09be48dc99a2b018dca430aea567a
              schema:
                $ref: '#/components/schemas/ExpandedPrepaidBalanceFund'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-transactions:
    get:
      summary: List prepaid balance transactions
      description: >
        Lists prepaid balance transactions. You can use the query parameters to
        filter, expand, and sort the returned results.  
      operationId: queryPrepaidBalanceTransactions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - accountid
              - prepaidbalanceid
              - fundid
              - sourceid
              - transactiondate
              - prepaidbalancetransactiontype
              - createddate
                
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - fund
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - accountid
              - prepaidbalanceid
              - fundid
              - sourceid
              - transactiondate
              - createddate
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTEyLTIwVDA2OjE2OjIxLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTliODkzYmE0ZDFjMDE5M2U0NmQzMTI5NWIwYSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 2c92c0f87270a5970172747e289a5e66
                    amount: -10
                    balance: 50
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2024-12-20T06:16:21-08:00'
                    fundId: 8ad089b2813e747501814ccc072341b8
                    id: 8ad099b893ba4d1c0193e46d315c5b20
                    prepaidBalanceId: 8ad089b2813e747501814c80d78176f1
                    prepaidBalanceTransactionType: PREPAYMENT_CREDIT_BACK
                    sourceId: 8ad0877b813e577401814ccc0093038e
                    transactionDate: '2022-11-10'
                    transactionSourceType: CHARGE
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2024-12-20T06:16:21-08:00'
              schema:
                type: object
                title: QueryPrepaidBalanceTransactionsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/prepaid-balance-transactions/{key}:
    get:
      summary: Retrieve a prepaid balance transaction
      description: |
        Retrieve the details of a Prepaid Balance Transaction object.
      operationId: queryPrepaidBalanceTransactionByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
                - fund
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f87270a5970172747e289a5e66
                amount: -10
                balance: 50
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2024-12-20T06:16:21-08:00'
                fundId: 8ad089b2813e747501814ccc072341b8
                id: 8ad099b893ba4d1c0193e46d315c5b20
                prepaidBalanceId: 8ad089b2813e747501814c80d78176f1
                prepaidBalanceTransactionType: PREPAYMENT_CREDIT_BACK
                sourceId: 8ad0877b813e577401814ccc0093038e
                transactionDate: '2022-11-10'
                transactionSourceType: CHARGE
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2024-12-20T06:16:21-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedPrepaidBalanceTransaction'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/processed-usages:
    get:
      summary: List processed usage records
      description: >
        Lists Processed Usage Record objects. You can use the query parameters
        to filter, expand, and sort the returned results.
      operationId: queryProcessedUsages
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - usageid
              - billingperiodenddate
              - billingperiodstartdate   
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - usage
                - invoiceitem
                - creditmemoitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - usageid
              - billingperiodenddate
              - billingperiodstartdate
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDE3LTA4LTE0VDEwOjAwOjA0KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiIyYzkyYzA5NDVkYzY5MDE5MDE1ZGRlNzgyZjBlNGMxMiIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - billingPeriodEndDate: '2018-01-01T16:00:00+08:00'
                    billingPeriodStartDate: '2017-12-01T16:00:00+08:00'
                    createdById: 2c92c0f956bc8fcb0156f8eee04b4d54
                    createdDate: '2017-12-13T11:00:04+08:00'
                    id: 2c92c094602f962301604dd098824b76
                    invoiceItemId: 2c92c094602f962301604dd0988d4b78
                    ratePlanChargeId: 2c92c0f956bc8fcb0156d5039e275aa9
                    updatedById: 2c92c0f956bc8fcb0156f8eee04b4d54
                    updatedDate: '2017-12-13T11:00:04+08:00'
                    usageId: 2c92c08656bc8fdb0156d51204db6993
              schema:
                type: object
                title: QueryProcessedUsagesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProcessedUsage'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/processed-usages/{key}:
    get:
      summary: Retrieve a processed usage record
      description: |
        Retrieve the details of a specific Processed Usage Record object.
      operationId: queryProcessedUsageByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - usage
                - invoiceitem
                - creditmemoitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                billingPeriodEndDate: '2018-01-01T16:00:00+08:00'
                billingPeriodStartDate: '2017-12-01T16:00:00+08:00'
                createdById: 2c92c0f956bc8fcb0156f8eee04b4d54
                createdDate: '2017-12-13T11:00:04+08:00'
                id: 2c92c094602f962301604dd098824b76
                invoiceItemId: 2c92c094602f962301604dd0988d4b78
                ratePlanChargeId: 2c92c0f956bc8fcb0156d5039e275aa9
                updatedById: 2c92c0f956bc8fcb0156f8eee04b4d54
                updatedDate: '2017-12-13T11:00:04+08:00'
                usageId: 2c92c08656bc8fdb0156d51204db6993
              schema:
                $ref: '#/components/schemas/ExpandedProcessedUsage'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/products:
    get:
      summary: List products
      description: >
        Lists Product objects. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryProducts
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - name
              - effectiveenddate
              - effectivestartdate
              - sku
              - productnumber
              - category
              
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplans
                - productrateplans.productrateplancharges
                - >-
                  productrateplans.productrateplancharges.productrateplanchargetiers
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - name
              - effectiveenddate
              - effectivestartdate
              - sku
              - productnumber
              - category
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDIzLTA3LTEzVDAwOjM5OjI2LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTZjYTg5NDk1NmUxMDE4OTRlMzBjNzU2NzI0MyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - allowFeatureChanges: false
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-02-06T23:32:02-08:00'
                    description: Cloud Service provided by ACME Corp.
                    effectiveEndDate: '2032-10-20'
                    effectiveStartDate: '2022-10-20'
                    id: 8ad08ea194da7ba00194df52a41f04c6
                    name: Cloud Service
                    productNumber: PC-00000027
                    sKU: SKU-001
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-02-06T23:32:02-08:00'
              schema:
                type: object
                title: QueryProductsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProduct'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/products/{key}:
    get:
      summary: Retrieve a product
      description: |
        Retrieve the details of a specific Product object.
      operationId: queryProductByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: ID or SKU of a product.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplans
                - productrateplans.productrateplancharges
                - >-
                  productrateplans.productrateplancharges.productrateplanchargetiers
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                allowFeatureChanges: false
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-02-06T23:32:02-08:00'
                description: Cloud Service provided by ACME Corp.
                effectiveEndDate: '2032-10-20'
                effectiveStartDate: '2022-10-20'
                id: 8ad08ea194da7ba00194df52a41f04c6
                name: Cloud Service
                productNumber: PC-00000027
                sKU: SKU-001
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-02-06T23:32:02-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedProduct'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plans:
    get:
      summary: List product rate plans
      description: >
        Lists Product Rate Plan objects. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryProductRatePlans
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - productid
              - name
              - effectivestartdate
              - effectiveenddate
              - productrateplannumber
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - product
                - productrateplancharges
                - productrateplancharges.productrateplanchargetiers
                - externalproductrateplans
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - productid
              - name
              - effectivestartdate
              - effectiveenddate
              - productrateplannumber
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDIzLTA3LTEzVDAwOjM2OjUxLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOGM4NDg5NDk0NWQ5MDE4OTRlMmU2OThlNjc2OSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - createdById: 2c92c0f97270b6b6017273cdcdd77ad9
                    createdDate: '2025-02-19T23:20:12-08:00'
                    description: ''
                    effectiveEndDate: '2028-02-08'
                    effectiveStartDate: '2025-02-01'
                    id: f94fbebf61e952182765223a7a1d0000
                    name: Premium plan - Monthly
                    productId: 8ad08ea194da7ba00194df52a41f04c6
                    productRatePlanNumber: PRP-00000037
                    updatedById: 2c92c0f97270b6b6017273cdcdd77ad9
                    updatedDate: '2025-02-19T23:20:12-08:00'
              schema:
                type: object
                title: QueryProductRatePlansResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProductRatePlan'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plans/{key}:
    get:
      summary: Retrieve a product rate plan
      description: |
        Retrieve the details of a specific Product Rate Plan object.
      operationId: queryProductRatePlanByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: ID of a product rate plan.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - product
                - productrateplancharges
                - productrateplancharges.productrateplanchargetiers
                - externalproductrateplans
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                createdById: 2c92c0f97270b6b6017273cdcdd77ad9
                createdDate: '2025-02-19T23:20:12-08:00'
                description: ''
                effectiveEndDate: '2028-02-08'
                effectiveStartDate: '2025-02-01'
                id: f94fbebf61e952182765223a7a1d0000
                name: Premium plan - Monthly
                productId: 8ad08ea194da7ba00194df52a41f04c6
                productRatePlanNumber: PRP-00000037
                updatedById: 2c92c0f97270b6b6017273cdcdd77ad9
                updatedDate: '2025-02-19T23:20:12-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedProductRatePlan'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charges:
    get:
      summary: List product rate plan charges
      description: >
        Lists Product Rate Plan Charge objects. You can use the query parameters
        to filter, expand, and sort the returned results.
      operationId: queryProductRatePlanCharges
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - billcycleday
              - chargemodel
              - productrateplanchargenumber
              - productrateplanid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplan
                - productrateplanchargetiers
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - billcycleday
              - chargemodel
              - chargetype
              - isprepaid
              - productrateplanchargenumber
              - productrateplanid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDIzLTA4LTAyVDIwOjM5OjMwLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOTQwODg5YjcxZmMyMDE4OWI5N2FhNjVlMmVhOSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    accountingCode: Subscription Revenue
                    applyToBillingPeriodPartially: false
                    chargeFunction: Standard
                    chargeModel: Volume Pricing
                    chargeType: OneTime
                    commitmentType: UNIT
                    createdById: 2c92c0f97270b6b6017273cdcdd77ad9
                    createdDate: '2025-02-19T23:44:10-08:00'
                    defaultQuantity: 100
                    deferredRevenueAccount: Subscription Revenue
                    deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    description: ''
                    endDateCondition: OneTime
                    excludeItemBillingFromRevenueAccounting: false
                    excludeItemBookingFromRevenueAccounting: false
                    id: f94fbebf60e95218276522506ac30001
                    includedUnits: 0
                    isAllocationEligible: false
                    isCommitted: false
                    isPrepaid: false
                    isRollover: false
                    isStackedDiscount: false
                    isUnbilled: false
                    legacyRevenueReporting: false
                    listPriceBase: Per Billing Period
                    name: One-time volume charge
                    numberOfPeriod: 1
                    overageCalculationOption: EndOfSmoothingPeriod
                    overageUnusedUnitsCreditOption: NoCredit
                    priceChangeOption: NoChange
                    priceIncreasePercentage: 0
                    priceUpsellQuantityStacked: false
                    productRatePlanChargeNumber: PRPC-00000051
                    productRatePlanId: f94fbebf61e952182765223a7a1d0000
                    recognizedRevenueAccount: Subscription Revenue
                    recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                    revenueRecognitionRuleName: Recognize upon invoicing
                    rolloverApply: ApplyLast
                    rolloverPeriodLength: 0
                    rolloverPeriods: 0
                    taxCode: ''
                    taxable: false
                    triggerEvent: ContractEffective
                    uOM: Each
                    upToPeriodsType: Billing Periods
                    updatedById: 2c92c0f97270b6b6017273cdcdd77ad9
                    updatedDate: '2025-02-19T23:44:10-08:00'
                    useTenantDefaultForPriceChange: true
                    validityPeriodType: SubscriptionTerm
              schema:
                type: object
                title: QueryProductRatePlanChargesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProductRatePlanCharge'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charges/{key}:
    get:
      summary: Retrieve a product rate plan charge
      description: |
        Retrieve the details of a specific Product Rate Plan Charge object.
      operationId: queryProductRatePlanChargeByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: ID of a product rate plan charge.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplan
                - productrateplanchargetiers
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                accountingCode: Subscription Revenue
                applyToBillingPeriodPartially: false
                chargeFunction: Standard
                chargeModel: Volume Pricing
                chargeType: OneTime
                commitmentType: UNIT
                createdById: 2c92c0f97270b6b6017273cdcdd77ad9
                createdDate: '2025-02-19T23:44:10-08:00'
                defaultQuantity: 100
                deferredRevenueAccount: Subscription Revenue
                deferredRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                description: ''
                endDateCondition: OneTime
                excludeItemBillingFromRevenueAccounting: false
                excludeItemBookingFromRevenueAccounting: false
                id: f94fbebf60e95218276522506ac30001
                includedUnits: 0
                isAllocationEligible: false
                isCommitted: false
                isPrepaid: false
                isRollover: false
                isStackedDiscount: false
                isUnbilled: false
                legacyRevenueReporting: false
                listPriceBase: Per Billing Period
                name: One-time volume charge
                numberOfPeriod: 1
                overageCalculationOption: EndOfSmoothingPeriod
                overageUnusedUnitsCreditOption: NoCredit
                priceChangeOption: NoChange
                priceIncreasePercentage: 0
                priceUpsellQuantityStacked: false
                productRatePlanChargeNumber: PRPC-00000051
                productRatePlanId: f94fbebf61e952182765223a7a1d0000
                recognizedRevenueAccount: Subscription Revenue
                recognizedRevenueAccountingCodeId: 2c92c0f86cccaa59016cd5e125691213
                revenueRecognitionRuleName: Recognize upon invoicing
                rolloverApply: ApplyLast
                rolloverPeriodLength: 0
                rolloverPeriods: 0
                taxCode: ''
                taxable: false
                triggerEvent: ContractEffective
                uOM: Each
                upToPeriodsType: Billing Periods
                updatedById: 2c92c0f97270b6b6017273cdcdd77ad9
                updatedDate: '2025-02-19T23:44:10-08:00'
                useTenantDefaultForPriceChange: true
                validityPeriodType: SubscriptionTerm
              schema:
                $ref: '#/components/schemas/ExpandedProductRatePlanCharge'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charge-tiers:
    get:
      summary: List product rate plan charge tiers
      description: >
        Lists Product Rate Plan Charge Tier objects. You can use the query
        parameters to filter, expand, and sort the returned results.
      operationId: queryProductRatePlanChargeTiers
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - productrateplanchargeid
              - productchargedefinitionid
               
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplancharge
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - productrateplanchargeid
              - productchargedefinitionid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAyLTE5VDIzOjI2OjM0LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmMTY2MjhiZTk1MjE5NWYzNTIyNDA0ZWZiMDAxMSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - active: false
                    createdById: 2c92c0f97270b6b6017273cdcdd77ad9
                    createdDate: '2025-02-19T23:44:10-08:00'
                    currency: CAD
                    endingUnit: 10000
                    id: f94fbebf60e95218276522506ac30006
                    isDefault: true
                    price: 0
                    priceFormat: Per Unit
                    productRatePlanChargeId: f94fbebf60e95218276522506ac30001
                    startingUnit: 1
                    tier: 1
                    updatedById: 2c92c0f97270b6b6017273cdcdd77ad9
                    updatedDate: '2025-02-19T23:44:10-08:00'
              schema:
                type: object
                title: QueryProductRatePlanChargeTiersResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/product-rate-plan-charge-tiers/{key}:
    get:
      summary: Retrieve a product rate plan charge tier
      description: |
        Retrieve the details of a specific Product Rate Plan Charge Tier object.
      operationId: queryProductRatePlanChargeTierByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: ID of a product rate plan charge tier.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - productrateplancharge
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                active: false
                createdById: 2c92c0f97270b6b6017273cdcdd77ad9
                createdDate: '2025-02-19T23:44:10-08:00'
                currency: CAD
                endingUnit: 10000
                id: f94fbebf60e95218276522506ac30006
                isDefault: true
                price: 0
                priceFormat: Per Unit
                productRatePlanChargeId: f94fbebf60e95218276522506ac30001
                startingUnit: 1
                tier: 1
                updatedById: 2c92c0f97270b6b6017273cdcdd77ad9
                updatedDate: '2025-02-19T23:44:10-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedProductRatePlanChargeTier'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/ramps:
    get:
      summary: List ramps
      description: >
        Lists Ramp objects. You can use the query parameters to filter, expand,
        and sort the returned results.
      operationId: queryRamps
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - orderId
              
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - orderId
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTA1LTIwVDE1OjM2OjU0KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YTkwY2Q2Yzk2ZWFkMThkMDE5NmVjOWZiMzRiMjI2OCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - chargeNumbers: C-00036028,C-00036029
                    createdById: 2c92c8f95e2d6ebb015e325df48e02da
                    createdDate: '2025-07-07T17:10:04+08:00'
                    discountTcb: 0
                    discountTcv: 0
                    grossTcb: 1100.02
                    grossTcv: 1099.98
                    id: 8a908be797dcd0ab0197e4264a872ea9
                    metricsProcessingStatus: Completed
                    netTcb: 1100.02
                    netTcv: 1099.98
                    number: R-00000464
                    orderId: edcaaadd4dd97dcd08b7e4264a1900a1
                    subscriptionNumbers: A-S00004629
                    updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                    updatedDate: '2025-07-07T17:10:07+08:00'
              schema:
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRamp'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/ramps/{key}:
    get:
      summary: Retrieve a ramp
      description: >
        Retrieve a Ramp object. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryRampByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - in: path
          name: key
          required: true
          schema:
            type: string
          description: |
            ID or number of the ramp.
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - orderId
              
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - orderId
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                chargeNumbers: C-00036028,C-00036029
                createdById: 2c92c8f95e2d6ebb015e325df48e02da
                createdDate: '2025-07-07T17:10:04+08:00'
                discountTcb: 0
                discountTcv: 0
                grossTcb: 1100.02
                grossTcv: 1099.98
                id: 8a908be797dcd0ab0197e4264a872ea9
                metricsProcessingStatus: Completed
                netTcb: 1100.02
                netTcv: 1099.98
                number: R-00000464
                orderId: edcaaadd4dd97dcd08b7e4264a1900a1
                subscriptionNumbers: A-S00004629
                updatedById: 2c92c8f95e2d6ebb015e325df48e02da
                updatedDate: '2025-07-07T17:10:07+08:00'
              schema:
                $ref: '#/components/schemas/ExpandedRamp'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plans:
    get:
      summary: List rate plans
      description: >
        Lists Rate Plan objects. You can use the query parameters to filter,
        expand, and sort the returned results.  
      operationId: queryRatePlans
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - productid
              - amendmentid
              - subscriptionid
              - subscriptionownerid
              - externallymanagedplanid
              - subscriptionrateplannumber
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - productrateplan
                - rateplancharges
                - rateplancharges.rateplanchargetiers
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - productid
              - amendmentid
              - subscriptionid
              - subscriptionownerid
              - invoiceownerid
              - externallymanagedplanid
              - originalrateplanid
              - subscriptionofferid
              - subscriptionrateplannumber
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAyLTE5VDIzOjUwOjQxLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYzM3YjVjODk1MjE4Mjc3NTIyNTY2MTQ0MDM0ZCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-25T06:26:14-07:00'
                    id: f94fb52490e95cd65925cd7b740200c7
                    invoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                    name: Monthly rate plan
                    originalRatePlanId: f94fb52490e95cd65925cd7b740200c7
                    productId: 8ad08ea194da7ba00194df52a41f04c6
                    productRatePlanId: f94fbebf61e952182765223a7a1d0000
                    reverted: false
                    subscriptionId: f94fb52490e95cd65925cd7b737400bd
                    subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
                    subscriptionRatePlanNumber: SRP-00000349
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-25T06:26:14-07:00'
              schema:
                type: object
                title: QueryRatePlansResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatePlan'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plans/{key}:
    get:
      summary: Retrieve a rate plan
      description: |
        Retrieve the details of a specific Rate Plan object.
      operationId: queryRatePlanByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: ID of a rate plan.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - subscription
                - productrateplan
                - rateplancharges
                - rateplancharges.rateplanchargetiers
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-25T06:26:14-07:00'
                id: f94fb52490e95cd65925cd7b740200c7
                invoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                name: Monthly rate plan
                originalRatePlanId: f94fb52490e95cd65925cd7b740200c7
                productId: 8ad08ea194da7ba00194df52a41f04c6
                productRatePlanId: f94fbebf61e952182765223a7a1d0000
                reverted: false
                subscriptionId: f94fb52490e95cd65925cd7b737400bd
                subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
                subscriptionRatePlanNumber: SRP-00000349
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-25T06:26:14-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedRatePlan'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charges:
    get:
      summary: List rate plan charges
      description: >
        Lists Rate Plan Charge objects. You can use the query parameters to
        filter, expand, and sort the returned results.

        **Note**: You must specify a `filter[]` query parameter to query rate
        plan charges.
      operationId: queryRatePlanCharges
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - rateplanid
              - chargenumber
              - invoicescheduleid
              - isprepaid
              - originalid
              - productchargedefinitionid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplan
                - productrateplancharge
                - rateplanchargetiers
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - rateplanid
              - chargenumber
              - invoicescheduleid
              - isprepaid
              - originalid
              - subscriptionid
              - subscriptionownerid
              - invoiceownerid
              - productchargedefinitionid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAzLTI0VDIxOjIxOjM3LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYjUyNDk1Zjk1Yjg4MjQ2NWNiODhkNWUxOTRhNyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    applyDiscountTo: ONETIMERECURRING
                    applyToBillingPeriodPartially: false
                    billCycleType: DefaultFromCustomer
                    billingPeriod: Month
                    billingPeriodAlignment: AlignToCharge
                    chargeModel: Discount-Percentage
                    chargeNumber: C-00000526
                    chargeType: Recurring
                    chargedThroughDate: '2025-04-01'
                    commitmentType: UNIT
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-25T06:26:14-07:00'
                    dMRC: 0
                    dTCV: 0
                    description: ''
                    discountLevel: rateplan
                    effectiveEndDate: '2026-02-01'
                    effectiveStartDate: '2025-02-01'
                    endDateCondition: SubscriptionEnd
                    excludeItemBillingFromRevenueAccounting: false
                    excludeItemBookingFromRevenueAccounting: false
                    id: f94fb52490e95cd65925cd7b737700c5
                    invoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                    isCommitted: false
                    isLastSegment: true
                    isPrepaid: false
                    isProcessed: false
                    isRollover: false
                    listPriceBase: Per Billing Period
                    mRR: 0
                    name: Percentage discount
                    numberOfPeriods: 1
                    originalId: f94fb52490e95cd65925cd7b737700c5
                    originalOrderDate: '2025-02-01'
                    overageCalculationOption: EndOfSmoothingPeriod
                    overageUnusedUnitsCreditOption: NoCredit
                    priceChangeOption: NoChange
                    priceIncreasePercentage: 0
                    priceUpsellQuantityStacked: false
                    processedThroughDate: '2025-03-01'
                    productRatePlanChargeId: f94f16628be952195f3522404efb0010
                    prorationOption: DefaultFromTenantSetting
                    quantity: 0
                    ratePlanId: f94fb52490e95cd65925cd7b740200c7
                    reflectDiscountInNetAmount: false
                    reverted: false
                    rolloverApply: ApplyLast
                    rolloverPeriodLength: 0
                    rolloverPeriods: 0
                    segment: 1
                    subscriptionId: f94fb52490e95cd65925cd7b737400bd
                    subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
                    tCV: 0
                    taxable: false
                    triggerEvent: ContractEffective
                    upToPeriodsType: Billing Periods
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-25T06:26:14-07:00'
                    version: 1
              schema:
                type: object
                title: QueryRatePlanChargesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatePlanCharge'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charges/{key}:
    get:
      summary: Retrieve a rate plan charge
      description: |
        Retrieve the details of a specific Rate Plan Charge object.
      operationId: queryRatePlanChargeByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: ID of a rate plan charge.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplan
                - productrateplancharge
                - rateplanchargetiers
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                applyDiscountTo: ONETIMERECURRING
                applyToBillingPeriodPartially: false
                billCycleType: DefaultFromCustomer
                billingPeriod: Month
                billingPeriodAlignment: AlignToCharge
                chargeModel: Discount-Percentage
                chargeNumber: C-00000526
                chargeType: Recurring
                chargedThroughDate: '2025-04-01'
                commitmentType: UNIT
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-25T06:26:14-07:00'
                dMRC: 0
                dTCV: 0
                description: ''
                discountLevel: rateplan
                effectiveEndDate: '2026-02-01'
                effectiveStartDate: '2025-02-01'
                endDateCondition: SubscriptionEnd
                excludeItemBillingFromRevenueAccounting: false
                excludeItemBookingFromRevenueAccounting: false
                id: f94fb52490e95cd65925cd7b737700c5
                invoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                isCommitted: false
                isLastSegment: true
                isPrepaid: false
                isProcessed: false
                isRollover: false
                listPriceBase: Per Billing Period
                mRR: 0
                name: Percentage discount
                numberOfPeriods: 1
                originalId: f94fb52490e95cd65925cd7b737700c5
                originalOrderDate: '2025-02-01'
                overageCalculationOption: EndOfSmoothingPeriod
                overageUnusedUnitsCreditOption: NoCredit
                priceChangeOption: NoChange
                priceIncreasePercentage: 0
                priceUpsellQuantityStacked: false
                processedThroughDate: '2025-03-01'
                productRatePlanChargeId: f94f16628be952195f3522404efb0010
                prorationOption: DefaultFromTenantSetting
                quantity: 0
                ratePlanId: f94fb52490e95cd65925cd7b740200c7
                reflectDiscountInNetAmount: false
                reverted: false
                rolloverApply: ApplyLast
                rolloverPeriodLength: 0
                rolloverPeriods: 0
                segment: 1
                subscriptionId: f94fb52490e95cd65925cd7b737400bd
                subscriptionOwnerId: 2c92c0f87270a5970172747e289a5e66
                tCV: 0
                taxable: false
                triggerEvent: ContractEffective
                upToPeriodsType: Billing Periods
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-25T06:26:14-07:00'
                version: 1
              schema:
                $ref: '#/components/schemas/ExpandedRatePlanCharge'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charge-tiers:
    get:
      summary: List rate plan charge tiers
      description: >
        Lists Rate Plan Charge Tier objects. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryRatePlanChargeTiers
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - currency
              - id
              - rateplanchargeid
              - updateddate
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplancharge
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - currency
              - id
              - rateplanchargeid
              - updateddate
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAzLTI1VDA2OjI2OjE0LTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmYjUyNDkwZTk1Y2Q2NTkyNWNkN2I3NDJiMDBkNCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-25T06:26:14-07:00'
                    currency: USD
                    discountPercentage: 20
                    id: f94fb52490e95cd65925cd7b742e00dd
                    ratePlanChargeId: f94fb52490e95cd65925cd7b737700c5
                    tier: 1
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-25T06:26:14-07:00'
              schema:
                type: object
                title: QueryRatePlanChargesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatePlanChargeTier'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rate-plan-charge-tiers/{key}:
    get:
      summary: Retrieve a rate plan charge tier
      description: |
        Retrieve the details of a specific Rate Plan Charge Tier object.
      operationId: queryRatePlanChargeTierByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: ID of a rate plan charge tier.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - currency
              - id
              - rateplanchargeid
              - updateddate
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - rateplancharge
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: true
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - currency
              - id
              - rateplanchargeid
              - updateddate
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-25T06:26:14-07:00'
                currency: USD
                discountPercentage: 20
                id: f94fb52490e95cd65925cd7b742e00dd
                ratePlanChargeId: f94fb52490e95cd65925cd7b737700c5
                tier: 1
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-25T06:26:14-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedRatePlanChargeTier'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-results:
    get:
      summary: List rating results
      description: >
        Lists Rating Result objects. You can use the query parameters to filter,
        expand, and sort the returned results.  
      operationId: queryRatingResults
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - subscriptionid
              - rateplanchargeid
              - servicestartdate
              - serviceenddate
              - status
              - ispartial
              - invoiceitemid
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - rateplancharge
                - subscription
                - invoiceitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - subscriptionid
              - rateplanchargeid
              - servicestartdate
              - serviceenddate
              - status
              - ispartial
              - invoiceitemid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountId: 2c92c0f97871fb4201787be2536825ac
                    actualPeriodEndDate: '2023-05-21'
                    actualPeriodStartDate: '2023-05-15'
                    amount: 0
                    billingCycleDay: 2
                    chargeSegmentNumber: 2
                    createdByID: '00000000000000000000000000000003'
                    createdDate: '2024-02-28T01:36:50-08:00'
                    id: 8ad093c18deeb97e018def12ea353fca
                    isPartial: false
                    quantity: 45
                    ratePlanChargeId: 62bfa4c8fc7954ad35e54c3f711a6bc8
                    serviceEndDate: '2023-05-21'
                    serviceStartDate: '2023-05-15'
                    status: Rated
                    subscriptionId: 62bfa4c8fc7954ad35e54c3f70a16bc2
                    updatedByID: '00000000000000000000000000000003'
                    updatedDate: '2025-02-28T03:09:48-08:00'
              schema:
                type: object
                title: QueryRatingResultsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRatingResult'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-results/{key}:
    get:
      summary: Retrieve a rating result
      description: |
        Retrieve the details of a specific Rating Result object.
      operationId: queryRatingResultByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - rateplancharge
                - subscription
                - invoiceitem
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f97871fb4201787be2536825ac
                actualPeriodEndDate: '2023-05-21'
                actualPeriodStartDate: '2023-05-15'
                amount: 0
                billingCycleDay: 2
                chargeSegmentNumber: 2
                createdByID: '00000000000000000000000000000003'
                createdDate: '2024-02-28T01:36:50-08:00'
                id: 8ad093c18deeb97e018def12ea353fca
                isPartial: false
                quantity: 45
                ratePlanChargeId: 62bfa4c8fc7954ad35e54c3f711a6bc8
                serviceEndDate: '2023-05-21'
                serviceStartDate: '2023-05-15'
                status: Rated
                subscriptionId: 62bfa4c8fc7954ad35e54c3f70a16bc2
                updatedByID: '00000000000000000000000000000003'
                updatedDate: '2025-02-28T03:09:48-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedRatingResult'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refunds:
    get:
      summary: List refunds
      description: >
        Lists Refund objects. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryRefunds
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - paymentmethodsnapshotid
              - amount
              - paymentmethodid
              - reasoncode
              - refunddate
              - refundnumber
              - sourcetype
              - status
              - type
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - refundapplications
                - refundapplications.payment
                - refundapplications.refundapplicationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - paymentmethodsnapshotid
              - amount
              - paymentmethodid
              - reasoncode
              - refunddate
              - refundnumber
              - sourcetype
              - status
              - type
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountId: 8ad09be48db5aba7018db604776d4854
                    amount: 10
                    createdById: b243314d594646d3b2651aeedd4be47e
                    createdDate: '2024-07-25T00:19:43-07:00'
                    currency: USD
                    gateway: test gateway
                    gatewayResponse: This transaction has been approved by Test gateway.
                    gatewayResponseCode: approve
                    gatewayState: Submitted
                    id: 8ad0937890e7fca00190e8c290d46fad
                    methodType: CreditCard
                    paymentMethodId: 8ad084db90a5e73b0190c02783f552fa
                    paymentMethodSnapshotId: 8ad0937890e7fca00190e8c290b86fab
                    referenceID: '7002728053836375'
                    refundDate: '2024-07-25'
                    refundNumber: R-00000001
                    refundTransactionTime: '2024-07-25T00:19:43-07:00'
                    sourceType: CreditMemo
                    status: Processed
                    submittedOn: '2024-07-25T00:19:43-07:00'
                    type: Electronic
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-25T00:19:43-07:00'
              schema:
                type: object
                title: QueryRefundsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRefund'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refunds/{key}:
    get:
      summary: Retrieve a refund
      description: |
        Retrieve the details of a specific Refund object.
      operationId: queryRefundByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - account.billto
                - account.soldto
                - paymentmethod
                - refundapplications
                - refundapplications.payment
                - refundapplications.refundapplicationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad09be48db5aba7018db604776d4854
                amount: 10
                createdById: b243314d594646d3b2651aeedd4be47e
                createdDate: '2024-07-25T00:19:43-07:00'
                currency: USD
                gateway: test gateway
                gatewayResponse: This transaction has been approved by Test gateway.
                gatewayResponseCode: approve
                gatewayState: Submitted
                id: 8ad0937890e7fca00190e8c290d46fad
                methodType: CreditCard
                paymentMethodId: 8ad084db90a5e73b0190c02783f552fa
                paymentMethodSnapshotId: 8ad0937890e7fca00190e8c290b86fab
                referenceID: '7002728053836375'
                refundDate: '2024-07-25'
                refundNumber: R-00000001
                refundTransactionTime: '2024-07-25T00:19:43-07:00'
                sourceType: CreditMemo
                status: Processed
                submittedOn: '2024-07-25T00:19:43-07:00'
                type: Electronic
                updatedById: b243314d594646d3b2651aeedd4be47e
                updatedDate: '2024-07-25T00:19:43-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedRefund'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-applications:
    get:
      summary: List refund applications
      description: >
        Lists Refund Application objects. You can use the query parameters to
        filter, expand, and sort the returned results.
      operationId: queryRefundApplications
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - applicationgroupid
              - creditmemoid
              - effectivedate
              - paymentid
              - refundid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refund
                - payment
                - refundapplicationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - applicationgroupid
              - creditmemoid
              - effectivedate
              - paymentid
              - refundid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountId: 8ad09be48db5aba7018db604776d4854
                    accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    applicationGroupId: 8ad0937890e7fca00190e8c290ef6faf
                    applyAmount: 10
                    createdById: b243314d594646d3b2651aeedd4be47e
                    createdDate: '2024-07-25T00:19:43-07:00'
                    creditMemoId: 8ad0835290c4bb2f0190d9955e414e62
                    effectiveDate: '2024-07-25'
                    id: 8ad0937890e7fca00190e8c290f06fb0
                    refundId: 8ad0937890e7fca00190e8c290d46fad
                    unappliedPaymentAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2024-07-25T00:19:43-07:00'
              schema:
                type: object
                title: QueryRefundApplicationsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRefundApplication'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-applications/{key}:
    get:
      summary: Retrieve a refund application
      description: |
        Retrieve the details of a specific Refund Application object.
      operationId: queryRefundApplicationByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refund
                - payment
                - refundapplicationitems
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad09be48db5aba7018db604776d4854
                accountReceivableAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                applicationGroupId: 8ad0937890e7fca00190e8c290ef6faf
                applyAmount: 10
                createdById: b243314d594646d3b2651aeedd4be47e
                createdDate: '2024-07-25T00:19:43-07:00'
                creditMemoId: 8ad0835290c4bb2f0190d9955e414e62
                effectiveDate: '2024-07-25'
                id: 8ad0937890e7fca00190e8c290f06fb0
                refundId: 8ad0937890e7fca00190e8c290d46fad
                unappliedPaymentAccountingCodeId: 2c92c0f86cccaa59016cd5e108bf1206
                updatedById: b243314d594646d3b2651aeedd4be47e
                updatedDate: '2024-07-25T00:19:43-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedRefundApplication'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-application-items:
    get:
      summary: List refund application items
      description: >
        Lists Refund Application Item objects. You can use the query parameters
        to filter, expand, and sort the returned results.
      operationId: queryRefundApplicationItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.


            Supported sortable fields: 
              - id
              - updateddate
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refundapplication
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: QueryRefundApplicationItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedRefundApplicationItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/refund-application-items/{key}:
    get:
      summary: Retrieve a refund application item
      description: |
        Retrieve the details of a specific Refund Application Item object.
      operationId: queryRefundApplicationItemByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - refundapplication
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExpandedRefundApplicationItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatementruns:
    get:
      summary: List summary statement runs
      description: >
        Lists statement runs. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: getSummaryStatementRuns
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - endDate
                - startDate
                - statementRunNumber
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementRunNumber
                - status
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          description: |
            OK
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402881869169397401916d8ff8d218c5
                    createdById: 8a90e0828097f4a80180982735ff041d
                    createdDate: '2024-09-03T20:20:55-10:00'
                    emailStatus: Pending
                    endDate: '2024-09-03'
                    id: 8a90f17a91b7e1800191bbb176a243da
                    startDate: '2024-09-03'
                    statementDate: '2024-09-03'
                    statementNumber: SS-00001979
                    statementRunId: 8a90b44891b7e1670191bbb16cef028a
                    status: Completed
                    updatedById: 8a90e0828097f4a80180982735ff041d
                    updatedDate: '2024-08-20 10:13:57.586'
                    success: true
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatementRun'
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatementruns/{key}:
    get:
      summary: Retrieve a summary statement run
      description: |
        Retrieves a statement run by using the statement run ID or number.
      operationId: getSummaryStatementRun
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Statement run ID or number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - endDate
                - startDate
                - statementRunNumber
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementRunNumber
                - status
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402881869169397401916d8ff8d218c5
                    statementRunNumber: SSR-00000004
                    targetAccountCategory: AllAccounts
                    runType: AdHoc
                    batchName: Batch51
                    billCycleDay: '1'
                    dateRangeType: PreviousThreeCalendarMonth
                    startDate: '2024-05-01 19:13:57'
                    endDate: '2024-07-31 19:13:57'
                    autoEmailEnabled: false
                    description: HelloWorld
                    status: Pending
                    createdById: 402881e522cf4f9b0122cf5d82860002
                    createdDate: '2024-08-19 19:13:57'
                    updatedById: 402881e522cf4f9b0122cf5d82860002
                    updatedDate: '2024-08-20 10:13:57.586'
                    success: true
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatementRun'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatements:
    get:
      summary: List summary statements
      description: |
        Lists summary statements. 
      operationId: getSummaryStatements
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - endDate
                - statementDate
                - statementNumber
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementDate
                - statementNumber
                - statementRunId
                - status
                - emailStatus
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402881869169397401916d8ff8d218c5
                    createdById: 8a90e0828097f4a80180982735ff041d
                    createdDate: '2024-09-03T20:20:55-10:00'
                    emailStatus: Pending
                    endDate: '2024-09-03'
                    id: 8a90f17a91b7e1800191bbb176a243da
                    startDate: '2024-09-03'
                    statementDate: '2024-09-03'
                    statementNumber: SS-00001979
                    statementRunId: 8a90b44891b7e1670191bbb16cef028a
                    status: Completed
                    updatedById: 8a90e0828097f4a80180982735ff041d
                    updatedDate: '2024-08-20 10:13:57.586'
                    success: true
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatement'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/summarystatements/{key}:
    get:
      summary: Retrieve a summary statement
      description: |
        Retrieves a statement based on the specified summary statement key.
      operationId: getSummaryStatement
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Statement ID or number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - endDate
              - statementDate
              - statementNumber
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - createdById
                - createdDate
                - deleted
                - endDate
                - fileId
                - updatedById
                - updatedDate
                - errorCategory
                - errorMessage
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - accountId
                - id
                - startDate
                - statementDate
                - statementNumber
                - statementRunId
                - status
                - emailStatus
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    accountId: 402881869169397401916d8ff8d218c5
                    createdById: 8a90e0828097f4a80180982735ff041d
                    createdDate: '2024-09-03T20:20:55-10:00'
                    emailStatus: Pending
                    endDate: '2024-09-03'
                    id: 8a90f17a91b7e1800191bbb176a243da
                    startDate: '2024-09-03'
                    statementDate: '2024-09-03'
                    statementNumber: SS-00001979
                    statementRunId: 8a90b44891b7e1670191bbb16cef028a
                    status: Completed
                    updatedById: 8a90e0828097f4a80180982735ff041d
                    updatedDate: '2024-08-20 10:13:57.586'
                    success: true
              schema:
                $ref: '#/components/schemas/ExpandedSummaryStatement'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/subscriptions:
    get:
      summary: List subscriptions
      description: >
        Lists Subscription objects. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: querySubscriptions
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - contracteffectivedate
              - creatoraccountid
              - creatorinvoiceownerid
              - invoiceownerid
              - name
              - originalid
              - previoussubscriptionid
              - renewalterm
              - status
              - islatestversion
              - subscriptionversionamendmentid
              - termenddate
              - termstartdate
              - version
              - cmrr
              - externallymanagedby
              - invoicescheduleid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - invoiceowner
                - billtocontact
                - soldtocontact
                - invoiceitems
                - rateplans
                - rateplans.rateplancharges
                - rateplans.rateplancharges.rateplanchargetiers
                - account.billto
                - account.soldto
                - account.paymentmethods
                - order
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - contracteffectivedate
              - creatoraccountid
              - creatorinvoiceownerid
              - invoiceownerid
              - name
              - originalid
              - previoussubscriptionid
              - renewalterm
              - status
              - islatestversion
              - subscriptionversionamendmentid
              - termenddate
              - termstartdate
              - version
              - cmrr
              - externallymanagedby
              - invoicescheduleid
              - quotenumber__qt
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI1LTAyLTA2VDIzOjA5OjExLTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiJmOTRmNmVhOWQ4Nzk0ZGE5Mzg2NGRmM2RiODk4MTcxYyIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 2c92c0f87270a5970172747e289a5e66
                    autoRenew: true
                    cMRR: 2950
                    contractAcceptanceDate: '2025-02-01'
                    contractEffectiveDate: '2025-02-01'
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2025-03-25T06:26:14-07:00'
                    creatorAccountId: 2c92c0f87270a5970172747e289a5e66
                    creatorInvoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                    currency: USD
                    currentTerm: 12
                    currentTermPeriodType: Month
                    id: f94fb52490e95cd65925cd7b737400bd
                    initialTerm: 12
                    initialTermPeriodType: Month
                    invoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                    isInvoiceSeparate: true
                    isLatestVersion: true
                    isSingleVersioned: false
                    lastBookingDate: '2025-02-01'
                    name: A-S00000159
                    orderId: f94fb52490e95cd65925cd7b733100b6
                    originalCreatedDate: '2025-03-25T06:26:14-07:00'
                    originalId: f94fb52490e95cd65925cd7b737400bd
                    prepayment: false
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerm: 12
                    renewalTermPeriodType: Month
                    revision: '1.0'
                    serviceActivationDate: '2025-02-01'
                    status: Active
                    subscriptionEndDate: '2026-02-01'
                    subscriptionStartDate: '2025-02-01'
                    subscriptionVersionAmendmentId: f94fb52490e95cd65925cd7b733100b7
                    termEndDate: '2026-02-01'
                    termStartDate: '2025-02-01'
                    termType: TERMED
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-25T06:26:14-07:00'
                    version: 1
              schema:
                type: object
                title: QuerySubscriptionsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedSubscription'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/subscriptions/{key}:
    get:
      summary: Retrieve a subscription
      description: |
        Retrieve the details of a specific Subscription object.
      operationId: querySubscriptionByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - invoiceowner
                - billtocontact
                - soldtocontact
                - invoiceitems
                - rateplans
                - rateplans.rateplancharges
                - rateplans.rateplancharges.rateplanchargetiers
                - account.billto
                - account.soldto
                - account.paymentmethods
                - order
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 2c92c0f87270a5970172747e289a5e66
                autoRenew: true
                cMRR: 2950
                contractAcceptanceDate: '2025-02-01'
                contractEffectiveDate: '2025-02-01'
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2025-03-25T06:26:14-07:00'
                creatorAccountId: 2c92c0f87270a5970172747e289a5e66
                creatorInvoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                currency: USD
                currentTerm: 12
                currentTermPeriodType: Month
                id: f94fb52490e95cd65925cd7b737400bd
                initialTerm: 12
                initialTermPeriodType: Month
                invoiceOwnerId: 2c92c0f87270a5970172747e289a5e66
                isInvoiceSeparate: true
                isLatestVersion: true
                isSingleVersioned: false
                lastBookingDate: '2025-02-01'
                name: A-S00000159
                orderId: f94fb52490e95cd65925cd7b733100b6
                originalCreatedDate: '2025-03-25T06:26:14-07:00'
                originalId: f94fb52490e95cd65925cd7b737400bd
                prepayment: false
                renewalSetting: RENEW_WITH_SPECIFIC_TERM
                renewalTerm: 12
                renewalTermPeriodType: Month
                revision: '1.0'
                serviceActivationDate: '2025-02-01'
                status: Active
                subscriptionEndDate: '2026-02-01'
                subscriptionStartDate: '2025-02-01'
                subscriptionVersionAmendmentId: f94fb52490e95cd65925cd7b733100b7
                termEndDate: '2026-02-01'
                termStartDate: '2025-02-01'
                termType: TERMED
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-25T06:26:14-07:00'
                version: 1
              schema:
                $ref: '#/components/schemas/ExpandedSubscription'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/taxation-items:
    get:
      summary: List taxation items
      description: >
        Lists Taxation Item objects. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryTaxationItems
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.


            Supported sortable fields: 
              - id
              - updateddate
              - invoiceitemid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Taxation Item object does not support expanding related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - invoiceitemid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDE5LTA3LTEzVDEwOjAwOjE5KzA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiIyYzkyYzA5NDZiZTFmOTFlMDE2YmU5MGY0MjAzNGRiOSIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountReceivableAccountingCodeId: 2c92c0f946f588620146f8735ee101c8
                    accountingCode: Sales Tax Payable
                    balance: 0
                    createdById: 8ad084a67f9c7138017fab8a8b511b5a
                    createdDate: '2024-11-04T10:53:16+08:00'
                    creditAmount: 0
                    exemptAmount: 0
                    id: 8ad09d9392e0a4430192f51746d121f6
                    invoiceItemId: 8ad086fa92d66ffe0192dc7e5dd65161
                    jurisdiction: CALIFORNIA
                    name: CA TAX
                    paymentAmount: 3
                    periodEndDate: '2024-10-30'
                    periodStartDate: '2024-10-30'
                    salesTaxPayableAccountingCodeId: 2c92c0f946f588620146f8735f0a01cd
                    taxAmount: 3
                    taxAmountUnrounded: 3
                    taxDate: '2024-11-04'
                    taxMode: TaxExclusive
                    taxRate: 3
                    taxRateDescription: Details of the tax rate
                    taxRateType: FlatFee
                    taxableAmount: 0
                    updatedById: 2c92c0f955e2bcfc0155e3019d0c4963
                    updatedDate: '2024-11-29T05:00:42+08:00'
              schema:
                type: object
                title: QueryTaxationItemsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedTaxationItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/taxation-items/{key}:
    get:
      summary: Retrieve a taxation item
      description: |
        Retrieve the details of a specific Taxation Item object.
      operationId: queryTaxationItemByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.

            The Taxation Item object does not support expanding related objects.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountReceivableAccountingCodeId: 2c92c0f946f588620146f8735ee101c8
                accountingCode: Sales Tax Payable
                balance: 0
                createdById: 8ad084a67f9c7138017fab8a8b511b5a
                createdDate: '2024-11-04T10:53:16+08:00'
                creditAmount: 0
                exemptAmount: 0
                id: 8ad09d9392e0a4430192f51746d121f6
                invoiceItemId: 8ad086fa92d66ffe0192dc7e5dd65161
                jurisdiction: CALIFORNIA
                name: CA TAX
                paymentAmount: 3
                periodEndDate: '2024-10-30'
                periodStartDate: '2025-10-30'
                salesTaxPayableAccountingCodeId: 2c92c0f946f588620146f8735f0a01cd
                taxAmount: 3
                taxAmountUnrounded: 3
                taxDate: '2024-11-04'
                taxMode: TaxExclusive
                taxRate: 3
                taxRateDescription: Details of the tax rate
                taxRateType: FlatFee
                taxableAmount: 0
                updatedById: 2c92c0f955e2bcfc0155e3019d0c4963
                updatedDate: '2024-11-29T05:00:42+08:00'
              schema:
                $ref: '#/components/schemas/ExpandedTaxationItem'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/usages:
    get:
      summary: List usage records
      description: >
        Lists Usage Record objects. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryUsages
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - updateddate
              - accountid
              - accountnumber
              - enddatetime
              - quantity
              - rbestatus
              - startdatetime
              - uom
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - accountid
              - accountnumber
              - enddatetime
              - quantity
              - rbestatus
              - startdatetime
              - uom
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  - accountId: 8ad09e2089b71fba0189b97aac74494b
                    accountNumber: A00000064
                    createdById: b243314d594646d3b2651aeedd4be47e
                    createdDate: '2023-08-02T20:39:50-07:00'
                    id: 8ad094b989b71fb60189b97af64e48d2
                    quantity: 4
                    rbeStatus: Pending
                    sourceType: API
                    startDateTime: '2023-05-31T17:00:00-07:00'
                    submissionDateTime: '2023-08-02T20:39:50-07:00'
                    subscriptionId: 8ad09e2089b71fba0189b97aba7b4b01
                    uOM: Each
                    updatedById: b243314d594646d3b2651aeedd4be47e
                    updatedDate: '2023-08-02T20:39:50-07:00'
              schema:
                type: object
                title: QueryUsagesResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedUsage'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/usages/{key}:
    get:
      summary: Retrieve a usage record
      description: |
        Retrieve the details of a specific Usage Record object.
      operationId: queryUsageByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad09e2089b71fba0189b97aac74494b
                accountNumber: A00000064
                createdById: b243314d594646d3b2651aeedd4be47e
                createdDate: '2023-08-02T20:39:50-07:00'
                id: 8ad094b989b71fb60189b97af64e48d2
                quantity: 4
                rbeStatus: Pending
                sourceType: API
                startDateTime: '2023-05-31T17:00:00-07:00'
                submissionDateTime: '2023-08-02T20:39:50-07:00'
                subscriptionId: 8ad09e2089b71fba0189b97aba7b4b01
                uOM: Each
                updatedById: b243314d594646d3b2651aeedd4be47e
                updatedDate: '2023-08-02T20:39:50-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedUsage'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/validity-period-summaries:
    get:
      summary: List validity period summaries
      description: >
        Lists Validity Period Summary objects. You can use the query parameters
        to filter, expand, and sort the returned results.
      operationId: queryValidityPeriodSummarys
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.

            Supported sortable fields: 
              - id
              - prepaidbalanceid
              - startdate
              - subscriptionnumber
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - prepaidbalanceid
              - startdate
              - subscriptionnumber
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDIzLTA0LTAzVDAwOjM5OjMyLTA3OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOThmMDg3MzZmODEwMDE4NzQ2MGU5MGU2MjA2MCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - accountId: 8ad0889d89969bdd01899b3c286907d4
                    accountNumber: A00000061
                    billedBalanceAmount: 0
                    billingTiming: In Advance
                    createdById: 0df518966a824517b146ccd1eb780b20
                    createdDate: '2024-02-20T22:03:27-08:00'
                    endDate: '2025-02-21'
                    id: 8ad09be48dc99a2b018dca430aea567a
                    overageRatedAmount: 0
                    overageRatedQuantity: 0
                    prepaidBalanceId: 8ad09be48dc99a2b018dca430ad45679
                    remainingBalance: 10
                    startDate: '2024-02-21'
                    subscriptionNumber: A-S00000125
                    totalBalance: 10
                    totalBilledAmount: 0
                    uom: Each
                    updatedById: 0df518966a824517b146ccd1eb780b20
                    updatedDate: '2024-02-20T22:03:27-08:00'
              schema:
                type: object
                title: QueryValidityPeriodSummarysResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedValidityPeriodSummary'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/validity-period-summaries/{key}:
    get:
      summary: Retrieve a validity period summary
      description: |
        Retrieve the details of a specific Validity Period Summary object.
      operationId: queryValidityPeriodSummaryByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Object ID or Number.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending (e.g. `accountnumber.DESC`). You cannot sort on
            properties in arrays. If the array-type properties are specified for
            the `sort[]` parameter, they are ignored.
              
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - account
                - prepaidbalance
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                accountId: 8ad0889d89969bdd01899b3c286907d4
                accountNumber: A00000061
                billedBalanceAmount: 0
                billingTiming: In Advance
                createdById: 0df518966a824517b146ccd1eb780b20
                createdDate: '2024-02-20T22:03:27-08:00'
                endDate: '2025-02-21'
                id: 8ad09be48dc99a2b018dca430aea567a
                overageRatedAmount: 0
                overageRatedQuantity: 0
                prepaidBalanceId: 8ad09be48dc99a2b018dca430ad45679
                remainingBalance: 10
                startDate: '2024-02-21'
                subscriptionNumber: A-S00000125
                totalBalance: 10
                totalBilledAmount: 0
                uom: Each
                updatedById: 0df518966a824517b146ccd1eb780b20
                updatedDate: '2024-02-20T22:03:27-08:00'
              schema:
                $ref: '#/components/schemas/ExpandedValidityPeriodSummary'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/{custom-object-name}:
    get:
      summary: List custom object records
      description: >
        Lists custom object records. You can use the query parameters to filter,
        expand, and sort the returned results. 


        The name of a custom object is in the `{namespace}__{objectname}s`
        format, for example, `default__cars`.


        **Note**: Sorting queried custom objects by ID is not supported.
      operationId: queryCustomObjects
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Custom Object Name with NameSpace, e.g. default__cars
          in: path
          name: custom-object-name
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: OWVmMGIxYTAtZTM5OC00NmFhLTg1NmYtNzYyNzNiMGQyOTg4
                data:
                  - createdById: 8ad08c0f7f9c7144017fab88cd2e27d7
                    createdDate: '2023-05-12T03:44:40.733Z'
                    id: 901e5409-e846-47cf-92af-05ccb0e0be96
                    mSRP__c: 235600
                    updatedById: 8ad08c0f7f9c7144017fab88cd2e27d7
                    updatedDate: '2023-05-12T06:21:41.551Z'
                    brand__c: Porsche
                    color__c: red
                    model__c: '911'
                  - createdById: 8ad08c0f7f9c7144017fab88cd2e27d7
                    createdDate: '2023-05-12T03:45:33.409Z'
                    id: 79f9080f-0c3a-4b35-a587-eb1447e6e1cc
                    mSRP__c: 60000
                    updatedById: 8ad08c0f7f9c7144017fab88cd2e27d7
                    updatedDate: '2023-05-12T03:45:33.409Z'
                    brand__c: BMW
                    color__c: blue
                    model__c: Z4
              schema:
                type: object
                title: QueryCustomObjectsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/{custom-object-name}/{key}:
    get:
      summary: Retrieve a custom object record
      description: >
        Retrieve the details of a specific custom object record. 


        The name of a custom object is in the `{namespace}__{objectname}s`
        format, for example, `default__cars`.
      operationId: queryCustomObjectBykey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: Custom Object Name with NameSpace, for example, `default__cars`.
          in: path
          name: custom-object-name
          required: true
          schema:
            type: string
        - description: Object ID.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: A case-insensitive filter on the list.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                createdById: 8ad08c0f7f9c7144017fab88cd2e27d7
                createdDate: '2023-05-12T03:44:40.733Z'
                id: 901e5409-e846-47cf-92af-05ccb0e0be96
                mSRP__c: 235600
                updatedById: 8ad08c0f7f9c7144017fab88cd2e27d7
                updatedDate: '2023-05-12T06:21:41.551Z'
                brand__c: Porsche
                color__c: red
                model__c: '911'
              schema:
                type: object
                additionalProperties: true
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contact-snapshots:
    get:
      summary: List contact snapshots
      description: >
        Lists contact snapshots. You can use the query parameters to filter,
        expand, and sort the returned results.
      operationId: queryContactSnapshots
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >
            The maximum number of results to return in a single page. If the

            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a

            400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >
            A cursor for use in pagination. A cursor defines the starting place

            in a list. For instance, if you make a list request and receive 100
            objects,

            ending with `next_page=W3sib3JkZXJ=`, your subsequent call can
            include `cursor=W3sib3JkZXJ=`

            in order to fetch the next page of the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >
            A case-insensitive query parameter that specifies the sort order of\

            \ the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending\

            \ (e.g. `accountnumber.DESC`). You cannot sort on properties in
            arrays. If the\

            \ array-type properties are specified for the `sort[]` parameter,
            they are ignored.\n\

            Supported sortable fields: \n  - id\n  - updateddate\n  - contactid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >
            Allows you to expand responses by including related object
            information

            in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: |-
            A case-insensitive filter on the list.

            Supported filterable fields: 
              - id
              - updateddate
              - contactid
              - {indexedcustomfield}: Use the format like `customField__c` to filter on custom fields.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                nextPage: >-
                  W3sidmFsdWUiOiIyMDI0LTEyLTE2VDE3OjU1OjA1LTA4OjAwIiwib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19LHsidmFsdWUiOiI4YWQwOWJlNDhkYjVhYmE3MDE4ZGI2MDQ3NzZkNDg1NCIsIm9yZGVyQnkiOnsiZmllbGQiOiJJZCIsIm9yZGVyIjoiREVTQyJ9fV0=
                data:
                  - id: 8ad08eb292f6328c019318dcd43821b0
                    contactId: 8ad08eb292f6328c019318dcd45521b1
                    accountId: 8ad08eb292f6328c019318dcd4123456
                    firstName: Bella
                    lastName: Lawrence
                    workEmail: bella.lawrence@example.com
                    mobilePhone: +1-555-234-5678
                    country: USA
                    state: California
                    postalCode: '94103'
                    address1: 123 Main St
                    address2: Suite 200
                    city: San Francisco
                    description: Primary contact for billing
                    createdById: 2c92c0f972a852360172bbe22ac551b6
                    createdDate: '2024-11-10T17:35:45-08:00'
                    updatedById: 2c92c0f972a852360172bbe22ac551b6
                    updatedDate: '2025-03-21T03:24:15-07:00'
              schema:
                type: object
                title: QueryContactSnapshotsResponse
                description: ''
                nullable: false
                additionalProperties: false
                properties:
                  nextPage:
                    type: string
                    description: >
                      A string that can be used as the `cursor` value to
                      retrieve the next page of the response if it exists;
                      otherwise absent.
                    nullable: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExpandedContactSnapshot'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/contact-snapshots/{key}:
    get:
      summary: Retrieve a contact snapshot
      description: >
        Retrieves detailed information about a specific contact snapshot by its
        unique ID.
      operationId: queryContactSnapshotByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
        - description: The unique identifier of the contact snapshot to retrieve.
          in: path
          name: key
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >
            The maximum number of results to return in a single page. If the

            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a

            400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >
            A cursor for use in pagination. A cursor defines the starting place

            in a list. For instance, if you make a list request and receive 100
            objects,

            ending with `next_page=W3sib3JkZXJ=`, your subsequent call can
            include `cursor=W3sib3JkZXJ=`

            in order to fetch the next page of the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >
            A case-insensitive query parameter that specifies the sort order of

            the list, which can be either ascending (e.g. `accountnumber.ASC`)
            or descending

            (e.g. `accountnumber.DESC`). You cannot sort on properties in
            arrays. If the

            array-type properties are specified for the `sort[]` parameter, they
            are ignored. 

            The fields that can be sorted include:  
              - id
              - updateddate
              - contactid
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            Allows you to expand responses by including related object
            information in a single call.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >
            A case-insensitive filter on the list. The available options
            include:
              - id
              - updateddate
              - contactid
              - {indexedcustomfield}
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          content:
            application/json:
              example:
                id: 8ad08eb292f6328c019318dcd43821b0
                contactId: 8ad08eb292f6328c019318dcd45521b1
                accountId: 8ad08eb292f6328c019318dcd4123456
                firstName: Bella
                lastName: Lawrence
                workEmail: bella.lawrence@example.com
                mobilePhone: +1-555-234-5678
                country: USA
                state: California
                postalCode: '94103'
                address1: 123 Main St
                address2: Suite 200
                city: San Francisco
                description: Primary contact for billing
                createdById: 2c92c0f972a852360172bbe22ac551b6
                createdDate: '2024-11-10T17:35:45-08:00'
                updatedById: 2c92c0f972a852360172bbe22ac551b6
                updatedDate: '2025-03-21T03:24:15-07:00'
              schema:
                $ref: '#/components/schemas/ExpandedContactSnapshot'
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-details:
    get:
      summary: List rating details
      description: >
        Lists rating details. Use query parameters to paginate and filter
        results.
      operationId: queryRatingDetails
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `id.ASC`) or
            descending (e.g. `id.DESC`).

            Supported sortable fields:
              - `id`
              - `invoiceitemid`
              - `creditmemoitemid`
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >
            Allows you to expand responses by including related object
            information in a single call. This operation does not have
            expandable fields.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive filter on the list.


            Supported filterable fields:
              - `id`
              - `invoiceitemid`
              - `creditmemoitemid`

            You can also filter on custom fields using the format
            `customField__c`.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryRatingDetailsResponse'
              example:
                nextPage: >-
                  W3sib3JkZXJCeSI6eyJmaWVsZCI6IkNyZWF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn19XQ==
                data:
                  - id: rd-001
                    invoiceItemId: ii-123
                    creditMemoItemId: null
                    chargeType: Usage
                    chargeModel: FlatFee
                    formula: UnitPrice * Quantity
                    calculation: 10 * 5
                    calculatedAmount: 50
                    currency: USD
                    unitOfMeasure: API Calls
                    quantity: 5
                    isProration: false
                    isCredit: false
                    amountWithoutTax: 50
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /object-query/rating-details/{key}:
    get:
      summary: Retrieve a rating detail
      description: |
        Retrieves a single rating detail by ID.
      operationId: queryRatingDetailByKey
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - name: key
          in: path
          required: true
          schema:
            type: string
        - in: query
          name: pageSize
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 99
            default: 10
          description: >-
            The maximum number of results to return in a single page. If the
            specified `pageSize` is less than 1 or greater than 99, Zuora will
            return a 400 error.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            A cursor for use in pagination. A cursor defines the starting place
            in a list. For instance, if you make a list request and receive 100
            objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call
            can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of
            the list.
        - in: query
          name: sort[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that specifies the sort order of
            the list, which can be either ascending (e.g. `id.ASC`) or
            descending (e.g. `id.DESC`).

            Supported sortable fields:
              - `id`
              - `invoiceitemid`
              - `creditmemoitemid`
        - in: query
          name: expand[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >
            Allows you to expand responses by including related object
            information in a single call. This operation does not have
            expandable fields.
        - in: query
          name: filter[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive filter on the list.


            Supported filterable fields:
              - `id`
              - `invoiceitemid`
              - `creditmemoitemid`

            You can also filter on custom fields using the format
            `customField__c`.
        - in: query
          name: fields[]
          required: false
          schema:
            type: array
            items:
              type: string
          description: >-
            A case-insensitive query parameter that allows you to specify which
            fields are returned in the response.
          example: id,createddate
        - in: query
          name: includeNullFields
          required: false
          schema:
            type: boolean
            default: false
          description: >
            Specifies whether to include fields with the `null` value in the
            response.


            - If set to `true`, all fields will be returned in the response,
            including those with the `null` value.

            - If set to `false`, only fields with non-null values will be
            returned.
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RatingDetails'
              example:
                id: rd-001
                invoiceItemId: ii-123
                creditMemoItemId: null
                chargeType: Usage
                chargeModel: FlatFee
                formula: UnitPrice * Quantity
                calculation: 10 * 5
                calculatedAmount: 50
                currency: USD
                unitOfMeasure: API Calls
                quantity: 5
                isProration: false
                isCredit: false
                amountWithoutTax: 50
        '500':
          content:
            application/json:
              example:
                reasons:
                  - code: 50000060
                    message: >-
                      An unexpected error occurred. Please try again or reach
                      out to Zuora Support
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Internal server error
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              example:
                reasons:
                  - code: 50000027
                    message: 'Invalid filter parameter: id'
                requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
              schema:
                $ref: '#/components/schemas/CommonOQErrorResponse'
          description: Invalid input
          headers:
            Content-Encoding:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding'
            RateLimit-Limit:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset'
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      tags:
        - Object Queries
      x-accepts: application/json
  /query/jobs:
    get:
      description: >
        Returns a list of [data
        query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query)
        jobs that have been created in your Zuora tenant. You can filter the
        list by status.


        If you are an administrator, you can retrieve all the query jobs in your
        tenant. Otherwise, you can only retrieve your own query jobs.
      operationId: GET_DataQueryJobs
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Filters the list of query jobs by status.
          in: query
          name: queryStatus
          required: false
          schema:
            enum:
              - accepted
              - in_progress
              - completed
              - failed
              - cancelled
            type: string
        - description: |
            The number of records returned per page in the response.
          in: query
          name: pageSize
          required: false
          schema:
            default: 20
            maximum: 1000
            type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2
                        id: bf3b5640-ddd1-4b4f-9a81-906ec2b84a89
                        query: >-
                          SELECT s.id FROM Subscription s JOIN RatePlan rp ON
                          s.id = rp.subscriptionid WHERE rp.name = 'Premium
                          Monthly'
                        queryStatus: in_progress
                        remainingRetries: 3
                        sourceData: LIVE
                        updatedOn: '2018-08-17T13:14:38.855Z'
                        useIndexJoin: false
                      - createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2
                        dataFile: >-
                          https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=...
                        id: 3a3e85c4-96e7-486b-ae02-827120104301
                        outputRows: 24516
                        processingTime: 9212
                        query: >-
                          SELECT accountnumber, balance FROM Account WHERE
                          Account.balance > 100
                        queryStatus: completed
                        remainingRetries: 3
                        sourceData: LIVE
                        updatedOn: '2018-08-17T13:14:19.17Z'
                        useIndexJoin: false
              schema:
                $ref: '#/components/schemas/GetDataQueryJobsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List data query jobs
      tags:
        - Data Queries
    post:
      description: >
        Submits a [data
        query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to
        be executed by Zuora, creating a new query job. Use the [Retrieve a data
        query
        job](https://developer.zuora.com/v1-api-reference/api/operation/GET_DataQueryJob/)
        endpoint to monitor the job status and access the results once complete.


        **Note:** The request must include the `Content-Type: application/json`
        header. If this header is missing, the request will fail with the
        following error:   `{"code":415,"message":"HTTP 415 Unsupported Media
        Type"}`
      operationId: POST_DataQueryJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - name: Content-Type
          in: header
          required: true
          description: >
            Specifies the media type of the request payload. You must include
            the `Content-Type: application/json` header when submitting a data
            query.
          schema:
            type: string
            enum:
              - application/json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitDataQueryRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      id: 5948abde-b875-4d06-ad07-c2138853d8bc
                      query: >-
                        SELECT accountnumber, balance FROM Account WHERE
                        Account.balance > 100
                      useIndexJoin: false
                      sourceData: LIVE
                      queryStatus: accepted
                      remainingRetries: 3
                      retries: 3
                      updatedOn: '2024-07-09T09:47:49.675Z'
                      createdOn: '2024-07-09T09:47:49.675Z'
                      createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2
                      createdByUserEmail: amy@mycompany.com
              schema:
                $ref: '#/components/schemas/SubmitDataQueryResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 400
                    message: Unable to process JSON
              schema:
                $ref: '#/components/schemas/DataQueryErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '415':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 415
                    message: HTTP 415 Unsupported Media Type
              schema:
                $ref: '#/components/schemas/DataQueryErrorResponse'
          description: >
            Unsupported Media Type. This error is returned when the request is
            missing the required `Content-Type: application/json` header.      
      summary: Submit a data query
      tags:
        - Data Queries
  /query/jobs/{job-id}:
    delete:
      description: >
        Cancels a [data
        query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query)
        job, which prevents Zuora from performing the query. This operation is
        only applicable if the status of the query job is `accepted` or
        `in_progress`.
      operationId: DELETE_DataQueryJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Internal identifier of the query job.
          in: path
          name: job-id
          required: true
          schema:
            format: uuid
            maxLength: 64
            minLength: 64
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2
                      id: 3a3e85c4-96e7-486b-ae02-827120104301
                      query: >-
                        SELECT accountnumber, balance FROM Account WHERE
                        Account.balance > 100
                      queryStatus: cancelled
                      remainingRetries: 3
                      sourceData: LIVE
                      updatedOn: '2018-08-17T13:22:16.965Z'
                      useIndexJoin: false
              schema:
                $ref: '#/components/schemas/DeleteDataQueryJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 1003
                    message: >-
                      Query job c20a8ff4-3960-4c85-b067-d5259035f523 is not in
                      accepted or in_progress status
              schema:
                $ref: '#/components/schemas/DataQueryErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a data query job
      tags:
        - Data Queries
    get:
      description: >
        Retrieves a [data
        query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query)
        job. You can use this operation to track the status of the query job and
        obtain the URL of the query results.


        If you are an administrator, you can retrieve every query job in your
        tenant. 


        If you are a non-admin user and try to retrieve a query job that you are
        not the owner of, you will get a 403 response indicating that you are
        forbidden from viewing this job. As a non-admin user, you can only
        retrieve your own query job.
      operationId: GET_DataQueryJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Internal identifier of the query job.
          in: path
          name: job-id
          required: true
          schema:
            format: uuid
            maxLength: 36
            minLength: 36
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2
                      dataFile: >-
                        https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=...
                      id: 3a3e85c4-96e7-486b-ae02-827120104301
                      outputRows: 24516
                      processingTime: 9212
                      query: >-
                        SELECT accountnumber, balance FROM Account WHERE
                        Account.balance > 100
                      queryStatus: completed
                      remainingRetries: 3
                      sourceData: LIVE
                      updatedOn: '2018-08-17T13:14:19.17Z'
                      useIndexJoin: false
              schema:
                $ref: '#/components/schemas/GetDataQueryJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '403':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 1009
                    message: >-
                      Access denied for restricted job
                      ea50af05-6163-47e1-bf9b-c8e10648d8a3
              schema:
                $ref: '#/components/schemas/DataQueryErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    code: 1001
                    message: 'No such query: 1e8e8586-5366-4cdf-a01d-fae3b2cf8427'
              schema:
                $ref: '#/components/schemas/DataQueryErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a data query job
      tags:
        - Data Queries
  /v1/batch-query:
    post:
      description: >
        Submits an AQuA job that contains an aggregated list of ZOQL and Export
        ZOQL queries.
      operationId: POST_BatchQueryJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitBatchQueryRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 8ad08f06909293cd01909613f23549e4
                    status: submitted
                    version: 1
                    format: CSV
                    batches:
                      - batchId: 8ad08f06909293cd01909613f23549e5
                        status: pending
                        localizedStatus: pending
                        apiVersion: '145.0'
                        recordCount: 0
                        batchType: zoql
                        full: true
                        query: select AccountNumber, BillCycleDay from Account
                    encrypted: none
                    useLastCompletedJobQueries: false
                    offset: 0
              schema:
                $ref: '#/components/schemas/SubmitBatchQueryResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Submit an aggregate query job
      tags:
        - Aggregate Queries
  /v1/batch-query/jobs/partner/{partner}/project/{project}:
    get:
      description: >
        Returns the details of the last completed job.


        The completed AQuA jobs that were created 180 days ago are deleted
        permanently from Zuora, so you cannot query these jobs through API or
        AQuA job finder.
      operationId: GET_LastBatchQueryJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            The unique ID of a data integration partner. 
          in: path
          name: partner
          required: true
          schema:
            type: string
        - description: >
            The unique ID of a data integration project for a particular
            partner.
          in: path
          name: project
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    batches:
                      - apiVersion: '60.0'
                        batchId: 402881824835bb2a01483c1e678c025b
                        batchType: zoqlexport
                        fileId: 402881824835bb2a01483c1e67c7025d
                        full: false
                        message: ''
                        name: AccountingPeriod
                        query: >-
                          select Id,StartDate,EndDate,FiscalYear,Name,Status
                          from AccountingPeriod
                        recordCount: 0
                        status: completed
                    encrypted: none
                    format: CSV
                    id: 402881824835bb2a01483c1e678a025a
                    name: Example
                    partner: salesforce
                    project: 00170000011K3Ub
                    sourceData: LIVE
                    startTime: '2014-09-03 08:24:58'
                    status: completed
                    version: '1.1'
              schema:
                $ref: '#/components/schemas/GetAggregateQueryJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Retrieve the last completed aggregate query job
      tags:
        - Aggregate Queries
  /v1/batch-query/jobs/{jobid}:
    delete:
      description: >
        Cancels the current AQuA job, only if the job is not complete. If the
        job is complete, an error is thrown.
      operationId: DELETE_BatchQueryJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Internal identifier of the query job.
          in: path
          name: jobid
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    batches:
                      - batchId: e20b07474688ad5001468daf10ea01df
                        batchType: zoqlexport
                        fileId: e20b07474688ad5001468daf155f01f5
                        message: ''
                        name: InvoiceItemAdjustment
                        query: >-
                          select
                          AccountingCode,CancelledDate,CreatedDate,Id,InvoiceId,InvoiceItemName,
                          InvoiceNumber,SourceType,AdjustmentNumber,ServiceStartDate,ServiceEndDate,AdjustmentDate,
                          Amount,Status,AccountId,SourceId,Type,ReasonCode,
                          UpdatedDate  from  InvoiceItemAdjustment
                        recordCount: 1580
                        status: completed
                      - batchId: e20b07474688ad5001468daf10ec01e0
                        batchType: zoqlexport
                        fileId: e20b07474688ad5001468daf166601f6
                        message: ''
                        name: InvoiceAdjustment
                        query: >-
                          select
                          AccountingCode,CancelledOn,CreatedDate,Id,ImpactAmount,Invoice.Id,
                          InvoiceNumber,AdjustmentNumber,AdjustmentDate,Amount,Status,Account.Id,Type,ReasonCode,
                          UpdatedDate  from  InvoiceAdjustment
                        recordCount: 411
                        status: completed
                    encrypted: none
                    format: CSV
                    id: e20b07474688ad5001468daf10e501de
                    name: June10
                    sourceData: LIVE
                    status: cancelled
                    version: '1.1'
              schema:
                $ref: '#/components/schemas/DeleteBatchQueryJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Cancel a running aggregate query job
      tags:
        - Aggregate Queries
    get:
      description: >
        Retrieves an aggregate query using the Job ID.


        Note that the completed AQuA jobs that were created 180 days ago are
        deleted permanently from Zuora, so you cannot query these jobs through
        API or AQuA job finder.
      operationId: GET_BatchQueryJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Internal identifier of the query job.
          in: path
          name: jobid
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    batches:
                      - apiVersion: '60.0'
                        batchId: 402881824835bb2a01483c19f7da0257
                        batchType: zoqlexport
                        fileId: 402881824835bb2a01483c19f8190259
                        full: true
                        message: ''
                        name: AccountingPeriod
                        query: >-
                          select Id,StartDate,EndDate,FiscalYear,Name,Status
                          from AccountingPeriod
                        recordCount: 1
                        status: completed
                    encrypted: none
                    format: CSV
                    id: 402881824835bb2a01483c19f7d70256
                    name: Example
                    partner: salesforce
                    project: 00170000011K3Ub
                    sourceData: LIVE
                    startTime: '2014-09-03 08:20:07'
                    status: completed
                    version: '1.1'
              schema:
                $ref: '#/components/schemas/GetAggregateQueryJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Retrieve an aggregate query job
      tags:
        - Aggregate Queries
  /deployment-manager/deployment_artifacts:
    get:
      description: >
        Download a template for migration in the Deployment manager from the
        source tenant to the target tenant.
      operationId: GET_DownloadDeploymentTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Id which template needs to be downloaded.
          in: query
          name: deployment_template_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value: {}
              schema:
                $ref: '#/components/schemas/JsonNode'
          description: Successfully downloaded the template.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Id is invalid
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: Download a template
      tags:
        - Configuration Templates
  /deployment-manager/deployment_artifacts/compare:
    post:
      description: >
        To Compare the configurations from the template downloaded and used in
        deployment manager for migration which is available in source and target
        tenant.
      operationId: POST_CompareTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Customers need to specify tenant ID.
          in: query
          name: tenant
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                template:
                  description: >-
                    Template contains the config metadata and target tenant
                    information.
                  format: binary
                  type: string
              type: object
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    customFields:
                      - errors: []
                        originalPayload:
                          count: 2
                          definitions:
                            Account:
                              schema:
                                additionalProperties: false
                                indexed:
                                  - Last_Token_Transaction_Date__c
                                  - idx_date_1__c
                                properties:
                                  CollectionsAgent__c:
                                    createdDate: '2022-08-22T18:16:38.000Z'
                                    default: abc
                                    description: ''
                                    label: Collections Agent
                                    maxLength: 255
                                    type: string
                                    updatedDate: '2022-08-22T18:16:38.000Z'
                                  InCollections__c:
                                    createdDate: '2022-08-18T12:38:04.000Z'
                                    description: ''
                                    label: <details/open/ontoggle=confirm(cookie)>
                                    maxLength: 25
                                    type: string
                                    updatedDate: '2022-08-18T12:38:04.000Z'
                                  Last_Token_Transaction_Date__c:
                                    createdDate: '2022-08-22T19:30:10.000Z'
                                    description: ''
                                    label: Last_Token_Transaction_Date
                                    maxLength: 255
                                    type: string
                                    updatedDate: '2022-08-22T19:30:10.000Z'
                                  idx_date_1__c:
                                    createdDate: '2022-08-18T12:38:13.000Z'
                                    description: test
                                    format: date
                                    label: idx_date_1
                                    type: string
                                    updatedDate: '2022-08-18T12:38:13.000Z'
                                  non_idx_text_1__c:
                                    createdDate: '2022-08-18T12:38:14.000Z'
                                    default: non_idx_text_1
                                    description: non_idx_text_1
                                    label: non_idx_text_1
                                    maxLength: 50
                                    type: string
                                    updatedDate: '2022-08-18T12:38:14.000Z'
                                readOnlyOnUI:
                                  - idx_date_1__c
                                  - non_idx_text_1__c
                                type: object
                              type: Account
                            AccountingCode:
                              schema:
                                additionalProperties: false
                                properties:
                                  AccountingCodeCustomDate__c:
                                    createdDate: '2022-02-08T07:20:15.000Z'
                                    format: date
                                    label: AccountingCodeCustomDate
                                    type: string
                                    updatedDate: '2022-02-08T07:20:15.000Z'
                                  AccountingCodeCustomPickList__c:
                                    createdDate: '2022-02-08T07:20:18.000Z'
                                    default: Alpha
                                    enum:
                                      - Alpha
                                      - Beta
                                      - Omega
                                    label: AccountingCodeCustomPickList
                                    type: string
                                    updatedDate: '2022-02-08T07:20:18.000Z'
                                  AccountingCodeCustomText__c:
                                    createdDate: '2022-02-01T08:41:03.000Z'
                                    default: custom text
                                    label: AccountingCodeCustomText
                                    maxLength: 64
                                    type: string
                                    updatedDate: '2022-02-01T08:41:03.000Z'
                                type: object
                              type: AccountingCode
                        response:
                          - componentType: CustomFields
                            error: '-'
                            id: a8a0ff9f-3297-45a5-a523-4f5d5f4f393a
                            key: idx_date_1
                            method: GET
                            payload:
                              API_name: idx_date_1__c
                              UIReadOnly: true
                              description: test
                              format: date
                              indexed: true
                              label: idx_date_1
                            result: DONE
                            segregationKey: Account
                            templateId: null
                            url: '-'
                        segregationKeys:
                          - Account
                          - Invoice
                          - InvoiceItem
                          - AccountingCode
                          - ProductRatePlanCharge
                          - ProductFeature
                          - Product
                          - JournalEntry
                          - RatePlan
                          - Amendment
                          - DebitTaxationItem
                          - Subscription
                          - Order
                          - Usage
                          - ProductRatePlan
                          - AccountingPeriod
                          - CreditMemoItem
                          - RevenueSchedule
                          - RatePlanCharge
                          - Contact
                          - OrderAction
                          - Payment
                          - CreditBalanceAdjustment
                          - Refund
                          - DebitMemo
                    customObjects:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: CustomObjects
                            error: '-'
                            id: 456335f2-711d-4e73-b8ec-3309e78b403a
                            key: zzzzzzzzzz
                            method: GET
                            payload:
                              api_name: zzzzzzzzzz
                              customFields:
                                - api_name: isFilterable__c
                                  description: ' '
                                  field_name: isFilterable
                                  filterable: 'true'
                                  required: 'false'
                                  type: boolean
                                - api_name: picklist__c
                                  description: ' '
                                  field_name: picklist
                                  filterable: 'false'
                                  required: 'false'
                                  type: string
                                - api_name: zzz__c
                                  description: ' '
                                  field_name: zzz
                                  filterable: 'false'
                                  required: 'false'
                                  type: string
                              description: ' '
                              enableRecordMigration: 'false'
                              label: zzzzzzzzzz
                            result: DONE
                            segregationKey: Available Custom Objects
                            templateId: null
                            url: /zzzzzzzzzz
                        segregationKeys:
                          - Available Custom Objects
                    dataAccessControl:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: dataAccessControl
                            error: '-'
                            id: 456335f2-711d-4e73-b8ec-3309e78b403a
                            key: zzzzzzzzzz
                            method: GET
                            payload: {}
                            result: DONE
                            segregationKey: Available dataAccessControl
                            templateId: null
                            url: /zzzzzzzzzz
                        segregationKeys:
                          - Available dataAccessControl
                    notifications:
                      - errors: []
                        originalPayload:
                          2c92c8fb7ddc795b017dde4350c949a0:
                            - active: false
                              calloutAuth: false
                              calloutOauth2: false
                              calloutOption: false
                              calloutPreemptiveAuth: false
                              calloutRetriable: false
                              contentType: APPLICATION_JSON
                              description: >-
                                Trigger the notification when invoices are
                                posted within a bill run and the bill run has
                                auto-post. This is to support existing email
                                notification behavior from within a bill run.
                              emailOption: true
                              emailTemplate: 2c92c8f9631ea3850163271f80152de2
                              emailTemplateName: Invoice Posted Default Email Template
                              eventId: 2c92c8f9631ea3850163271f7fa02da0
                              eventName: New Invoice Posted
                              hidden: false
                              id: 2c92c8fb7ddc795b017dde437a0949a6
                              name: Invoice Posted within a Bill Run of Auto-Post
                              param1: BILLRUN
                              param4: Not include invoice PDF
                              profileId: 2c92c8fb7ddc795b017dde4350c949a0
                              useCustomRequestBody: false
                        response:
                          - componentType: Notifications
                            error: '-'
                            id: f5ee9c26-8420-4f92-9463-1983d1268281
                            key: B2C Customers
                            method: GET
                            payload:
                              description: ''
                              id: 2c92c8fb7ddc795b017dde4350c949a0
                              isDefault: false
                              locale: default
                              name: B2C Customers
                            result: DONE
                            segregationKey: Communication profile
                            templateId: null
                            url: >-
                              settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0
                        segregationKeys:
                          - Communication profile
                          - Email Templates
                    productCatalog:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: productCatalog
                            error: '-'
                            id: 456335f2-711d-4e73-b8ec-3309e78b403a
                            key: zzzzzzzzzz
                            method: GET
                            payload: {}
                            result: DONE
                            segregationKey: Available productCatalog
                            templateId: null
                            url: /zzzzzzzzzz
                        segregationKeys:
                          - Available productCatalog
                    settings:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: Settings
                            error: >
                              {"success":false,"reasons":[{"message":"Failed to
                              get user info","code":"90000011"}]}
                            id: bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6
                            key: AccountingPeriods
                            method: GET
                            payload: {}
                            result: FAILED
                            segregationKey: Finance
                            templateId: null
                            url: v1/accounting-periods
                          - componentType: Settings
                            error: null
                            id: 6a27d0d3-3c4c-408f-b160-04510014ebf1
                            key: AccountingRules
                            method: GET
                            payload:
                              allowBlankAccountingCodes: true
                              allowCreationInClosedPeriod: true
                              allowRevenueScheduleNegativeAmounts: false
                              allowUsageInClosedPeriod: false
                            result: DONE
                            segregationKey: Finance
                            templateId: null
                            url: /accounting-rules
                        segregationKeys:
                          - Finance
                          - Billing
                          - Administration
                          - ManageMultiEntity
                          - Payments
                          - Taxation
                          - BillingDocumentConfiguration
                          - ManageDataAccessControl
                    workflows:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: WorkFlows
                            error: '-'
                            id: df74980b-ff25-4684-a950-7e0c25810a72
                            key: >-
                              Resume Subscriptions for Accounts with Zero
                              Balance Limit 1_0.0.13
                            method: GET
                            payload:
                              active_version:
                                calloutTrigger: true
                                createdAt: '2022-08-21T10:51:22.613-07:00'
                                created_by:
                                  created_at: '2021-11-22T19:06:54.279-08:00'
                                  updated_at: '2022-09-06T05:16:20.455-07:00'
                                  work_email: rkumar@zuora.com
                                definitionId: 1
                                description: ''
                                id: 2483
                                interval: null
                                name: >-
                                  Resume Subscriptions for Accounts with Zero
                                  Balance Limit 1
                                ondemandTrigger: true
                                priority: Medium
                                scheduledTrigger: false
                                status: Active
                                timezone: null
                                type: Workflow::Setup
                                updatedAt: '2022-08-21T10:51:22.613-07:00'
                                updated_by:
                                  created_at: N/A
                                  updated_at: N/A
                                  work_email: N/A
                                version: 0.0.13
                              calloutTrigger: true
                              createdAt: '2022-08-21T10:51:22.613-07:00'
                              description: ''
                              id: 1
                              interval: null
                              latest_inactive_versions:
                                - calloutTrigger: true
                                  createdAt: '2022-05-10T05:21:37.192-07:00'
                                  created_by:
                                    created_at: '2021-11-22T19:06:54.279-08:00'
                                    updated_at: '2022-09-06T05:16:20.455-07:00'
                                    work_email: rkumar@zuora.com
                                  definitionId: 1
                                  description: ''
                                  id: 689
                                  interval: null
                                  name: >-
                                    Resume Subscriptions for Accounts with Zero
                                    Balance Limit 1
                                  ondemandTrigger: true
                                  priority: Medium
                                  scheduledTrigger: false
                                  status: Inactive
                                  timezone: null
                                  type: Workflow::Setup
                                  updatedAt: '2022-05-10T05:21:37.192-07:00'
                                  updated_by:
                                    created_at: N/A
                                    updated_at: N/A
                                    work_email: N/A
                                  version: 0.0.10
                              name: >-
                                Resume Subscriptions for Accounts with Zero
                                Balance Limit 1
                              ondemandTrigger: true
                              priority: Medium
                              scheduledTrigger: false
                              status: Active
                              timezone: null
                              updatedAt: '2022-08-21T10:51:22.613-07:00'
                            result: DONE
                            segregationKey: >-
                              Resume Subscriptions for Accounts with Zero
                              Balance Limit 1
                            templateId: null
                            url: '1'
                        segregationKeys:
                          - Payment to Provision
                          - >-
                            Negative Invoices to Positive Account Credit Balance
                            Limit 1
                          - Automated Dunning | 2nd Attempt Failed
                          - Subscription Price Uplift -- JSON Transform
              schema:
                $ref: '#/components/schemas/CompareSchemaInfoResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '201':
          description: >
            created.

            The request has been fulfilled and resulted in a new resource being
            created. The newly created resource can be referenced by the URL(s)
            returned in the entity of the response, with the most specific URL
            for the resource given by a Location header field.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: Compare settings between a source tenant and a target tenant
      tags:
        - Configuration Templates
  /deployment-manager/deployment_artifacts/deploy:
    post:
      description: >
        To migrate the selected configuration of a tenant in Deployment Manager
        migration while using template from the compare screen.
      operationId: POST_MigrateTenantSettings
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Customers need to specify tenant ID in query parameter.
          in: query
          name: tenant
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateMigrationClientRequest'
        description: Request Details.
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    emailIds: daco@zuora.com
                    environment: US-API-Sandbox-Staging
                    id: aa7b4ffa-f30c-4f42-b240-9534f634e14f
                    migratedBy: Daco user
                    migrationDescription: Migration from/to Sandbox
                    migrationEnd: '2020-11-01 18:00:00'
                    migrationName: Job A
                    migrationStart: '2020-11-01 18:00:00'
                    response: []
                    sourceTenantDescription: Jren-Stage
                    sourceTenantName: Payment Gateway Test Tenant
                    status: DONE
                    type: Tenant
              schema:
                $ref: '#/components/schemas/MigrationClientResponse'
          description: Successfully migrated from source to target.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '201':
          description: >
            created.

            The request has been fulfilled and resulted in a new resource being
            created. The newly created resource can be referenced by the URL(s)
            returned in the entity of the response, with the most specific URL
            for the resource given by a Location header field.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: Migrate settings from source tenant to target tenant
      tags:
        - Configuration Templates
  /deployment-manager/deployment_artifacts/retrieve-settings:
    get:
      description: >
        When the advanced option is clicked, get the details/metadata of the
        components, such as settings, notifications, workflow, etc.
      operationId: GET_SourceComponentDetails
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    customFields:
                      - errors: []
                        originalPayload:
                          count: 2
                          definitions:
                            Account:
                              schema:
                                additionalProperties: false
                                indexed:
                                  - Last_Token_Transaction_Date__c
                                  - idx_date_1__c
                                properties:
                                  CollectionsAgent__c:
                                    createdDate: '2022-08-22T18:16:38.000Z'
                                    default: abc
                                    description: ''
                                    label: Collections Agent
                                    maxLength: 255
                                    type: string
                                    updatedDate: '2022-08-22T18:16:38.000Z'
                                  InCollections__c:
                                    createdDate: '2022-08-18T12:38:04.000Z'
                                    description: ''
                                    label: <details/open/ontoggle=confirm(cookie)>
                                    maxLength: 25
                                    type: string
                                    updatedDate: '2022-08-18T12:38:04.000Z'
                                  Last_Token_Transaction_Date__c:
                                    createdDate: '2022-08-22T19:30:10.000Z'
                                    description: ''
                                    label: Last_Token_Transaction_Date
                                    maxLength: 255
                                    type: string
                                    updatedDate: '2022-08-22T19:30:10.000Z'
                                  idx_date_1__c:
                                    createdDate: '2022-08-18T12:38:13.000Z'
                                    description: test
                                    format: date
                                    label: idx_date_1
                                    type: string
                                    updatedDate: '2022-08-18T12:38:13.000Z'
                                  non_idx_text_1__c:
                                    createdDate: '2022-08-18T12:38:14.000Z'
                                    default: non_idx_text_1
                                    description: non_idx_text_1
                                    label: non_idx_text_1
                                    maxLength: 50
                                    type: string
                                    updatedDate: '2022-08-18T12:38:14.000Z'
                                readOnlyOnUI:
                                  - idx_date_1__c
                                  - non_idx_text_1__c
                                type: object
                              type: Account
                            AccountingCode:
                              schema:
                                additionalProperties: false
                                properties:
                                  AccountingCodeCustomDate__c:
                                    createdDate: '2022-02-08T07:20:15.000Z'
                                    format: date
                                    label: AccountingCodeCustomDate
                                    type: string
                                    updatedDate: '2022-02-08T07:20:15.000Z'
                                  AccountingCodeCustomPickList__c:
                                    createdDate: '2022-02-08T07:20:18.000Z'
                                    default: Alpha
                                    enum:
                                      - Alpha
                                      - Beta
                                      - Omega
                                    label: AccountingCodeCustomPickList
                                    type: string
                                    updatedDate: '2022-02-08T07:20:18.000Z'
                                  AccountingCodeCustomText__c:
                                    createdDate: '2022-02-01T08:41:03.000Z'
                                    default: custom text
                                    label: AccountingCodeCustomText
                                    maxLength: 64
                                    type: string
                                    updatedDate: '2022-02-01T08:41:03.000Z'
                                type: object
                              type: AccountingCode
                        response:
                          - componentType: CustomFields
                            error: '-'
                            id: a8a0ff9f-3297-45a5-a523-4f5d5f4f393a
                            key: idx_date_1
                            method: GET
                            payload:
                              API_name: idx_date_1__c
                              UIReadOnly: true
                              description: test
                              format: date
                              indexed: true
                              label: idx_date_1
                            result: DONE
                            segregationKey: Account
                            templateId: null
                            url: '-'
                        segregationKeys:
                          - Account
                          - Invoice
                          - InvoiceItem
                          - AccountingCode
                          - ProductRatePlanCharge
                          - ProductFeature
                          - Product
                          - JournalEntry
                          - RatePlan
                          - Amendment
                          - DebitTaxationItem
                          - Subscription
                          - Order
                          - Usage
                          - ProductRatePlan
                          - AccountingPeriod
                          - CreditMemoItem
                          - RevenueSchedule
                          - RatePlanCharge
                          - Contact
                          - OrderAction
                          - Payment
                          - CreditBalanceAdjustment
                          - Refund
                          - DebitMemo
                    customObjects:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: CustomObjects
                            error: '-'
                            id: 456335f2-711d-4e73-b8ec-3309e78b403a
                            key: zzzzzzzzzz
                            method: GET
                            payload:
                              api_name: zzzzzzzzzz
                              customFields:
                                - api_name: isFilterable__c
                                  description: ' '
                                  field_name: isFilterable
                                  filterable: 'true'
                                  required: 'false'
                                  type: boolean
                                - api_name: picklist__c
                                  description: ' '
                                  field_name: picklist
                                  filterable: 'false'
                                  required: 'false'
                                  type: string
                                - api_name: zzz__c
                                  description: ' '
                                  field_name: zzz
                                  filterable: 'false'
                                  required: 'false'
                                  type: string
                              description: ' '
                              enableRecordMigration: 'false'
                              label: zzzzzzzzzz
                            result: DONE
                            segregationKey: Available Custom Objects
                            templateId: null
                            url: /zzzzzzzzzz
                        segregationKeys:
                          - Available Custom Objects
                    dataAccessControl:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: dataAccessControl
                            error: '-'
                            id: 456335f2-711d-4e73-b8ec-3309e78b403a
                            key: zzzzzzzzzz
                            method: GET
                            payload: {}
                            result: DONE
                            segregationKey: Available dataAccessControl
                            templateId: null
                            url: /zzzzzzzzzz
                        segregationKeys:
                          - Available dataAccessControl
                    notifications:
                      - errors: []
                        originalPayload:
                          2c92c8fb7ddc795b017dde4350c949a0:
                            - active: false
                              calloutAuth: false
                              calloutOauth2: false
                              calloutOption: false
                              calloutPreemptiveAuth: false
                              calloutRetriable: false
                              contentType: APPLICATION_JSON
                              description: >-
                                Trigger the notification when invoices are
                                posted within a bill run and the bill run has
                                auto-post. This is to support existing email
                                notification behavior from within a bill run.
                              emailOption: true
                              emailTemplate: 2c92c8f9631ea3850163271f80152de2
                              emailTemplateName: Invoice Posted Default Email Template
                              eventId: 2c92c8f9631ea3850163271f7fa02da0
                              eventName: New Invoice Posted
                              hidden: false
                              id: 2c92c8fb7ddc795b017dde437a0949a6
                              name: Invoice Posted within a Bill Run of Auto-Post
                              param1: BILLRUN
                              param4: Not include invoice PDF
                              profileId: 2c92c8fb7ddc795b017dde4350c949a0
                              useCustomRequestBody: false
                        response:
                          - componentType: Notifications
                            error: '-'
                            id: f5ee9c26-8420-4f92-9463-1983d1268281
                            key: B2C Customers
                            method: GET
                            payload:
                              description: ''
                              id: 2c92c8fb7ddc795b017dde4350c949a0
                              isDefault: false
                              locale: default
                              name: B2C Customers
                            result: DONE
                            segregationKey: Communication profile
                            templateId: null
                            url: >-
                              settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0
                        segregationKeys:
                          - Communication profile
                          - Email Templates
                    productCatalog:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: productCatalog
                            error: '-'
                            id: 456335f2-711d-4e73-b8ec-3309e78b403a
                            key: zzzzzzzzzz
                            method: GET
                            payload: {}
                            result: DONE
                            segregationKey: Available productCatalog
                            templateId: null
                            url: /zzzzzzzzzz
                        segregationKeys:
                          - Available productCatalog
                    settings:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: Settings
                            error: >
                              {"success":false,"reasons":[{"message":"Failed to
                              get user info","code":"90000011"}]}
                            id: bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6
                            key: AccountingPeriods
                            method: GET
                            payload: {}
                            result: FAILED
                            segregationKey: Finance
                            templateId: null
                            url: v1/accounting-periods
                          - componentType: Settings
                            error: null
                            id: 6a27d0d3-3c4c-408f-b160-04510014ebf1
                            key: AccountingRules
                            method: GET
                            payload:
                              allowBlankAccountingCodes: true
                              allowCreationInClosedPeriod: true
                              allowRevenueScheduleNegativeAmounts: false
                              allowUsageInClosedPeriod: false
                            result: DONE
                            segregationKey: Finance
                            templateId: null
                            url: /accounting-rules
                        segregationKeys:
                          - Finance
                          - Billing
                          - Administration
                          - ManageMultiEntity
                          - Payments
                          - Taxation
                          - BillingDocumentConfiguration
                          - ManageDataAccessControl
                    workflows:
                      - errors: []
                        originalPayload: {}
                        response:
                          - componentType: WorkFlows
                            error: '-'
                            id: df74980b-ff25-4684-a950-7e0c25810a72
                            key: >-
                              Resume Subscriptions for Accounts with Zero
                              Balance Limit 1_0.0.13
                            method: GET
                            payload:
                              active_version:
                                calloutTrigger: true
                                createdAt: '2022-08-21T10:51:22.613-07:00'
                                created_by:
                                  created_at: '2021-11-22T19:06:54.279-08:00'
                                  updated_at: '2022-09-06T05:16:20.455-07:00'
                                  work_email: rkumar@zuora.com
                                definitionId: 1
                                description: ''
                                id: 2483
                                interval: null
                                name: >-
                                  Resume Subscriptions for Accounts with Zero
                                  Balance Limit 1
                                ondemandTrigger: true
                                priority: Medium
                                scheduledTrigger: false
                                status: Active
                                timezone: null
                                type: Workflow::Setup
                                updatedAt: '2022-08-21T10:51:22.613-07:00'
                                updated_by:
                                  created_at: N/A
                                  updated_at: N/A
                                  work_email: N/A
                                version: 0.0.13
                              calloutTrigger: true
                              createdAt: '2022-08-21T10:51:22.613-07:00'
                              description: ''
                              id: 1
                              interval: null
                              latest_inactive_versions:
                                - calloutTrigger: true
                                  createdAt: '2022-05-10T05:21:37.192-07:00'
                                  created_by:
                                    created_at: '2021-11-22T19:06:54.279-08:00'
                                    updated_at: '2022-09-06T05:16:20.455-07:00'
                                    work_email: rkumar@zuora.com
                                  definitionId: 1
                                  description: ''
                                  id: 689
                                  interval: null
                                  name: >-
                                    Resume Subscriptions for Accounts with Zero
                                    Balance Limit 1
                                  ondemandTrigger: true
                                  priority: Medium
                                  scheduledTrigger: false
                                  status: Inactive
                                  timezone: null
                                  type: Workflow::Setup
                                  updatedAt: '2022-05-10T05:21:37.192-07:00'
                                  updated_by:
                                    created_at: N/A
                                    updated_at: N/A
                                    work_email: N/A
                                  version: 0.0.10
                              name: >-
                                Resume Subscriptions for Accounts with Zero
                                Balance Limit 1
                              ondemandTrigger: true
                              priority: Medium
                              scheduledTrigger: false
                              status: Active
                              timezone: null
                              updatedAt: '2022-08-21T10:51:22.613-07:00'
                            result: DONE
                            segregationKey: >-
                              Resume Subscriptions for Accounts with Zero
                              Balance Limit 1
                            templateId: null
                            url: '1'
                        segregationKeys:
                          - Payment to Provision
                          - >-
                            Negative Invoices to Positive Account Credit Balance
                            Limit 1
                          - Automated Dunning | 2nd Attempt Failed
                          - Subscription Price Uplift -- JSON Transform
              schema:
                $ref: '#/components/schemas/SettingSourceComponentResponse'
          description: Successfully retrieved the template metadata.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Id is invalid
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: List all details of source components
      tags:
        - Configuration Templates
  /deployment-manager/deployment_templates:
    get:
      description: |
        Retrieves all the templates and their details which are created already.
      operationId: GET_Templates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    templates:
                      - active: true
                        content: null
                        createdBy: Daco user
                        createdOn: '2022-08-22T14:06:53.659Z'
                        description: ''
                        entityName: Global
                        environment: US-API-Sandbox-Staging
                        errors: '-'
                        id: e8ed70e9-5d31-41c3-8b20-981a5b3e9972
                        name: Testing Tax
                        status: DONE
                        tenantName: Data Connect
                      - active: true
                        content: null
                        createdBy: Daco user
                        createdOn: '2022-08-22T14:06:53.659Z'
                        description: ''
                        entityName: Global
                        environment: US-API-Sandbox-Staging
                        errors: '-'
                        id: 24ba307c-cd94-4b9f-b849-c2d08f028c53
                        name: tempExample3975161566467657
                        status: DONE
                        tenantName: Data Connect
              schema:
                $ref: '#/components/schemas/TemplateResponse'
          description: >-
            Successfully received all templates throught Template Response
            Object.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: List all templates
      tags:
        - Configuration Templates
    post:
      description: >
        Creates templates based on user preference.

        There are 2 ways to select components.
          - Selecting the whole component.
          - Advanced Options -> which helps user to select specific components to be migrated.

        It takes the enviroment details from the logged in user automatically,
        while creating the template.
      operationId: POST_DeploymentTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTemplateRequestContent'
        description: >-
          CreateTemplateRequestContent JSON object which contains the details to
          create a template.
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    active: true
                    content: null
                    createdBy: Daco user
                    createdOn: '2022-09-14T16:06:43.155Z'
                    description: ''
                    entityName: Global
                    environment: US-API-Sandbox-Staging
                    errors: '-'
                    id: 210656b3-0d89-4bc6-92b9-634653e729af
                    name: Test_Template
                    status: Inprogress
                    tenantName: Data Connect
              schema:
                $ref: '#/components/schemas/TemplateDetailResponse'
          description: Successfully created the template.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '201':
          description: >
            created.

            The request has been fulfilled and resulted in a new resource being
            created. The newly created resource can be referenced by the URL(s)
            returned in the entity of the response, with the most specific URL
            for the resource given by a Location header field.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: Create a deployment template
      tags:
        - Configuration Templates
  /deployment-manager/deployment_templates/{id}:
    delete:
      description: |
        Deletes a specific template by passing the ID.
      operationId: DELETE_DeploymentTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The ID of the template that needs to be deleted.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully deleted the template.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '204':
          description: No Content
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Id is invalid
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: Delete a template
      tags:
        - Configuration Templates
    get:
      description: >
        Returns the detailed information of a specific template by passing its
        template ID.
      operationId: GET_DeploymentTemplateDetail
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The ID of the template that needs to be retrieved.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    active: true
                    content:
                      customFields: []
                      customObjects: []
                      dataAccessControl: []
                      notifications: []
                      productCatalog: []
                      settings:
                        - errors: []
                          originalPayload: null
                          response:
                            - componentType: Settings
                              error: null
                              id: 301e73b7-420c-4770-9c37-3d966c1e2690
                              key: AccountingRules
                              method: GET
                              payload:
                                allowBlankAccountingCodes: true
                                allowCreationInClosedPeriod: true
                                allowRevenueScheduleNegativeAmounts: false
                                allowUsageInClosedPeriod: false
                              result: DONE
                              segregationKey: Finance
                              templateId: e8ed70e9-5d31-41c3-8b20-981a5b3e9972
                              url: /accounting-rules
                          segregationKeys:
                            - Administration
                            - ManageDataAccessControl
                            - Finance
                            - Billing
                            - ManageMultiEntity
                            - Payments
                            - Taxation
                            - BillingDocumentConfiguration
                      workflows: []
                    createdBy: Daco user
                    createdOn: '2022-08-22T14:06:53.659Z'
                    description: ''
                    entityName: Global
                    environment: US-API-Sandbox-Staging
                    errors: '-'
                    id: e8ed70e9-5d31-41c3-8b20-981a5b3e9972
                    name: Testing Tax
                    status: DONE
                    tenantName: Data Connect
              schema:
                $ref: '#/components/schemas/TemplateDetailResponse'
          description: Successfully received the template.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Bad request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Forbidden
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              description: >
                A custom identifier for tracing the API call. Zuora would return
                the same tracing identifier if you specified it in the request
                headers. Otherwise, Zuora does not set this header.
              schema:
                maxLength: 64
                type: string
      summary: List all details of a template
      tags:
        - Configuration Templates
  /deployment-manager/deployment_templates/sync:
    post:
      tags:
        - Configuration Templates
      summary: Sync a deployment template with latest changes
      description: >
        Synchronizes an existing deployment template with the latest changes in
        the source tenant.
      operationId: syncDeploymentTemplate
      parameters:
        - name: Content-Type
          in: header
          required: true
          description: Specify the content type of the request. Use multipart/form-data.
          schema:
            type: string
            example: multipart/form-data
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SyncDeploymentTemplateRequest'
      responses:
        '200':
          description: Successfully synced the template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateDetailResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigTemplateErrorResponse'
  /deployment-manager/deployments/tenants:
    post:
      tags:
        - Metadata
      summary: Compare and deploy a source tenant to a target tenant
      description: |
        Compare and deploy a source tenant to a target tenant.
      operationId: CompareDeployTenant
      parameters:
        - name: Zuora-Entity-Ids
          in: header
          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. 
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - customFields
                - description
                - name
                - notifications
                - productCatalog
                - reporting
                - sendEmail
                - settings
                - sourceTenantId
                - userRoles
                - workflows
              type: object
              properties:
                name:
                  type: string
                  description: Deployment's name.
                description:
                  type: string
                  description: Deployment's description.
                sendEmail:
                  type: boolean
                  description: Specifies if an email should be sent.
                emails:
                  type: string
                  description: >-
                    If sendEmail parameter is set to true, comma separated
                    values of emails can be specified. Example 
                    email1@test.com,email2@test.com.
                comments:
                  type: string
                  description: Content of the email to be sent.
                settings:
                  type: boolean
                  description: >-
                    Specified if settings module should be considered in the
                    deployment process.
                notifications:
                  type: boolean
                  description: >-
                    Specified if notifications module should be considered in
                    the deployment process.
                workflows:
                  type: boolean
                  description: >-
                    Specified if workflows module should be considered in the
                    deployment process.
                customFields:
                  type: boolean
                  description: >-
                    Specified if customFields module should be considered in the
                    deployment process.
                customObjects:
                  type: boolean
                  description: >-
                    Specified if customObjects module should be considered in
                    the deployment process.
                productCatalog:
                  type: boolean
                  description: >-
                    Specified if productCatalog module should be considered in
                    the deployment process.
                taxation:
                  type: boolean
                  description: >-
                    Specified if taxation module should be considered in the
                    deployment process.
                userRoles:
                  type: boolean
                  description: >-
                    Specified if userRoles module should be considered in the
                    deployment process.
                reporting:
                  type: boolean
                  description: >-
                    Specified if reporting module should be considered in the
                    deployment process.
                sourceTenantId:
                  type: string
                  description: Id of the source tenant.
        required: true
      responses:
        '200':
          description: OK
          headers:
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentManagerResponse'
              example:
                id: 8039d54b-da6f-4d80-88d5-06220c42861f
                status: DEPLOYING
        '400':
          description: Validation of dependent module error.
          content:
            application/json:
              example:
                errorCode: BAD_REQUEST
                errorMessage: Dependent module customFields is not included
  /deployment-manager/deployments/templates:
    post:
      tags:
        - Metadata
      summary: Compare and deploy a template to a tenant
      description: |
        Compare and deploy a template to a tenant.
      operationId: CompareDeployTemplate
      parameters:
        - name: Zuora-Entity-Ids
          in: header
          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. 
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - description
                - name
                - sendEmail
                - template
              type: object
              properties:
                name:
                  type: string
                  description: Deployment's name
                description:
                  type: string
                  description: Deployment's description.
                sendEmail:
                  type: boolean
                  description: Specifies if an email should be sent.
                emails:
                  type: string
                  description: >-
                    If sendEmail parameter is set to true, comma separated
                    values of emails can be specified. Example 
                    email1@test.com,email2@test.com.
                comments:
                  type: string
                  description: Content of the email to be sent.
                template:
                  type: string
                  description: Template file.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          headers:
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentManagerResponse'
              example:
                id: 8039d54b-da6f-4d80-88d5-06220c42861f
                status: DEPLOYING
  /deployment-manager/deployments/{migrationId}/revert:
    post:
      tags:
        - Metadata
      summary: Revert a deployment
      description: |
        Revert a deployment.
      operationId: RevertDeployment
      parameters:
        - name: Zuora-Entity-Ids
          in: header
          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. 
          schema:
            type: string
        - name: migrationId
          in: path
          description: |
            The unique ID of a migration.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            RateLimit-Remaining:
              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.
              schema:
                type: number
            RateLimit-Reset:
              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.
              schema:
                type: number
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              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.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID of the Deployment Manager migration process.
                  name:
                    type: string
                    description: Name of the Deployment Manager migration process.
                  description:
                    type: string
                    description: Description of the Deployment Manager migration process.
                  sourceTenantName:
                    type: string
                    description: Name of the source Tenant.
                  sourceTenantDescription:
                    type: string
                    description: Description of the source Tenant.
                  status:
                    type: string
                    description: Status of the Deployment Manager migration process.
                    enum:
                      - DEPLOYING
                      - REVERTING
                      - PARTIALLY-REVERTED
                      - FAILED
                      - ROLLBACK-FAILED
                      - REVERTED
                      - COMPARING
                      - SUBMITTED
                      - SKIPPED
                      - IDENTICAL
                      - COMPARE-DONE
                      - COMPARE-FAILED
                      - CANCELLED
                  startTime:
                    type: string
                    description: >-
                      start timestamp of the Deployment Manager migration
                      process.
                  endTime:
                    type: string
                    description: end timestamp of the Deployment Manager migration process.
                  migratedBy:
                    type: string
                    description: >-
                      User who initiated the Deployment Manager migration
                      process.
                  type:
                    type: string
                    description: Type of the Deployment Manager migration process.
                  environment:
                    type: string
                    description: Environment of the Deployment Manager migration process.
                  emailIds:
                    type: string
                    description: >-
                      emailIds notified of the Deployment Manager migration
                      process.
                  productCatalog:
                    type: boolean
                    description: >-
                      Boolean flag specifies if the migration process includes
                      product catalog module.
                  errors:
                    type: string
                    description: Errors of the Deployment Manager migration process.
              example:
                id: 2122b60e-49ca-4b16-ae1c-f7f315ff0010
                name: Migrate - Custom objects
                description: Migrate - Custom objects
                sourceTenantName: Test Sandbox
                sourceTenantDescription: Sample Source Tenant
                status: REVERTING
                startTime: '2023-08-30 04:35:19.080000+00:00'
                endTime: '2023-08-29 15:49:41.986000+00:00'
                migratedBy: Admin
                type: Tenant
                environment: US-API-Sandbox
                emailIds: admin@zuora.com
                productCatalog: false
                errors: '-'
  /deployment-manager/deployments/{migrationId}:
    get:
      tags:
        - Metadata
      summary: Retrieve a deployment log
      description: |
        Retrieve a deployment log.
      operationId: FetchDeploymentLogs
      parameters:
        - name: Zuora-Entity-Ids
          in: header
          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. 
          schema:
            type: string
        - name: migrationId
          in: path
          description: |
            The unique ID of a migration.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID of the migration process.
                  name:
                    type: string
                    description: Name of the migration.
                  description:
                    type: string
                    description: Description of the migration.
                  status:
                    type: string
                    description: Migration status.
                  targetTenant:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Target tenant id.
                      name:
                        type: string
                        description: Target tenant name.
                      environment:
                        type: string
                        description: Target tenant description.
                  deploymentDate:
                    type: string
                    description: Deployment timestamp.
                  runBy:
                    type: string
                    description: Name of the user who executed the migration.
                  succeeded:
                    type: array
                    items:
                      type: object
                      properties:
                        component:
                          type: string
                          description: Component name.
                        subComponent:
                          type: string
                          description: Subcomponent name.
                        key:
                          type: string
                          description: Key to identify a particular migration data.
                  failed:
                    type: array
                    items:
                      type: object
                      properties:
                        component:
                          type: string
                          description: Component name.
                        subComponent:
                          type: string
                          description: Subcomponent name.
                        key:
                          type: string
                          description: Key to identify a particular migration data.
                        errorInfo:
                          type: string
                          description: Error details of the migration.
                  skipped:
                    type: array
                    items:
                      type: object
                      properties:
                        component:
                          type: string
                          description: Component name.
                        subComponent:
                          type: string
                          description: Subcomponent name.
                        key:
                          type: string
                          description: Key to identify a particular migration data.
                        reason:
                          type: string
                          description: >-
                            The rationale behind the non-migration of specific
                            data.
              example:
                id: 8039d54b-da6f-4d80-88d5-06220c42861f
                name: Deploy - Product catalog
                description: Deploy - Product catalog
                status: PARTIALLY-DONE
                targetTenant:
                  id: '9958'
                  name: Test API sandbox
                  environment: US-API-Sandbox-Staging
                deploymentDate: '2023-08-28 11:34:18.682000+00:00'
                runBy: Admin
                succeeded:
                  - component: Settings
                    subComponent: Billing
                    key: Currency
                failed:
                  - component: Settings
                    subComponent: Finance
                    key: AllRevenueRecognitionModels
                    errorInfo: >-
                      Error while updating the payload with path :
                      /revenue-recognition-models --> You do not have permission
                      to perform this operation.
                  - component: Settings
                    subComponent: Finance
                    key: AccountingRules
                    errorInfo: >-
                      Error while updating the payload with path :
                      /accounting-rules --> You do not have Currency Conversion
                      permission. You can request permission from your
                      administrator.
                  - component: Settings
                    subComponent: Billing
                    key: SubscriptionSettings
                    errorInfo: |-
                      {
                        "errorCode" : "REMOTE_HTTP_CLIENT_ERROR",
                        "remoteHttpStatus" : 403,
                        "messages" : [ "{\"error\":\"403 Forbidden\",\"processId\":\"A5EF7EA92B3B95B0\",\"message\":\"security.error.noPermission\"}" ]
                      }
                skipped:
                  - component: Settings
                    subComponent: Billing
                    key: NumberAndSku
                    reason: RETRY-ABLE ERROR
                  - component: Settings
                    subComponent: Administration
                    key: AuditTrailSettings
                    reason: RETRY-ABLE ERROR
  /deployment-manager/deployments/tenant/product_catalog:
    post:
      tags:
        - Metadata
      summary: Compare and deploy the product catalog of a tenant to a target tenant
      description: |
        Compare and deploy the product catalog of a tenant to a target tenant.
      operationId: CompareDeployTenantProductCatalog
      parameters:
        - name: Zuora-Entity-Ids
          in: header
          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. 
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - activeProducts
                - activeRatePlans
                - compareField
                - description
                - inActiveProducts
                - inActiveRatePlans
                - name
                - sendEmail
                - sourceTenantId
              type: object
              properties:
                name:
                  type: string
                  description: Deployment's name.
                  example: Tenant01PC
                description:
                  type: string
                  description: Deployment's description.
                  example: Product Catalog tenant - 01
                sendEmail:
                  type: boolean
                  description: Specifies if an email should be sent.
                  example: true
                emails:
                  type: string
                  description: >-
                    If sendEmail parameter is set to true, comma separated
                    values of emails can be specified. Example 
                    email1@test.com,email2@test.com.
                  example: zuoraUser@zuora.com
                comments:
                  type: string
                  description: Content of the email to be sent.
                  example: Product Catalog tenant - 47
                inActiveProducts:
                  type: boolean
                  description: Specifies if inactive products needs to be migrated.
                  example: false
                activeProducts:
                  type: boolean
                  description: Specifies if active products needs to be migrated.
                  example: true
                activeRatePlans:
                  type: boolean
                  description: Specifies if active rate plans needs to be migrated.
                  example: true
                inActiveRatePlans:
                  type: boolean
                  description: >-
                    Specifies if inactive active rate plans needs to be
                    migrated.
                  example: true
                compareField:
                  type: string
                  description: Specifies the compare field to be using during migration.
                  enum:
                    - name
                    - sku
                  example: name
                sourceTenantId:
                  type: string
                  description: Specifies the source tenant id.
                  example: 83e7e56d-0e02-4b4d-91f6-cc77f322c40b
        required: true
      responses:
        '200':
          description: OK
          headers:
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentManagerResponse'
              example:
                id: 8039d54b-da6f-4d80-88d5-06220c42861f
                status: DEPLOYING
        '400':
          description: Validation of dependent module error
          content:
            application/json:
              example:
                errorCode: BAD_REQUEST
                errorMessage: Dependent module customFields is not included
  /deployment-manager/deployments/template/product_catalog:
    post:
      tags:
        - Metadata
      summary: Compare and deploy a template for product catalog to a tenant
      description: |
        Compare and deploy a template for product catalog to a tenant.
      operationId: CompareDeployTemplateProductCatalog
      parameters:
        - name: Zuora-Entity-Ids
          in: header
          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. 
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - activeProducts
                - activeRatePlans
                - compareField
                - description
                - inActiveProducts
                - inActiveRatePlans
                - name
                - sendEmail
                - template
              type: object
              properties:
                name:
                  type: string
                  description: Deployment's name.
                  example: Deploy PC
                description:
                  type: string
                  description: Deployment's description.
                  example: Import Product Catalog - template
                sendEmail:
                  type: boolean
                  description: Specifies if an email should be sent.
                  example: true
                emails:
                  type: string
                  description: >-
                    If sendEmail parameter is set to true, comma separated
                    values of emails can be specified.
                  example: zuoraUser1@zuora.com,zuoraUser2@zuora.com
                comments:
                  type: string
                  description: Content of the email to be sent.
                  example: Import Product Catalog - template
                template:
                  type: string
                  description: Template file.
                  format: binary
                  example: '@/Users/praghav/Downloads/products.json'
                inActiveProducts:
                  type: boolean
                  description: Specifies if inactive products needs to be migrated.
                  example: false
                activeProducts:
                  type: boolean
                  description: Specifies if active products needs to be migrated.
                  example: true
                activeRatePlans:
                  type: boolean
                  description: Specifies if active rate plans needs to be migrated.
                  example: true
                inActiveRatePlans:
                  type: boolean
                  description: Specifies if inactive rate plans needs to be migrated.
                  example: true
                compareField:
                  type: string
                  description: Specifies the compare field to be using during migration.
                  enum:
                    - name
                    - sku
                  example: name
        required: true
      responses:
        '200':
          description: OK
          headers:
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.

                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              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.
              schema:
                maxLength: 64
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentManagerResponse'
              example:
                id: 8039d54b-da6f-4d80-88d5-06220c42861f
                status: DEPLOYING
  /bulk-data/bulk-jobs:
    post:
      description: >
        Creates a new bulk job. The job type can be one of Import, Delete,
        Update, or Cancel.

        The response includes the job ID and information needed to upload your
        data file to S3.


        ### Next Step: Upload the File to S3


        After creating a bulk job, you must upload the data file to Amazon S3
        using the information

        returned in the `uploadFileInfo` object. This includes:
          - `uploadUrl`: The S3 endpoint to which the file must be uploaded.
          - `formFields`: Key-value pairs to include in a multipart/form-data POST request.
          - `jobId`: The ID of the job, used for later submission.

        You can use the following cURL command to upload the file:


        ```

        curl --request POST \
          --url '<uploadUrl>' \
          --header 'Content-Type: multipart/form-data' \
          --form 'key=<formFields.key>' \
          --form 'bucket=<formFields.bucket>' \
          --form 'x-amz-algorithm=<formFields["x-amz-algorithm"]>' \
          --form 'x-amz-credential=<formFields["x-amz-credential"]>' \
          --form 'x-amz-date=<formFields["x-amz-date"]>' \
          --form 'Policy=<formFields.Policy>' \
          --form 'x-amz-signature=<formFields["x-amz-signature"]>' \
          --form 'x-amz-security-token=<formFields["x-amz-security-token"]>' \
          --form 'file=@/path/to/your/file.csv'
        ```



        **Note**: Always use the exact form field keys returned in the
        `formFields` object of the API response.

        This is a presigned Amazon S3 POST operation and not a Zuora endpoint.


        After uploading the file, you must call the "Submit a bulk job for
        processing" operation endpoint

        to start processing the job.
      operationId: createBulkJob
      summary: Create a bulk job
      tags:
        - Bulk Data
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkJobRequest'
      responses:
        '200':
          description: Job creation successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateResponse'
          headers:
            Content-Encoding:
              description: >-
                This header is returned if you specify the `Accept-Encoding`
                request header and the response contains over 1000 bytes of
                data.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion.
              schema:
                type: number
            Zuora-Request-Id:
              description: The Zuora internal identifier of the API call.
              schema:
                type: string
                minLength: 36
                maxLength: 36
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /bulk-data/bulk-jobs/{id}/submissions:
    post:
      operationId: submitBulkJob
      summary: Submit a bulk job
      description: >
        Submits a previously created bulk job for processing.


        This endpoint must be called **after** the file has been successfully
        uploaded to the S3 URL using the `uploadFileInfo` details from the
        create job response.


        If the job has not been uploaded properly before calling this endpoint,
        submission will fail.
      tags:
        - Bulk Data
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Bulk Job ID.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Job successfully submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitBulkJobResponse'
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the Accept-Encoding: gzip
                request header and the response contains over 1000 bytes of
                data.


                Note that only the following MIME types support gzipped
                responses:
                  - application/json
                  - application/xml
                  - text/html
                  - text/csv
                  - text/plain
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                type: string
                maxLength: 36
                minLength: 36
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /bulk-data/bulk-jobs/{id}/summary:
    get:
      description: |
        Get the summary of a specific job by its ID.
        This operation returns a summary of the specified bulk job.
      operationId: getBulkJobSummary
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: The unique identifier of the job whose summary is being queried.
          in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
            maxLength: 64
            minLength: 64
      responses:
        '200':
          description: Job summary retrieved successfully
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 3a3e85c4-96e7-486b-ae02-827120104301
                    name: Sample Bulk Job
                    description: Job processing sample data
                    createdAt: 1614081280
                    createdBy: admin
                    status: In Progress
                    rowCount: 1000
                    rowsSucceeded: 800
                    rowsFailed: 200
                    lastUpdatedAt: 1614082580
                    failureReason: Processing error
                    objectType: account
                    jobType: Import
                    isCustomObject: false
                    customObjectNamespace: default
                    dataSourceType: UserUpload
                    systemType: BILLING
                    fileType: csv
              schema:
                $ref: '#/components/schemas/QueryJobSummaryResponse'
        '404':
          description: Job not found
        '500':
          description: Internal server error
      summary: Retrieve the summary of a bulk job
      tags:
        - Bulk Data
  /bulk-data/bulk-jobs/{id}/cancellations:
    post:
      description: >
        Cancels an existing bulk job.



        Once a job is cancelled, no further processing can be done, and its
        status will be marked as `Cancelled`.



        **Note**: Cancellation of a job is only allowed before it reaches the
        `In Progress` status. Once a job is in progress, it cannot be cancelled
        but only be aborted.
      operationId: cancelBulkJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Internal identifier of the job to cancel.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            maxLength: 64
            minLength: 64
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 3a3e85c4-96e7-486b-ae02-827120104301
                    status: Cancelled
              schema:
                $ref: '#/components/schemas/IdStatusResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >-
                This header is returned if you specify the Accept-Encoding: gzip
                request header and the response contains over 1000 bytes of
                data.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Cancel a bulk job
      tags:
        - Bulk Data
  /bulk-data/bulk-jobs/{id}/aborts:
    post:
      description: >
        Aborts an existing job by sending a POST request to this URI. The
        request URI identifies the job to abort.

        When a job is aborted, no more records are processed.
      operationId: deleteAbortJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Internal identifier of the job to abort.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            maxLength: 64
            minLength: 64
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    id: 3a3e85c4-96e7-486b-ae02-827120104301
                    status: Aborted
              schema:
                $ref: '#/components/schemas/IdStatusResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the Accept-Encoding: gzip
                request header and the response contains over 1000 bytes of
                data.


                Note that only the following MIME types support gzipped
                responses:
                  - application/json
                  - application/xml
                  - text/html
                  - text/csv
                  - text/plain
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Abort a bulk job
      tags:
        - Bulk Data
  /bulk-data/bulk-jobs/{id}/downloads:
    get:
      description: >
        Retrieves the download links for the files associated with a completed
        job.

        These files include success rows, error rows, and logs.
      operationId: getDownloadLinksForJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >-
            The unique identifier of the job whose download links are being
            queried.
          in: path
          name: id
          required: true
          schema:
            type: string
            format: uuid
            maxLength: 64
            minLength: 64
      responses:
        '200':
          description: Get download links for a bulk job
          content:
            application/json:
              examples:
                response:
                  value:
                    jobId: 3a3e85c4-96e7-486b-ae02-827120104301
                    status: Completed
                    sourceFile: https://example.com/source-file
                    errorRowsFile: https://example.com/error-rows-file
                    successRowsFile: https://example.com/success-rows-file
                    delimiter: ','
              schema:
                $ref: '#/components/schemas/DownloadsResponse'
        '404':
          description: Job not found or not completed
        '500':
          description: Internal server error
      summary: List download links for a bulk job
      tags:
        - Bulk Data
  /bulk-data/bulk-jobs/summaries:
    get:
      description: >
        Lists summaries for bulk jobs. You can filter the results using query
        parameters.
      operationId: getBulkJobSummaries
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - name: limit
          in: query
          description: Maximum number of job summaries to retrieve.
          required: false
          schema:
            type: integer
            format: int32
        - name: cursor
          in: query
          description: Cursor for pagination to get the next page of results.
          required: false
          schema:
            type: string
        - name: status
          in: query
          description: Filter job summaries by job status.
          required: false
          schema:
            type: string
            enum:
              - Created
              - Submitted
              - In Progress
              - Aborting
              - Completed
              - Failed
              - Aborted
              - Cancelled
              - Downloading
      responses:
        '200':
          description: Job summaries retrieved successfully
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      - id: 3a3e85c4-96e7-486b-ae02-827120104301
                        name: Bulk Job 1
                        status: Completed
                        rowCount: 500
                        rowsSucceeded: 480
                        rowsFailed: 20
                        createdAt: 1618327278
                        lastUpdatedAt: 1618327279
                    nextPageCursor: abc123
              schema:
                $ref: '#/components/schemas/GetSummariesResponse'
        '404':
          description: No job summaries found
        '500':
          description: Internal server error
      summary: List job summaries for bulk jobs
      tags:
        - Bulk Data
  /bulk-data/bulk-jobs/{id}/mappings:
    get:
      description: >
        Retrieves the mappings for an existing bulk job. The mappings define how
        columns in the source file correspond to fields in the object type
        template.
      operationId: getMappingsForJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Internal identifier of the job whose mappings are to be retrieved.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            maxLength: 64
            minLength: 64
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    mappings:
                      - field: name
                        column: column1
                      - field: description
                        column: column2
              schema:
                type: object
                properties:
                  mappings:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                        column:
                          type: string
          description: OK
          headers:
            Content-Encoding:
              description: >-
                This header is returned if you specify the Accept-Encoding: gzip
                request header and the response contains over 1000 bytes of
                data.
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion.
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion.
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion.
              schema:
                type: number
            Zuora-Request-Id:
              description: >-
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List mappings for a bulk job
      tags:
        - Bulk Data
  /v1/multi-organizations/data-labeling-job:
    post:
      description: |
        Submits a data labeling job.
      operationId: POST_DataLabelingJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitDataLabelingJobRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    jobId: ff80808186beca0a0186bedbf7d3006f
                    jobStatus: Accepted
                    success: true
              schema:
                $ref: '#/components/schemas/SubmitDataLabelingJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '400':
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 4C0112A0983D040C
                    reasons:
                      - code: 59620220
                        message: The queryType is invalid
                    requestId: 46a352ed-57a2-4a9f-b7cb-a8c864d839f3
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Bad Request
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Submit a data labeling job
      tags:
        - Data Labeling
  /v1/multi-organizations/data-labeling-job/{job-id}:
    get:
      description: >
        Retrieves a data labeling job. You can use this operation to track the
        status of the data labeling job.
      operationId: GET_DataLabelingJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            Identifier of the data labeling job.
          in: path
          name: job-id
          required: true
          schema:
            format: uuid
            maxLength: 32
            minLength: 32
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    jobId: ff80808186b966950186b97922e200ab
                    jobStatus: Completed
                    objectType: Account
                    progress:
                      failed: 1
                      labeled: 9
                      timeout: 1
                    success: true
                    totalObject: 11
              schema:
                $ref: '#/components/schemas/GetDataLabelingJobResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 4C0112A0983D039B
                    reasons:
                      - code: '50000020'
                        message: The job does not exist
                    requestId: 46a352ed-57a2-4a9f-b7cb-a8c864d839f3
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Not Found
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Retrieve a data labeling job
      tags:
        - Data Labeling
  /v1/uno-regenerate/booking-transaction:
    post:
      description: >
        Use this operation to generate booking transactions. This call is useful
        in the following two use cases:

        * During customer onboarding, there is a common scenario when customers
        perform data backfill or data fixes. To synchronize these changes from
        Billing to Revenue, use this API operation to regenerate booking
        transaction objects.

        * Customers choose to experiment with their use cases in the Sandbox
        environment before implementing them in the Production environment.
        During this experimentation phase, customers not only interact with data
        but also use this API operation to regenerate booking transaction
        objects.
      operationId: POST_RegenerateBookingTransaction
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            If `onlyReSend` is true, existing booking transactions in the
            database will not be overridden and sent into Revenue for
            re-collecting, i.e. regenerate_flag is Y.


            If `onlyReSend` is false, existing booking transactions in the
            database will be overridden and sent into Revenue, no matter what is
            the value of `reMigrate`.


            **Note:** If `onlyReSend` is true, the `reMigrate` can't be true.
          in: query
          name: onlyReSend
          required: false
          schema:
            type: boolean
        - description: >
            If `reMigrate` is true, existing booking transactions in the
            database will be overridden and sent into Revenue for re-collecting,
            i.e. regenerate_flag is Y.


            If `reMigrate` is false, existing booking transactions in the
            database will be overridden and sent into Revenue with
            regenerate_flag as N.


            **Note:** If `onlyReSend` is true, the `reMigrate` can't be true.
          in: query
          name: reMigrate
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateBookingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    idList:
                      - 2c9890508ad035db018ad0d8d1685fef
                      - 2c9890508ad035db018ad0d8d4ec6013
                    success: true
              schema:
                $ref: '#/components/schemas/RegenerateTransactionObjectResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Regenerate booking transactions
      tags:
        - Regenerate
  /v1/uno-regenerate/billing-transaction:
    post:
      description: >
        Use this operation to generate billing transactions. This call is useful
        in the following two use cases: 

        * During customer onboarding, there is a common scenario when customers
        perform data backfill or data fixes. To synchronize these changes from
        Billing to Revenue, use this API operation to regenerate billing
        transaction objects.

        * Customers choose to experiment with their use cases in the Sandbox
        environment before implementing them in the Production environment.
        During this experimentation phase, customers not only interact with data
        but also use this API operation to regenerate transaction objects.
      operationId: POST_RegenerateBillingTransaction
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            If `onlyReSend` is true, existing booking transactions in the
            database will not be overridden and sent into Revenue for
            re-collecting, i.e. regenerate_flag is Y.


            If `onlyReSend` is false, Whether existing booking transactions in
            the database will be overridden and sent into Revenue for
            re-collecting depends on the value of `reMigrate`.


            **Note:** If `onlyReSend` is true, the `reMigrate` can't be true.
          in: query
          name: onlyReSend
          required: false
          schema:
            type: boolean
        - description: >
            If `reMigrate` is true, existing booking transactions in the
            database will be overridden and sent into Revenue for re-collecting,
            i.e. regenerate_flag is Y.


            If `reMigrate` is false, existing booking transactions in the
            database will not be overridden and sent into Revenue with
            regenerate_flag as N.


            **Note:** If `onlyReSend` is true, the `reMigrate` can't be true.
          in: query
          name: reMigrate
          required: false
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegenerateBillingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    idList:
                      - 2c9890508ad035db018ad0d8d1685fef
                      - 2c9890508ad035db018ad0d8d4ec6013
                    success: true
              schema:
                $ref: '#/components/schemas/RegenerateTransactionObjectResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Regenerate billing transactions
      tags:
        - Regenerate
  /v1/uno-regenerate/rev-rec-events:
    post:
      description: >
        Use this operation to generate Delivery Schedule based revenue
        recognition events transactions.
      operationId: POST_CreateRevRecEvents
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The subcription number.
          in: query
          name: subscriptionNumber
          schema:
            type: string
        - description: The generation mode.
          in: query
          name: mode
          schema:
            default: Incremental
            enum:
              - Incremental
              - Full
            type: string
        - description: >-
            Indicates whether the data regenerated is for Zuora Revenue to
            recollect.
          in: query
          name: forRevenueRecollect
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/RegenerateRevRecEventsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Regenerate revenue recognition events transactions for Delivery Schedule
      tags:
        - Regenerate
  /v1/uno-regenerate/rev-rec-events/daily-consumption:
    post:
      description: >
        Use this operation to generate Daily Consumption based revenue
        recognition events transactions when the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
        target="_blank">Prepaid with Drawdown</a> feature is enabled.
      operationId: POST_GenerateRevRecEventsForDailyConsumption
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >-
            Indicates whether the data regenerated is for Zuora Revenue to
            recollect.
          in: query
          name: forRevenueRecollect
          schema:
            type: boolean
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DailyConsumptionRevRecRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/RegenerateRevRecEventsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Regenerate revenue recognition events transactions for Daily Consumption
      tags:
        - Regenerate
  /v1/uno/data-backfill/bookingdate/jobs:
    post:
      description: >
        Creates a booking date backfill job to update the booking date with your
        charge's original created-on date.
      operationId: POST_CreateBookingDateBackfillJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    jobId: ff8080818bb300af018bb325fe0c58f3
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobId:
                        type: string
                        description: >
                          String of 32 characters that identifies the booking
                          date backfill job. 

                          The id is generated before the backfill job is
                          processed. 

                          You can use the id to get the booking date backfill
                          job result.
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a booking date backfill job
      tags:
        - Data Backfill
    get:
      description: |
        Use this operation to list all booking date backfill jobs.
      operationId: GET_ListBookingDateBackfillJobs
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    jobs:
                      - id: ff8080818c6748aa018c675a17d758e0
                        createdOn: 1702541006000
                        createdOnReadable: 2023-12-14T16:03:26+0800
                        updatedOn: 1702541007000
                        updatedOnReadable: 2023-12-14T16:03:27+0800
                        updatedByUsername: test1702540260413@test.com
                        status: COMPLETED
                        type: BookingDate
                        batchSentCount: 1
                        batchFinishedCount: 1
                        errorCount: 0
                        progress: 100.00%
                      - id: ff8080818c6748aa018c6778737f58e2
                        createdOn: 1702542996000
                        createdOnReadable: 2023-12-14T16:36:36+0800
                        updatedOn: 1702542997000
                        updatedOnReadable: 2023-12-14T16:36:37+0800
                        updatedByUsername: test1702540260413@test.com
                        status: COMPLETED
                        type: BookingDate
                        batchSentCount: 1
                        batchFinishedCount: 1
                        errorCount: 0
                        progress: 100.00%
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all booking date backfill jobs
      tags:
        - Data Backfill
  /v1/uno/data-backfill/bookingdate/jobs/{jobId}:
    get:
      description: |
        Use this operation to retrieve a specific booking date backfill job.
      operationId: GET_BookingDateBackfillJobById
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            ID of the job to retrieve
          in: path
          name: jobId
          required: true
          schema:
            type: string
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    job:
                      id: ff8080818c6748aa018c675a17d758e0
                      createdOn: 1702541006000
                      createdOnReadable: 2023-12-14T16:03:26+0800
                      updatedOn: 1702541007000
                      updatedOnReadable: 2023-12-14T16:03:27+0800
                      updatedByUsername: test1702540260413@test.com
                      status: COMPLETED
                      type: BookingDate
                      batchSentCount: 1
                      batchFinishedCount: 1
                      errorCount: 0
                      progress: 100.00%
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      job:
                        $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a booking date backfill job
      tags:
        - Data Backfill
    put:
      description: |
        Use this operation to stop a booking date backfill job.
      operationId: PUT_StopBookingDateBackfillJobById
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            ID of the job to stop
          in: path
          name: jobId
          required: true
          schema:
            type: string
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  description: |
                    `Stopping` is currently the only allowed value.
                  type: string
                  enum:
                    - Stopping
              required:
                - status
            example:
              status: Stopping
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Stop a booking date backfill job
      tags:
        - Data Backfill
  /v1/uno/data-backfill/jobs:
    post:
      description: >
        Use this operation to perform the following types of data backfill
        actions. Also, you need to upload a corresponding file to perform a data
        backfill action.

        * Update Product Rate Plan Charge

        * Update Rate Plan Charge

        * Update Invoice Item

        * Update Credit Memo Detail

        * Update Debit Memo Detail

        * Update Invoice Item Adjustment


        For more information, see <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Perform_data_backfill"
        target="_blank">Perform data backfill</a>.
      operationId: POST_CreateDataBackfillJob
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                type:
                  $ref: '#/components/schemas/DataBackfillJob'
                file:
                  description: >
                    A file containing the data about the fields that you want to
                    backfill. This file must be a `.csv` file or a zipped `.csv`
                    file. The maximum file size is 4 MB. The data in the file
                    must be formatted according to the data backfill action type
                    that you want to perform.


                    You can download a file template to view all fields
                    supported for your data backfill. For more information, see
                    <a
                    href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Perform_data_backfill#Perform_data_backfill"
                    target="_blank">Perform data backfill</a>.
                  type: string
                  format: binary
                checksum:
                  description: >-
                    An MD5 checksum that is used to validate the integrity of
                    the uploaded file.
                  type: string
                  minLength: 32
                  maxLength: 32
              required:
                - file
                - type
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    jobId: ff8080818bb300af018bb325fe0c58f3
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobId:
                        type: string
                        description: >
                          String of 32 characters that identifies the data
                          backfill job. The id is generated before the job is
                          processed. You can use the id to retrieve the data
                          backfill job result.
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create a data backfill job
      tags:
        - Data Backfill
      x-code-samples:
        - label: cURL
          lang: curl
          source: >-
            curl -X POST -H 'Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1' -F
            'file=@"ProductRatePlanChargeBackfillFile.csv"' -F
            'type="ProductRatePlanCharge"'
            'https://rest.zuora.com/v1/uno/data-backfill/jobs'
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
  /v1/uno/data-backfill/jobs/{jobId}:
    get:
      description: Returns a single Data Backfill job
      operationId: GET_DataBackfillJobById
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            ID of the job to retrieve
          in: path
          name: jobId
          required: true
          schema:
            type: string
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    job:
                      id: ff8080818bb300af018bb325fe0c58f3
                      importType: RatePlanCharge
                      uploadedFileId: ff8080818bb300af018bb325fe0c58f2
                      uploadedFileName: file.csv
                      uploadedFileUrl: >-
                        http://localhost:8080/apps/v1/files/ff8080818bb300af018bb325fe0c58f2
                      uploadedFileSize: 798Byte
                      uploadedBy: test1699515471903@test.com
                      uploadedOn: '1699517693000'
                      resultFileId: ff8080818bb300af018bb32605c358f6
                      resultFileName: file.csv_result.zip
                      resultFileUrl: >-
                        http://localhost:8080/apps/v1/files/ff8080818bb300af018bb32605c358f6
                      totalCount: 2
                      failedCount: 1
                      completedOn: '1699517695000'
                      status: Completed
                      failureMessage: ''
                      startedProcessingOn: '1699517693000'
                      outputSize: 492Byte
                      outputType: (url:.csv.zip)
                      inputFileSize: 798
                      outputFileSize: 492
                      processedCount: 2
                      successCount: 1
                      remainingTime: 1
                      remainingTimeText: ''
                      completedPercentage: 100
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      job:
                        $ref: '#/components/schemas/DataBackfillJob'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a data backfill job
      tags:
        - Data Backfill
    put:
      description: |
        Use this operation to stop a data backfill job.
      operationId: PUT_StopDataBackfillJobById
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            ID of the job to stop
          in: path
          name: jobId
          required: true
          schema:
            type: string
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            example:
              status: Stopping
            schema:
              type: object
              properties:
                status:
                  type: string
                  description: |
                    `Stopping` is currently the only allowed value.
                  enum:
                    - Stopping
              required:
                - status
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Stop a data backfill job
      tags:
        - Data Backfill
  /v1/uno/data-backfill/listjobs:
    get:
      operationId: GET_ListDataBackfillJobs
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    jobs:
                      - id: ff8080818bb300af018bb325fe0c58f3
                        type: RatePlanCharge
                        uploadedFileId: ff8080818bb300af018bb325fe0c58f2
                        uploadedFileName: file.csv
                        uploadedFileUrl: >-
                          http://localhost:8080/apps/v1/files/ff8080818bb300af018bb325fe0c58f2
                        uploadedFileSize: 798Byte
                        uploadedBy: test1699515471903@test.com
                        uploadedOn: '1699517693000'
                        resultFileId: ff8080818bb300af018bb32605c358f6
                        resultFileName: file.csv_result.zip
                        resultFileUrl: >-
                          http://localhost:8080/apps/v1/files/ff8080818bb300af018bb32605c358f6
                        totalCount: 2
                        failedCount: 1
                        completedOn: '1699517695000'
                        status: Completed
                        failureMessage: ''
                        startedProcessingOn: '1699517693000'
                        outputSize: 492Byte
                        outputType: (url:.csv.zip)
                        inputFileSize: 798
                        outputFileSize: 492
                        processedCount: 2
                        successCount: 1
                        remainingTime: 1
                        remainingTimeText: ''
                        completedPercentage: 100
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/DataBackfillJob'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all data backfill jobs
      tags:
        - Data Backfill
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
  /v1/uno/data-backfill/jobs/{type}/template:
    get:
      description: >
        Use this operation to download a data backfill template file of the
        specific type.
      operationId: GET_DataBackfillTemplate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            Type of the template file that you want to download for data
            backfill
          in: path
          name: type
          required: true
          schema:
            $ref: '#/components/schemas/DataBackfillJobType'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
              examples:
                success:
                  value: ''
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
          headers:
            Content-Disposition:
              description: >
                Indicating it should be downloaded, prefilled with the value of
                the filename parameters if present.
              schema:
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Download a data backfill template file
      tags:
        - Data Backfill
  /v1/uno/data-backfill/propagation/jobs:
    get:
      summary: List all auto backfill jobs
      tags:
        - Data Backfill
      description: |
        Use this operation to list all auto backfill jobs.
      operationId: GET_listAutoBackfillJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              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.
              schema:
                type: string
            RateLimit-Remaining:
              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.
              schema:
                type: number
            RateLimit-Reset:
              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.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    jobs:
                      - id: ff8080818c6748aa018c675a17d758e0
                        createdOn: 1702541006000
                        createdOnReadable: 2023-12-14T16:03:26+0800
                        updatedOn: 1702541007000
                        updatedOnReadable: 2023-12-14T16:03:27+0800
                        updatedByUsername: test1702540260413@test.com
                        status: COMPLETED
                        type: RatePlanCharge
                        batchSentCount: 1
                        batchFinishedCount: 1
                        errorCount: 0
                        progress: 100.00%
                      - id: ff8080818c6748aa018c6778737f58e2
                        createdOn: 1702542996000
                        createdOnReadable: 2023-12-14T16:36:36+0800
                        updatedOn: 1702542997000
                        updatedOnReadable: 2023-12-14T16:36:37+0800
                        updatedByUsername: test1702540260413@test.com
                        status: COMPLETED
                        type: OrderLineItem
                        batchSentCount: 1
                        batchFinishedCount: 1
                        errorCount: 0
                        progress: 100.00%
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobs:
                        type: array
                        items:
                          $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
    post:
      summary: Create an auto backfill job
      description: >
        Creates an autobackfill job to update the rate plan charge and order
        line item with product rate plan charge.
      tags:
        - Data Backfill
      operationId: POST_CreateAutoBackfillJob
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - type
              properties:
                type:
                  type: string
                  enum:
                    - RatePlanCharge
                    - OrderLineItem
                batchSize:
                  type: integer
                  format: int32
                  default: 1000
                  minimum: 1
                  maximum: 1000
                dryRun:
                  type: boolean
                  description: >
                    If `true`, the job is created in dry-run mode. In dry-run
                    mode, the data

                    is not updated. The default value is `false`.
              example:
                type: RatePlanCharge
                batchSize: 1000
                dryRun: false
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    jobId: ff8080818bb300af018bb325fe0c58f3
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      jobId:
                        type: string
                        description: >
                          String of 32 characters that identifies the auto
                          backfill job. 

                          The id is generated before the backfill job is
                          processed. 

                          You can use the id to get the auto backfill job
                          result.
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              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.
              schema:
                type: string
            RateLimit-Remaining:
              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.
              schema:
                type: number
            RateLimit-Reset:
              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.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
  /v1/uno/data-backfill/propagation/jobs/{jobId}:
    get:
      description: |
        Use this operation to retrieve a specific auto backfill job.
      operationId: GET_AutoBackfillJobById
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            ID of the job to retrieve
          in: path
          name: jobId
          required: true
          schema:
            type: string
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              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.
              schema:
                type: string
            RateLimit-Remaining:
              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.
              schema:
                type: number
            RateLimit-Reset:
              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.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              examples:
                success:
                  value:
                    success: true
                    job:
                      id: ff8080818c6748aa018c675a17d758e0
                      createdOn: 1702541006000
                      createdOnReadable: 2023-12-14T16:03:26+0800
                      updatedOn: 1702541007000
                      updatedOnReadable: 2023-12-14T16:03:27+0800
                      updatedByUsername: test1702540260413@test.com
                      status: COMPLETED
                      type: RatePlanCharge
                      batchSentCount: 1
                      batchFinishedCount: 1
                      errorCount: 0
                      progress: 100.00%
                fail:
                  value:
                    success: false
                    processId: 1B81A64621CAD85D
                    requestId: c7f5f81c-cb9a-4a8a-b40b-27cca8a7c25f
                    reasons:
                      - code: '50000020'
                        message: Error Message
              schema:
                allOf:
                  - $ref: '#/components/schemas/CommonResponse'
                  - type: object
                    properties:
                      job:
                        $ref: '#/components/schemas/GETAutoBackfillJobResponse'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an auto backfill job
      tags:
        - Data Backfill
    put:
      description: |
        Use this operation to stop an auto backfill job.
      operationId: PUT_StopAutoBackfillJobById
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: |
            ID of the job to stop
          in: path
          name: jobId
          required: true
          schema:
            type: string
            minLength: 32
            maxLength: 32
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  description: |
                    `Stopping` is currently the only allowed value.
                  type: string
                  enum:
                    - Stopping
              required:
                - status
            example:
              status: Stopping
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              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.
              schema:
                type: string
            RateLimit-Remaining:
              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.
              schema:
                type: number
            RateLimit-Reset:
              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.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Stop an auto backfill job
      tags:
        - Data Backfill
  /v1/action/create:
    post:
      description: >
        Use the create call to create one or more objects of a specific type.
        You can specify different types in different create calls, but each
        create call must apply to only one type of object.


        ### Limitations 


        This call has the following limitations:


        * A maximum of 50 objects are supported in a single call.

        * The Orders feature is not supported.

        * The Invoice Settlement feature is not supported. This feature includes
        Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.

        * The default WSDL version for Actions is 79. To create objects
        according to a different WSDL version, set the `X-Zuora-WSDL-Version`
        header. To find out in which WSDL version a particular object or field
        was introduced, see [Zuora SOAP API Version
        History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).



        ### How to use this call


        You can create on an array of one or more zObjects. The fields you
        should specify can be found in the corresponding "CRUD: Create an
        *zObject*" operation.

        For example, to create one or multiple accounts, use the request fields
        in the [CRUD: Create an
        account](https://developer.zuora.com/api-references/older-api/operation/Object_POSTAccount/)
        operation.


        It returns an array of SaveResults sorted in the same order, indicating
        the success or failure of creating each object. The following
        information applies to this call:


        * You cannot pass in null zObjects.

        * You can pass in a maximum of 50 zObjects at a time.

        * All objects must be of the same type.


        #### Using Create and Subscribe Calls 


        Both the Create and Subscribe calls will create a new account. However,
        there are differences between the calls.


        Use the create call to create an account independent of a subscription.


        Use the subscribe call to create the account with the subscription and
        the initial payment information.
      operationId: Action_POSTcreate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyActioncreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    - Id: 2c93808457d787030157e0324aea5158
                      Success: true
              schema:
                description: ''
                items:
                  $ref: '#/components/schemas/SaveResult'
                type: array
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Create
      tags:
        - Actions
  /v1/action/delete:
    post:
      description: >
        Deletes one or more objects of the same type. You can specify different
        types in different delete calls, but each delete call must apply only to
        one type of object.


        The following information applies to this call:


        * You will need to first determine the IDs for the objects you wish to
        delete.

        * You cannot pass in any null IDs.

        * All objects in a specific delete call must be of the same type.



        ### Objects per Call

        50 objects are supported in a single call.
      operationId: Action_POSTdelete
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyActiondeleteRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    - id: 2c93808457d787030157e031fcd34e19
                      success: true
              schema:
                description: ''
                items:
                  $ref: '#/components/schemas/DeleteResult'
                type: array
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Delete
      tags:
        - Actions
  /v1/action/query:
    post:
      description: >
        The query call sends a query expression by specifying the object to
        query, the fields to retrieve from that object, and any filters to
        determine whether a given object should be queried.


        You can use [Zuora Object Query
        Language](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language)(ZOQL)
        to construct those queries, passing them through the `queryString`.


        Once the call is made, the API executes the query against the specified
        object and returns a query response object to your application. Your
        application can then iterate through rows in the query response to
        retrieve information.


        ### Limitations


        This call has the following limitations:


        * All [ZOQL
        limitations](https://knowledgecenter.zuora.com/Central_Platform/Query/ZOQL#ZOQL_Limitations)
        apply.

        * All ZOQL keywords must be in lower case.

        * The number of records returned is limited to 2000 records.

        * The Invoice Settlement feature is not supported. This feature includes
        Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.

        * The Orders feature is not supported, which means that the objects
        listed in [Orders Object
        Model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/BA_Orders_Object_Model)
        are not supported.

        * The Active Rating feature is not supported.

        * The default WSDL version for Actions is 79. To query objects or fields
        according to a different WSDL version, set the `X-Zuora-WSDL-Version`
        header. To find out in which WSDL version a particular object or field
        was introduced, see [Zuora SOAP API Version
        History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).

        * Fields with NULL values are not returned in the response.
      operationId: Action_POSTquery
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyActionqueryRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    size: 1
                    records:
                      - BillCycleDay": 1
                        Id: 8ad09378905a5af201907ca1edb524c2
                        AccountNumber: A00000212
                    done: true
              schema:
                $ref: '#/components/schemas/ProxyActionqueryResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Query
      tags:
        - Actions
  /v1/action/queryMore:
    post:
      description: >
        Use queryMore to request additional results from a previous query call.
        If your initial query call returns more than 2000 results, you can use
        queryMore to query for the additional results.



        Any `queryLocator` results greater than 2,000, will only be stored by
        Zuora for 5 days before it is deleted.


         This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the `queryLocator` returned from query to request the next set of results.


        **Note:** Zuora expires queryMore cursors after 15 minutes of activity.



        To use queryMore, you first construct a query call. By default, the
        query call will return up to 2000 results. If there are more than 2000
        results, query will return a boolean `done`, which will be marked as
        `false`, and a `queryLocator`, which is a marker you will pass to
        queryMore to get the next set of results.
      operationId: Action_POSTqueryMore
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyActionqueryMoreRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    size: 252070
                    records:
                      - Id: 2c92c0855460118101546e8ccbfc76d4
                      - Id: 2c92c0855460118101546e8ccbfd76d7
                    queryLocator: 2c92c0f9602fb240016049ac7e0b47e7-4000
                    done: false
              schema:
                $ref: '#/components/schemas/ProxyActionqueryMoreResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: QueryMore
      tags:
        - Actions
  /v1/action/update:
    post:
      description: >

        Updates the information in one or more objects of the same type. You can
        specify different types of objects in different update calls, but each
        specific update call must apply to only one type of object.



        ### Limitations 


        This call has the following limitations:


        * A maximum of 50 objects are supported in a single call.

        * The Invoice Settlement feature is not supported. This feature includes
        Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.

        * The default WSDL version for Actions is 79. To update objects or
        fields according to a different WSDL version, set the
        `X-Zuora-WSDL-Version` header. To find out in which WSDL version a
        particular object or field was introduced, see [Zuora SOAP API Version
        History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).



        ### How to use this call? 


        You can update an array of one or more zObjects. The fields you should
        specify can be found in the corresponding "CRUD: Update an *zObject*"
        operation.

        For example, to update one or multiple accounts, use the request fields
        in the [CRUD: Update an
        account](https://developer.zuora.com/api-references/older-api/operation/Object_PUTAccount/)
        operation.


        It returns an array of SaveResults sorted in the same order, indicating
        the success or failure of updating each object. The following
        information applies to this call:


        * You cannot pass in null zObjects.

        * You can pass in a maximum of 50 zObjects at a time.

        * All objects must be of the same type.

        * For each field in each object, you must determine that object's ID.
        Then populate the fields that you want update with the new information.

        * Zuora ignores unrecognized fields in update calls. For example, if an
        optional field is spelled incorrectly or a field that does not exist is
        specified, Zuora ignores the field and continues to process the call. No
        error message is returned for unrecognized fields.
      operationId: Action_POSTupdate
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyActionupdateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    - Id: 8ad09378905a5af201907ca1edb524c2
                      Success: true
              schema:
                description: ''
                items:
                  $ref: '#/components/schemas/SaveResult'
                type: array
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: Update
      tags:
        - Actions
  /settings/batch-requests:
    post:
      description: >
        Submit a batch of settings requests by this single API operation.


        See a [200 response sample in CSV
        format](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.csv)
        that lists all available settings. 


        See a [200 response sample in JSON
        format](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.json)
        that lists all available parameters of each setting.


        By default, one batch settings request can contain a maximum of 100
        single operation requests, including: 

        * All the single requests in the process batch settings request.

        * All the children requests of the single requests.


        This maximum value is configurable.
      operationId: POST_ProcessSettingsBatchRequest
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SettingsBatchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    responses:
                      - children: []
                        id: '1'
                        method: GET
                        response:
                          body:
                            allowAutoPostBillRun: true
                            autoPostBillRunDefaultValue: true
                            availableToCreditValidationLevel: HeaderLevel
                            billToTermEndWhenAutoRenew: true
                            daysInMonth: UseActualDays
                            includeChildUsage: true
                            includeNegativeInvoice: true
                            invoicePastEndOfTerm: false
                            legalDocumentGeneratingRule: GroupByOriginalSRPC
                            notSendZeroItemsForTax: false
                            oneTimeCreditBack: false
                            preGenerateInvoicePdf: false
                            proratePeriodOfRecurringCharge: true
                            prorateRecurringMonthlyCharges: true
                            prorateRecurringWeeklyCharges: true
                            prorateUsageMonthlyCharges: true
                            prorateUsageWeeklyCharges: true
                            prorationUnit: ProrateByDay
                            rateUsageIndividually: true
                            recurringChargeStyle: Advanced
                            takeContactSnapshot: true
                            taxAddressOwner: SubscriptionOwner
                            taxInclusiveRoundingRule: RoundingNetAmount
                            taxRateChangeOption: OneTaxItem
                            timeOfDailyInvoice: 0
                            transactionOnSubscription: true
                            zuoraTaxRoundingDiffDispersion: false
                          status: 200 OK
                        url: /billing-rules
                      - children: []
                        id: '2'
                        method: GET
                        response:
                          body:
                            allowBlankAccountingCodes: true
                            allowCreationInClosedPeriod: true
                            allowRevenueScheduleNegativeAmounts: true
                            allowUsageInClosedPeriod: true
                            differentCurrencies: false
                          status: 200 OK
                        url: /accounting-rules
              schema:
                $ref: '#/components/schemas/SettingsBatchResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Submit settings requests
      tags:
        - Settings
  /settings/listing:
    get:
      description: >
        Get a list of all available settings in your tenant. 


        The response message is by default in JSON format. If you want to
        receive all the available settings in csv format, include `Accept` in
        the header parameters and set it to `application/csv`.
                    
        See a [200 response sample in CSV
        format](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.csv)
        that lists all available settings. 


        See a [200 response sample in JSON
        format](https://developer.zuora.com/settings-api/ListAllSettingsResponseSample.json)
        that lists all available parameters of each setting.


        You can find a specific operation of an available setting item in your
        tenant from the 200 response body of this call. See the following common
        use cases of Settings API for how to operate on a specifc setting item.

         * Billing Rules:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/billing-rule-settings/get-a-specific-setting---billing-rules' target='_blank'>Get a specific setting - Billing Rules</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/billing-rule-settings/update-a-specific-setting---billing-rules' target='_blank'>Update a specific setting - Billing Rules</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/billing-rule-settings/get-accounting-rules---billing-rules' target='_blank'>Get accounting rules - Billing Rules</a>
         * Age Buckets:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/age-bucket-settings/get-age-buckets' target='_blank'>Get Age Buckets</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/age-bucket-settings/update-age-buckets' target='_blank'>Update Age Buckets</a>
         * Invoice Templates:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/get-a-specific-invoice-template' target='_blank'>Get a specific Invoice Template</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/get-all-invoice-templates' target='_blank'>Get all Invoice Templates</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/create-a-new-invoice-template' target='_blank'>Create a new Invoice Template</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/update-a-specific-invoice-template' target='_blank'>Update a specific Invoice Template</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-template-settings/delete-a-specific-invoice-templates' target='_blank'>Delete a specific Invoice Template</a>
         * Invoice Group:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/create-an-invoice-group' target='_blank'>Create an invoice group</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/update-an-invoice-group' target='_blank'>Update an invoice group</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/invoice-group-settings/get-a-specific-invoice-group' target='_blank'>Get a specific invoice group</a>
         * Communications Profiles:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/create-a-new-communication-profile' target='_blank'>Create a new Communication Profile</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/get-a-communication-profile' target='_blank'>Get a Communication Profile</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/get-all-communication-profiles' target='_blank'>Get all Communication Profiles</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/communication-profile-settings/modify-a-communication-profile' target='_blank'>Modify a Communication Profile</a>
         * Notification Definitions:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/get-all-notifications-under-a-particular-communication-profile' target='_blank'>Get all notification definitions under a particular Communication Profile</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/create-a-notification-definition-under-a-particular-communication-profile' target='_blank'>Create a notification definition under a particular Communication Profile</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/get-a-notification-definition' target='_blank'>Get a notification definition</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/update-a-notification-definition' target='_blank'>Update a notification definition</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/notification-definition-settings/delete-a-notification-definition' target='_blank'>Delete a notification definition</a>
         * Reusable Blocks:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/create-or-update-reusable-blocks' target='_blank'>Create or update reusable blocks</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/get-all-reusable-blocks' target='_blank'>Get all reusable blocks</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/get-a-reusable-block' target='_blank'>Get a reusable block</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/update-a-reusable-block' target='_blank'>Update a reusable block</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/reusable-block-settings/delete-a-reusable-block' target='_blank'>Delete a reusable block</a>
         * Chart of Accounts:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/chart-of-account-settings/get-chart-of-accounts' target='_blank'>Get Chart of Accounts</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/chart-of-account-settings/add-a-new-chart-of-account' target='_blank'>Add a new Chart of Account</a>
         * Quote Templates:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/quote-template-settings/get-all-quote-templates' target='_blank'>Get all Quote Templates</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/quote-template-settings/get-a-specific-quote-template' target='_blank'>Get a specific Quote Template</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/quote-template-settings/create-a-new-quote-template' target='_blank'>Create a new Quote Template</a>
         * Direct Integration Tax Engine:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/avalara-tax-engine-settings#create-an-avalara-tax-engine-0' target='_blank'>Create a Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/avalara-tax-engine-settings#get-an-avalara-tax-engine-0' target='_blank'>Retrieve a Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/avalara-tax-engine-settings#update-an-avalara-tax-engine-0' target='_blank'>Update a Tax Engine</a>
         * Connect Tax Engines:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings' target='_blank'>Create a Connect Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings#get-a-connect-tax-engine-0' target='_blank'>Get a Connect Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings#update-a-connect-tax-engine-0' target='_blank'>Update a Connect Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/connect-tax-engines-settings#delete-a-connect-tax-engine-0' target='_blank'>Delete a Connect Tax Engine</a>
         * Zuora Tax Engine:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#get-tax-engines-0' target='_blank'>Get Tax Engines</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#create-tax-code-using-zuora-tax-engine-0' target='_blank'>Create Tax Code using Zuora Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#get-tax-code-using-zuora-tax-engine-0' target='_blank'>Get Tax Code using Zuora Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#update-tax-code-using-zuora-tax-engine-0' target='_blank'>Update Tax Code using Zuora Tax Engine</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-engine-settings#delete-tax-code-using-zuora-tax-engine-0' target='_blank'>Delete Tax Code using Zuora Tax Engine</a>
         * Zuora Tax Rate Period:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#create-tax-rate-periods-0' target='_blank'>Create Tax Rate Periods</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#get-tax-rate-periods-0' target='_blank'>Get Tax Rate Periods</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#update-tax-rate-periods-0' target='_blank'>Update Tax Rate Periods</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rate-period-settings#delete-tax-rate-periods-0' target='_blank'>Delete Tax Rate Periods</a>
        * Zuora Tax Code:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#get-specific-tax-code-id-0' target='_blank'>Get Specific Tax Code ID</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#create-tax-codes-0' target='_blank'>Create Tax Codes</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#update-tax-codes-0' target='_blank'>Update Tax Codes</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-code-api-settings#delete-tax-codes-0' target='_blank'>Delete Tax Codes</a>
        * Zuora Tax Rates:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#retrieve-a-list-of-tax-rates-0' target='_blank'>Get List of Tax Rates</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#create-tax-rates-0' target='_blank'>Create Tax Rates</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#update-tax-rates-0' target='_blank'>Update Tax Rates</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/zuora-tax-rates-api-settings#delete-tax-rates-0' target='_blank'>Delete Tax Rates</a>
         * Units of Measure:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/create-a-unit-of-measure' target='_blank'>Create a Unit of Measure</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/get-a-unit-of-measure' target='_blank'>Get a Unit of Measure</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/get-all-units-of-measure' target='_blank'>Get all Units of Measure</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/update-a-unit-of-measure' target='_blank'>Update a Unit of Measure</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/unit-of-measure-settings/delete-a-unit-of-measure' target='_blank'>Delete a Unit of Measure</a>
         * Summary Statement:
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#get-a-specific-summary-statement-template-0' target='_blank'>Get a specific summary statement template</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#get-all-templates-for-summary-statement-0' target='_blank'>Get all templates for summary statement</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#create-a-new-summary-statement-template-0' target='_blank'>Create a new summary statement template</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#update-a-specific-summary-statement-template-0' target='_blank'>Update a specific summary statement template</a>
           * <a href='https://docs.zuora.com/en/zuora-platform/system-management/settings-api/settings-api-tutorials/summary-statement-settings#deletea-specific-summary-statement-template-0' target='_blank'>Delete a specific summary statement template</a>
      operationId: GET_ListAllSettings
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: >
            Specifies response media type. If you omit the `Accept` header
            parameter, the response body is by default in JSON format. If you
            include `Accept` header parameter and set it to `application/csv`,
            the response body is in csv format.
          in: header
          name: Accept
          required: false
          schema:
            maxLength: 64
            type: string
      responses:
        '200':
          content:
            application/csv:
              schema:
                $ref: '#/components/schemas/ListAllSettingsResponse'
            application/json:
              examples:
                response:
                  value:
                    settings:
                      - context: Entity
                        description: Accounting Rules settings
                        httpOperations:
                          - method: GET
                            parameters: []
                            responseType: {}
                            url: /settings/accounting-rules
                          - method: PUT
                            parameters: []
                            requestType: {}
                            responseType: {}
                            url: /settings/accounting-rules
                        key: AccountingRules
                        pathPattern: /accounting-rules
              schema:
                $ref: '#/components/schemas/ListAllSettingsResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List all settings
      tags:
        - Settings
  /v1/files/{file-id}:
    get:
      description: >
        Retrieve files such as export results, invoices, and accounting period
        reports.


        The response content type depends on the type of file that you retrieve.

        For example, if you retrieve an invoice PDF, the value of the
        `Content-Type`

        header in the response is `application/pdf;charset=UTF-8`.


        Other content types include:


        - `text/csv` for CSV files

        - `application/msword` for Microsoft Word files

        - `application/vnd.ms-excel` and
        `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
          for Microsoft Excel files (*.xls* and *.xlsx* respectively)
        - `application/zip` and `application/x-gzip` for ZIP and Gzip files
        respectively

        - `text/html` for HTML files

        - `text/plain` for text files


        The response always contains character encoding information in the
        `Content-Type` header.

        For example, `Content-Type: application/zip;charset=UTF-8`.


        **Note:** The maximum file size is 2,047 MB. If you have a data request
        that exceeds this limit, Zuora returns the following 403 response:
        `<security:max-object-size>2047MB</security:max-object-size>`. Submit a
        request at <a href="http://support.zuora.com/" target="_blank">Zuora
        Global Support</a> to determine if large file optimization is an option
        for you.
      operationId: GET_Files
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The Zuora ID of the file to retrieve.
          in: path
          name: file-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve a file
      tags:
        - Files
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X GET -H "Authorization: Bearer
            6d151216ef504f65b8ff6e9e9e8356d3" -H "Accept: application/pdf"
            "https://rest.zuora.com/v1/files/2c92c08c55534cf00155581fb474314d"
            -o invoice.pdf
  /v1/files/{file-id}/restore:
    put:
      description: >
        Restores a previously archived file to its RESTORED status. Once a file
        is archived, it cannot be used directly until the file is restored using
        this API.

        ### Notes

        - This API operation will fail if the count of restored files exceeds
        the quota limit (1000 by default) in the past 24 hours.

        - The actual restoration process may take between 12 to 48 hours to
        complete.

        - You can monitor the status of the file restoration process using the
        [Retrieve file
        status](https://developer.zuora.com/api-references/api/operation/GET_FileStatus)
        API operation until the status transitions to `RESTORED`.
      operationId: PUT_Files
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            The Zuora ID of the file to restore.
          in: path
          name: file-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    fileId: 402881888e89748b018e897a6a500025
                    status: RESTORE_IN_PROGRESS
              schema:
                $ref: '#/components/schemas/RestoreFile'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Restore a file
      tags:
        - Files
      x-code-samples:
        - label: Curl
          lang: curl
          source: |-
            curl -i -X PUT \
              'https://rest.zuora.com/v1/files/402881888e89748b018e897a6a500025/restore' \ 
              -H 'Zuora-Tenant-Id: 17' \
              -H 'Zuora-Entity-Ids: 402881868d304631018d304a0f940226' \
              -H 'Authorization: Basic YmZkQHp1b3JhLmNvbtJjpdmFjOEw+YhmWy=='
  /v1/files/{file-id}/status:
    get:
      description: |
        Retrieves the status of the file.
      operationId: GET_FileStatus
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The Zuora ID of the file to for which the status should be
            retrieved.
          in: path
          name: file-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
                    accessible: true
                    status: RESTORED
              schema:
                $ref: '#/components/schemas/RetrieveFileStatus'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve file status
      tags:
        - Files
      x-code-samples:
        - label: Curl
          lang: curl
          source: |-
            curl -i -X GET \
              'https://rest.zuora.com/v1/files/402881888e89748b018e897a6a500025/status' \ 
              -H 'Zuora-Tenant-Id: 17' \
              -H 'Zuora-Entity-Ids: 402881868d304631018d304a0f940226' \
              -H 'Authorization: Basic YmZkQHp1b3JhLmNvbtJjpdmFjOEw+YhmWy=='
  /v1/object/import:
    post:
      description: |
        Creates a data import.
      operationId: Object_POSTImport
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                File:
                  description: |
                    The data to import.
                  format: binary
                  type: string
                ImportType:
                  description: |
                    The type of data to import.
                  enum:
                    - Usage
                    - Payment
                    - Quote
                    - TaxationDetail
                    - UpdateAccountingCode
                    - CreateRevenueSchedule
                    - UpdateRevenueSchedule
                    - DeleteRevenueSchedule
                    - ImportFXRate
                  type: string
                Name:
                  description: |
                    A descriptive name for the import.
                  type: string
              required:
                - ImportType
                - Name
                - File
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    Id: 2c92c0f8601fab5701601fee2bf67056
                    Success: true
              schema:
                $ref: '#/components/schemas/ProxyPostImport'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Create an import'
      tags:
        - Imports
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1" -F "ImportType=Usage" -F
            "Name=UsageData.csv" -F "File=@UsageData.csv"
            "https://rest.zuora.com/v1/object/import"
  /v1/object/import/{id}:
    get:
      description: Retrieve an data import job.
      operationId: Object_GETImport
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - description: Object fields to return
          in: query
          name: fields
          required: false
          schema:
            type: string
        - description: Object id
          in: path
          name: id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyGetImport'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '401':
          content:
            application/json:
              examples:
                response:
                  value:
                    message: Authentication error
              schema:
                $ref: '#/components/schemas/ProxyUnauthorizedResponse'
          description: Unauthorized
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            WWW-Authenticate:
              description: >
                The value of this header is:


                ```

                Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                realm=Zuora API

                ```
              schema:
                enum:
                  - >-
                    Basic realm=Zuora API, ZSession realm=Zuora API, Bearer
                    realm=Zuora API
                type: string
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            application/json:
              examples:
                response:
                  value:
                    done: true
                    records: {}
                    size: 0
              schema:
                $ref: '#/components/schemas/ProxyNoDataResponse'
          description: ''
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
      summary: 'CRUD: Retrieve an import'
      tags:
        - Imports
  /v1/custom-exchange-rates/{currency}:
    get:
      description: >
        This feature is in **Limited Availability**. If you wish to have access
        to the feature, submit a request at [Zuora Global
        Support](http://support.zuora.com/). 


        This reference describes how to query custom foreign exchange rates from
        Zuora. You can use this API method to query exchange rates only if you
        use a custom exchange rate provider and upload rates with the Import
        Foreign Exchange Rates mass action. 
      operationId: GET_CustomExchangeRates
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            The target base currency of the tenant. The exchange rates in the
            response are calculated in relation to the target currency.


            The value must be a three-letter currency code, for example, USD. 
          in: path
          name: currency
          required: true
          schema:
            type: string
        - description: >
            Start date of the date range for which you want to get exchange
            rates.


            The date must be in yyyy-mm-dd format, for example, 2016-01-15. The
            start date cannot be later than the end date.
          in: query
          name: startDate
          required: true
          schema:
            type: string
        - description: >
            End date of the date range for which you want to get exchange rates.


            The date must be in yyyy-mm-dd format, for example, 2016-01-16. The
            end date can be a maximum of 90 days after the start date.
          in: query
          name: endDate
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    inverse: false
                    rateSetName: RateSet_EU
                    rates:
                      '2019-04-28':
                        GBP: 1.135239621
                        USD: 0.889028445
                        providerExchangeRateDate: '2019-04-28'
                      '2019-04-29':
                        GBP: 1.134623962
                        USD: 0.892140244
                        providerExchangeRateDate: '2019-04-29'
                      '2019-04-30':
                        GBP: 1.134589832
                        USD: 0.892243287
                        providerExchangeRateDate: '2019-04-30'
                    success: true
              schema:
                $ref: '#/components/schemas/GETCustomExchangeRatesType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List custom exchange rates by currency
      tags:
        - Custom Exchange Rates
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X GET -H "Authorization: Bearer
            6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type:
            application/json"
            "https://rest.sandbox.eu.zuora.com/v1/custom-exchange-rates/EUR?startDate=2019-04-28&endDate=2019-04-30"
  /v1/attachments:
    post:
      description: >
        Use the Add Attachment REST request with a multipart/form-data to attach
        a document file to an Account, a Subscription, an Invoice, a Credit
        Memo, or a Debit Memo.


        You can only use this operation if you have a Billing role that includes
        the Manage Attachments permission.

        For more information, see [Billing
        roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).

        To change your Billing role, contact your Zuora platform administrator.


        **Note**: The Credit and Debit Memos feature is only available if you
        have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: POST_Attachments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: |
            Description of the attachment document.
          in: query
          name: description
          required: false
          schema:
            type: string
        - description: |
            The type of the object to add attachements for. 
          in: query
          name: associatedObjectType
          required: true
          schema:
            enum:
              - Account
              - Invoice
              - Subscription
              - CreditMemo
              - DebitMemo
            type: string
        - description: >
            For the Subscription type, specify the Subscription Number. An
            attachment is tied to the Subscription Number and thus viewable with
            every subscription version.


            For Account, Credit Memo, and Debit Memo, specify the corresponding
            ID or number. For Invoice, specify the corresponding ID.
          in: query
          name: associatedObjectKey
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: >
                    The file to be attached. Files with the following extensions
                    are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx,
                    .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf,
                    .xml, .jpeg, .log, .cls


                    The maximum file size is 4 MB.
                  format: binary
                  type: string
              required:
                - file
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    fileId: 402880ea536ff494015372a7ea12001e
                    id: 402880ea536ff494015372a7ea17001f
                    success: true
              schema:
                $ref: '#/components/schemas/POSTAttachmentResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Create an attachment
      tags:
        - Attachments
      x-code-samples:
        - label: Curl
          lang: curl
          source: >
            curl -X POST -H "Authorization: Bearer
            f21f017e4724445d8647b1f0de7ed6f1" -F "file=@PODocument.pdf"
            "https://rest.zuora.com/v1/attachments/?description=Postal%20order&associatedObjectType=Subscription&associatedObjectKey=A-S00005714"
  /v1/attachments/{attachment-id}:
    delete:
      description: >
        Use the Delete Attachment REST request to delete an attachment from a
        Zuora object.


        You can only use this operation if you have a Billing role that includes
        the Manage Attachments permission and the Delete Attachments permission.

        For more information, see [Billing
        roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).

        To change your Billing role, contact your Zuora platform administrator.
      operationId: DELETE_Attachments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Id of the attachment to be deleted.
          in: path
          name: attachment-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Delete an attachment
      tags:
        - Attachments
    get:
      description: >
        Use the View Attachment REST request to retrieve information about an
        attachment document.


        You can only use this operation if you have a Billing role that includes
        the Manage Attachments permission.

        For more information, see [Billing
        roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).

        To change your Billing role, contact your Zuora platform administrator.
      operationId: GET_Attachments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Id of the attachment you want to view.
          in: path
          name: attachment-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    createdBy: 4028e487327fd45a0132829ebb673ff9
                    createdOn: '2016-05-02 13:09:17'
                    description: ''
                    fileContentType: text/plain
                    fileId: 8a8083e1545b706a01547316d9094400
                    fileName: AttachTest.txt
                    id: 8a8083e1545b706a01547316d93f4401
                    success: true
                    updatedBy: 4028e487327fd45a0132829ebb673ff9
                    updatedOn: '2016-05-02 13:09:17'
              schema:
                $ref: '#/components/schemas/GETAttachmentResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Retrieve an attachment
      tags:
        - Attachments
    put:
      description: >
        Use the Edit Attachment REST request to make changes to the descriptive
        fields of an attachment, such as the description and the file name. You
        cannot change the actual content of the attached file in Zuora. If you
        need to change the actual content, you need to delete the attachment and
        add the updated file as a new attachment.


        You can only use this operation if you have a Billing role that includes
        the Manage Attachments permission.

        For more information, see [Billing
        roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).

        To change your Billing role, contact your Zuora platform administrator.
      operationId: PUT_Attachments
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: Id of the attachment to be updated.
          in: path
          name: attachment-id
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PUTAttachmentType'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    success: true
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Update an attachment
      tags:
        - Attachments
  /v1/attachments/{object-type}/{object-key}:
    get:
      description: >
        Use the View Attachment REST request to get a list of attachments on an
        account, an invoice, a subscription, a credit memo, or a debit memo.


        You can only use this operation if you have a Billing role that includes
        the Manage Attachments permission.

        For more information, see [Billing
        roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).

        To change your Billing role, contact your Zuora platform administrator.


        **Note**: The Credit and Debit Memos feature is only available if you
        have [Invoice
        Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
        enabled. The Invoice Settlement feature is generally available as of
        Zuora Billing Release 296 (March 2021). This feature includes Unapplied
        Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
        want to enable Invoice Settlement, see [Invoice Settlement Enablement
        and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information. 
      operationId: GET_AttachmentsList
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_page'
        - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize'
        - description: |
            The type of the object to list attachements for.
          in: path
          name: object-type
          required: true
          schema:
            enum:
              - account
              - invoice
              - subscription
              - creditmemo
              - debitmemo
            type: string
        - description: |
            ID of the object to list attachements for.
             - If `object-type` is `account`, specify an account ID or number.
             - If `object-type` is `invoice`, specify an invoice ID.
             - If `object-type` is `subscription`, specify a subscription number.
             - If `object-type` is `creditmemo`, specify a credit memo ID or number.
             - If `object-type` is `debitmemo`, specify a debit memo ID or number.
          in: path
          name: object-key
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    attachments:
                      - createdBy: 402881e522cf4f9b0122cf5d82860002
                        createdOn: '2016-03-21 14:00:47'
                        description: null
                        fileContentType: application/pdf
                        fileId: 402896b95397c169015397c2ebc50002
                        fileName: Search _ Splunk.pdf
                        id: 402896b95397c169015397c2ebca0003
                        success: true
                        updatedBy: 402881e522cf4f9b0122cf5d82860002
                        updatedOn: '2016-03-21 14:00:47'
                      - createdBy: 4028e487327fd45a0132829ebb673ff9
                        createdOn: '2016-05-02 13:09:17'
                        description: ''
                        fileContentType: text/plain
                        fileId: 8a8083e1545b706a01547316d9094400
                        fileName: AttachTest.txt
                        id: 8a8083e1545b706a01547316d93f4401
                        updatedBy: 4028e487327fd45a0132829ebb673ff9
                        updatedOn: '2016-05-02 13:09:17'
                    success: true
              schema:
                $ref: '#/components/schemas/GETAttachmentsResponseType'
          description: OK
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
        4XX:
          content:
            application/json:
              examples:
                response:
                  value:
                    processId: 738CBB9234B47A47
                    reasons:
                      - code: '58730222'
                        message: orderDate may not be null
                    requestId: d7479cf6-b410-4630-b841-268ccd48f0d2
                    success: false
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Request Errors
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: List attachments by object type and key
      tags:
        - Attachments
  /v1/describe/{object}:
    get:
      description: >
        Provides a reference listing of each object that is available in your
        Zuora tenant.


        The information returned by this call is useful if you are using [CRUD:
        Create
        Export](https://developer.zuora.com/api-references/api/operation/Object_POSTExport)
        or the [AQuA
        API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API)
        to create a data source export. See [Export
        ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) for
        more information.


        ### Response

        The response contains an XML document that lists the fields of the
        specified object. Each of the object's fields is represented by a
        `<field>` element in the XML document.

         
        Response sample:

        ```xml

        <?xml version="1.0" encoding="UTF-8"?>

        <object>
          <name>ProductRatePlanCharge</name>
          <label>Product Rate Plan Charge</label>
          <fields>
            ...
            <field>
              <name>TaxMode</name>
              <label>Tax Mode</label>
              <type>picklist</type>
              <options>
                <option>TaxExclusive</option>
                <option>TaxInclusive</option>
              </options>
              <contexts>
                <context>export</context>
              </contexts>
              ...
            </field>
            ...
          </fields>
        </object>

        ```



        It is strongly recommended that your integration checks `<contexts>`
        elements in the response. If your integration does not check
        `<contexts>` elements, your integration may process fields that are not
        available for use in data source exports. See [Changes to the Describe
        API](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL/Changes_to_the_Describe_API)
        for more information.
      operationId: GET_Describe
      parameters:
        - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
        - description: >
            API name of an object in your Zuora tenant. For example,
            `InvoiceItem`. See [API object names for
            Describe](https://developer.zuora.com/v1-api-reference/api-object-names/)
            for the list of valid object names.


            Depending on the features enabled in your Zuora tenant, you may not
            be able to list the fields of some objects.
          in: path
          name: object
          required: true
          schema:
            type: string
        - description: >
            Set the value to `yes` to get additional currency conversion
            information in the result.

            **Notes:** 

            - When **Automatically include additional Currency Conversion
            information** in currency conversion settings is checked, you can
            pass `yes` to get additional fields in the result. See [Configure
            Foreign Currency
            Conversion](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion#:~:text=Automatically%20include%20additional%20Currency%20Conversion%20information%20in%20data%20source%20exports%3A%C2%A0Select%20this%20check%20box%20if%20you%20want%20to%20access%20foreign%20currency%20conversion%20data%20through%20data%20source%20exports.)
            to check the **Automatically include additional Currency Conversion
            information**.

            - By default if you need additional Currency Conversion information,
            submit a request at <a href="https://support.zuora.com/hc/en-us"
            target="_blank">Zuora Global Support</a>. Set this parameter value
            to `no` to not include the additional currency conversion
            information in the result.
          in: query
          name: showCurrencyConversionInformation
          schema:
            type: string
        - description: >
            Indicates whether to return joined objects information in the
            response. The default value is `false`, meaning no related object
            information is returned.


            If you set this field to `true`, an additional `<related-objects />`
            section is returned. For example, if you are describing the Account
            object with this parameter set to `true`, the response will include
            information similar to the following snippet:

            ```xml

            <related-objects>
              <object href="https://apisandbox-api.zuora.com/rest/api/describe/Contact">
                <name>BillToContact</name>
                <label>Bill To</label>
                <cardinality>TO_ONE</cardinality>
                <direct-relationship>true</direct-relationship>
                <path>Account.BillToContact</path>
              </object>
              ...
            <related-objects>

            ```
          in: query
          name: showRelationships
          schema:
            type: boolean
            default: false
        - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version'
      responses:
        '200':
          content:
            text/xml:
              schema:
                properties:
                  object:
                    description: The base object information.
                    type: object
                    properties:
                      name:
                        type: string
                        description: Name of the base object.
                      label:
                        type: string
                        description: Label of the base object in the Zuora UI.
                      fields:
                        description: The fields on the base object.
                        type: array
                        items:
                          type: object
                          title: field
                          properties:
                            name:
                              type: string
                              description: API name of the field.
                              example: Account
                            label:
                              type: string
                              description: Label of the field in the Zuora UI.
                              example: Account
                            type:
                              description: >
                                Data type of the field. 

                                If the data type is `picklist`, the `<field>`
                                element contains an `<options>` element that
                                lists the possible values of the field.
                              enum:
                                - boolean
                                - data
                                - datetime
                                - decimal
                                - integer
                                - picklist
                                - text
                                - timestamp
                                - ZOQL
                            contexts:
                              type: array
                              description: >
                                The contexts of the API object, such as SOAP and
                                REST.
                              items:
                                title: context
                                description: >
                                  Each context information item of the API
                                  object.
                                type: object
                                properties:
                                  context:
                                    type: string
                                    example: soap
                      related-objects:
                        description: >
                          The information of the related objects. This object is
                          returned only if you specify the `showRelationships`
                          query parameter to `true`.
                        type: array
                        items:
                          type: object
                          title: object
                          properties:
                            name:
                              description: Name of the related object.
                              type: string
                              example: BillToContact
                            label:
                              description: Label of the related object in the Zuora UI.
                              type: string
                              example: Bill To
                            cardinality:
                              description: >-
                                The cardinality between the base object and the
                                related object.
                              type: string
                              example: TO_ONE
                            direct-relationship:
                              description: >
                                Indicates whether this object is directly joined
                                with the base object.
                              type: boolean
                              example: true
                            path:
                              description: >
                                Describes how this object is joined from the
                                base object.
                              type: string
                              example: Account.BillToContact
              example: >-
                <?xml version="1.0" encoding="UTF-8"?> <object
                href="https://apisandbox-api.zuora.com/rest/api/describe/Account">
                <name>Account</name> <label>Account</label> <fields> <field>
                <name>AccountNumber</name> <label>Account Number</label>
                <selectable>true</selectable> <createable>true</createable>
                <updateable>true</updateable> <filterable>true</filterable>
                <custom>false</custom> <maxlength></maxlength>
                <required>false</required> <type>text</type> <contexts>
                <context>soap</context> <context>export</context> </contexts>
                </field> </fields> <related-objects> <object
                href="https://apisandbox-api.zuora.com/rest/api/describe/Contact">
                <name>BillToContact</name> <label>Bill To</label>
                <cardinality>TO_ONE</cardinality>
                <direct-relationship>true</direct-relationship>
                <path>Account.BillToContact</path> </object> </related-objects>
                </object>
          description: >
            Returns an XML document that lists the fields of the specified
            object.
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '404':
          content:
            text/xml; charset=utf-8:
              schema:
                type: string
          description: |
            Returns an XML document that indicates the error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: string
            RateLimit-Remaining:
              description: >
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            RateLimit-Reset:
              description: >
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information.
              schema:
                type: number
            Zuora-Request-Id:
              description: >
                The Zuora internal identifier of the API call. You cannot
                control the value of this header.
              schema:
                maxLength: 36
                minLength: 36
                type: string
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
            Concurrency-Limit-Type:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type
            Concurrency-Limit-Limit:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit
            Concurrency-Limit-Remaining:
              $ref: >-
                #/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining
        '500':
          content:
            application/json:
              examples:
                response:
                  value:
                    reasons:
                      - code: SystemError
                        message: internal server error
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal Server Error
          headers:
            Content-Encoding:
              description: >
                This header is returned if you specify the `Accept-Encoding:
                gzip` request header and the response contains over 1000 bytes
                of data.


                Note that only the following MIME types support gzipped
                responses:
                  - `application/json`
                  - `application/xml`
                  - `text/html`
                  - `text/csv`
                  - `text/plain`
              schema:
                type: string
            RateLimit-Limit:
              description: >-
                The request limit quota for the time window closest to
                exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: string
            RateLimit-Remaining:
              description: >-
                The number of requests remaining in the time window closest to
                quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            RateLimit-Reset:
              description: >-
                The number of seconds until the quota resets for the time window
                closest to quota exhaustion. See [rate
                limits](https://developer.zuora.com/docs/guides/rate-limits/)
                for more information. 
              schema:
                type: number
            Zuora-Request-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId'
            Zuora-Track-Id:
              $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId'
      summary: Describe an object
      tags:
        - Describe
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Use `Bearer {{token}}` in the `Authorization` header for authentication.
    basicAuth:
      type: http
      scheme: basic
      description: >
        The user name is the email address that you use for logging in Zuora.
        The password is the API token that is shown in the settings of
        Configurable Payment Retry.
  parameters:
    GLOBAL_HEADER_Zuora_Entity_Ids_Single:
      name: Zuora-Entity-Ids
      in: header
      required: false
      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 should not set this header.
      schema:
        type: string
    GLOBAL_HEADER_Zuora_Track_Id:
      name: Zuora-Track-Id
      in: header
      required: false
      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 (`'`).
      schema:
        type: string
        maxLength: 64
    GLOBAL_HEADER_Accept_Encoding:
      name: Accept-Encoding
      in: header
      required: false
      description: >
        Include the `Accept-Encoding: gzip` header to compress responses as a
        gzipped file. It can significantly reduce the bandwidth required for a
        response. 


        If 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.
      schema:
        type: string
    GLOBAL_HEADER_Content_Encoding:
      name: Content-Encoding
      in: header
      required: false
      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.
      schema:
        type: string
    GLOBAL_HEADER_Idempotency_Key:
      name: Idempotency-Key
      in: header
      required: false
      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. 


        With 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. 
      schema:
        type: string
        maxLength: 255
    GLOBAL_REQUEST_rejectUnknownFields:
      name: rejectUnknownFields
      in: query
      required: false
      description: >
        Specifies whether the call fails if the request body contains unknown
        fields.

        With `rejectUnknownFields` set to `true`, Zuora returns a 400 response
        if

        the request body contains unknown fields. The body of the 400 response
        is:


        ```json

        {
            "message": "Error - unrecognised fields"
        }

        ```


        By default, Zuora ignores unknown fields in the request body.
      schema:
        type: boolean
        default: false
    GLOBAL_HEADER_Zuora_Org_Ids:
      name: Zuora-Org-Ids
      in: header
      required: false
      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, 

        you 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.


        The 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. This
        header is important in Multi-Org (MO) setups because it defines the
        organization context under which the API should operate—mainly used for
        read access or data visibility filtering. If the header is not set, the
        operation is performed in scope of the user's accessible orgs.
      schema:
        type: string
    GLOBAL_HEADER_X_Zuora_WSDL_Version:
      name: X-Zuora-WSDL-Version
      in: header
      required: false
      description: |
        Zuora WSDL version number.
      schema:
        type: string
        default: 79
    GLOBAL_HEADER_Zuora_Version:
      description: >
        The minor API version.


        For a list of available minor versions, see [API
        upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).
      in: header
      name: Zuora-Version
      required: false
      schema:
        type: string
    GLOBAL_REQUEST_page:
      name: page
      in: query
      required: false
      description: >
        The index number of the page that you want to retrieve. This parameter
        is dependent on `pageSize`. You must set `pageSize` before specifying
        `page`. For example, if you set `pageSize` to `20` and `page` to `2`,
        the 21st to 40th records are returned in the response.
      schema:
        type: integer
        minimum: 1
        default: 1
    GLOBAL_REQUEST_pageSize_catalog:
      name: pageSize
      in: query
      required: false
      description: |
        The number of records returned per page in the response.
      schema:
        type: integer
        maximum: 40
        default: 10
    GLOBAL_REQUEST_pageSize:
      name: pageSize
      in: query
      required: false
      description: |
        The number of records returned per page in the response.
      schema:
        type: integer
        maximum: 40
        default: 20
    GLOBAL_HEADER_Charge_Metrics_Accept:
      name: Accept
      in: header
      required: false
      description: >
        Expressed as MIME types that the client is able to understand. Using
        content negotiation, the server then selects one of the proposals, uses
        it and informs the client of its choice with the `Content-Type` response
        header. The possible response MIME types are `application/json-seq`
        compatible with http://jsonlines.org/, and `text/csv` compatible with
        RFC 4180. `application/json-seq` is the default response MIME type. If
        the `Accept` header is not sepecified, or set */*, the response body is
        returned in application/json-seq MIME type.
      schema:
        type: string
    GLOBAL_REQUEST_get_account_details:
      name: getAccountDetails
      description: Retrieves the details of an account.
      in: query
      schema:
        type: boolean
    GLOBAL_HEADER_Authorization_OAuth_optional:
      name: Authorization
      in: header
      required: false
      description: >
        The value is in the `Bearer {token}` format where {token} is a valid
        OAuth token generated by calling [Create an OAuth
        token](https://developer.zuora.com/api-references/api/operation/createToken).
      schema:
        type: string
    GLOBAL_REQUEST_pageSize_finance_accounting:
      name: pageSize
      in: query
      required: false
      description: |
        The number of records returned per page in the response.
      schema:
        type: integer
        maximum: 300
        default: 300
    GLOBAL_REQUEST_pageSize_finance_revenue:
      name: pageSize
      in: query
      required: false
      description: |
        The number of records returned per page in the response.
      schema:
        type: integer
        maximum: 300
        default: 8
    GLOBAL_HEADER_If_Match:
      name: If-Match
      in: header
      required: false
      description: >
        The expected ETag of the resource. You can use this header to perform a
        conditional request. Zuora responds with 412 Precondition Failed if the
        ETag of the resource does not match the value of this header. 
      schema:
        type: string
  schemas:
    TestEnvironmentResponse:
      title: TestEnvironmentResponse
      type: object
      properties:
        createTime:
          type: string
          description: >-
            The date and time when the Test Environment was first synced to
            self-service
          format: date-time
        createdById:
          type: string
          description: >-
            The automatically generated ID of the Zuora user who created the
            Test Environment object
          example: 58f182ab203c447b8b9cd90382da030a
        dataCopyType:
          type: string
          description: The data copy approach for the Test Environment
          enum:
            - FULL
            - CONFIGURATION
        deactivationTime:
          type: string
          description: The date and time when the Test Environment will be deactivated
          format: date-time
        environmentType:
          type: string
          description: The type of tenant for the Test Environment
          example: ENTERPRISE
          enum:
            - TEST
            - ENTERPRISE
            - TRIAL
            - DEMO
            - DEVELOPER
        id:
          type: string
          description: The unique ID (UUID) of the Test Environment
          example: 11111111-1111-1111-1111-111111111111
        lastRefreshTime:
          type: string
          description: The date and time when the Test Environment was last refreshed
          format: date-time
        nextRefreshTime:
          type: string
          description: The date and time when the Test Environment can be refreshed again
          format: date-time
        provisionTime:
          type: string
          description: The date and time when the Test Environment was provisioned
          format: date-time
        revenueTenantId:
          type: string
          description: The revenue tenant ID if a revenue sandbox is attached
        revenueTenantName:
          type: string
          description: The revenue tenant name if a revenue sandbox is attached
        sourceTenantId:
          type: string
          description: The source tenant ID from which the Test Environment was created
          example: 23223
        status:
          type: string
          description: The current status of the Test Environment
          example: ACTIVE
          enum:
            - ACTIVE
            - PROCESSING
            - INACTIVE
            - DEACTIVATED
            - DELETED
        tenantId:
          type: string
          description: The tenant ID of the Test Environment
          example: 23223
        tenantName:
          type: string
          description: The tenant name of the Test Environment
        updateTime:
          type: string
          description: >-
            The date and time when the Test Environment was last synced to
            self-service
          format: date-time
        updatedById:
          type: string
          description: >-
            The automatically generated ID of the Zuora user who updated the
            Test Environment object
          example: 58f182ab203c447b8b9cd90382da030a
      description: The response containing details about the Test Environment
    TestEnvironmentArrayResponse:
      title: ArrayResponse«TestEnvironmentResponse»
      type: object
      properties:
        result:
          type: array
          description: Array of objects
          items:
            $ref: '#/components/schemas/TestEnvironmentResponse'
        size:
          type: integer
          format: int32
      description: Container for array of objects
    JobResponse:
      title: JobResponse
      type: object
      properties:
        createTime:
          type: string
          description: The date and time when the job was first synced to self service
          format: date-time
        createdById:
          type: string
          description: >-
            The automatically generated ID of the Zuora user who created the job
            object
          example: 58f182ab203c447b8b9cd90382da030a
        estimatedCompletionTime:
          type: string
          description: The date and time when the job is estimated to be completed
          format: date-time
        id:
          type: string
          description: The unique ID (UUID) of the Test Environment job
          example: 11111111-1111-1111-1111-111111111111
        jobEndTime:
          type: string
          description: The date and time when the job completed
          format: date-time
        jobStartTime:
          type: string
          description: The date and time when the job was started
          format: date-time
        jobType:
          type: string
          description: The type of Test Environment job being performed
          example: REFRESH
          enum:
            - REFRESH
            - CREATE
            - DELETE
        progressPercentage:
          type: integer
          description: The progress percentage of the job
          format: int32
        scheduledRefreshTime:
          type: string
          description: The optional date and time for scheduling a job
          format: date-time
        status:
          type: string
          description: The status of the Test Environment job
          example: QUEUED
          enum:
            - NEW
            - SCHEDULED
            - QUEUED
            - INITIATED
            - PROVISIONING
            - DEPROVISIONING
            - EXPORTING
            - SCRUBBING
            - RESETTING
            - IMPORTING
            - FINALIZING
            - CANCELLING
            - COMPLETED
            - FAILED
            - CANCELLED
        testEnvironmentId:
          type: string
          description: The Test Environment to which this job belongs
          example: 11111111-1111-1111-1111-111111111111
        updateTime:
          type: string
          description: The date and time when the job was last synced to self-service
          format: date-time
        updatedById:
          type: string
          description: >-
            The automatically generated ID of the Zuora user who updated the job
            object
          example: 58f182ab203c447b8b9cd90382da030a
      description: The job response
    JobArrayResponse:
      title: ArrayResponse«JobResponse»
      type: object
      properties:
        result:
          type: array
          description: Array of objects
          items:
            $ref: '#/components/schemas/JobResponse'
        size:
          type: integer
          format: int32
      description: Container for array of objects
    JobRequest:
      title: JobRequest
      required:
        - jobType
      type: object
      properties:
        jobType:
          type: string
          description: The type of workflow job to be performed on the Test Environment
          example: REFRESH
          enum:
            - REFRESH
        scheduledRefreshTime:
          type: string
          description: Optional date for scheduling a job
          format: date-time
      description: Request for creating test environment job
    JobActionRequest:
      title: JobActionRequest
      required:
        - jobAction
      type: object
      properties:
        jobAction:
          type: string
          description: The action to perform against the workflow job
          example: CANCEL
          enum:
            - CANCEL
      description: Request for invoking a certain action on a workflow job
    TestEnvironmentNotificationResponse:
      title: TestEnvironmentNotificationResponse
      type: object
      properties:
        address:
          type: string
          description: >-
            The email address to receive notifications for the Test Environment
            when a refresh job has been completed or cancelled
          example: john.smith@zuora.com
        id:
          type: string
          description: The unique id (UUID) of the Test Environment notification
          example: 11111111-1111-1111-1111-111111111111
        name:
          type: string
          description: >-
            The name of the recipient who will receive notifications for the
            Test Environment
          example: John Smith
        testEnvironmentId:
          type: string
          description: The unique id (UUID) of the Test Environment
          example: 11111111-1111-1111-1111-111111111111
      description: The notification response for a Test Environment
    TestEnvironmentNotificationArrayResponse:
      title: ArrayResponse«TestEnvironmentNotificationResponse»
      type: object
      properties:
        result:
          type: array
          description: Array of objects
          items:
            $ref: '#/components/schemas/TestEnvironmentNotificationResponse'
        size:
          type: integer
          format: int32
      description: Container for array of objects
    TestEnvironmentNotificationRequest:
      title: TestEnvironmentNotificationRequest
      type: object
      properties:
        address:
          type: string
          description: >-
            The email address to receive notifications for the Test Environment
            when a refresh job has been completed or cancelled
          example: john.smith@zuora.com
        name:
          type: string
          description: >-
            The name of the recipient who will receive notifications for the
            Test Environment
          example: John Smith
      description: Request to create a notification record for the test environment
    tokenResponse:
      properties:
        access_token:
          description: The generated token.
          type: string
        expires_in:
          description: The number of seconds until the token expires.
          type: number
        jti:
          description: A globally unique identifier for the token.
          type: string
        scope:
          description: >-
            A space-delimited list of scopes that the token can be used to
            access.
          type: string
        token_type:
          description: The type of token that was generated, i.e., `bearer`.
          type: string
      type: object
    ProductObjectNSFields:
      description: >
        Container for Product fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the product's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        ItemType__NS:
          description: >
            Type of item that is created in NetSuite for the product. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - Inventory
            - Non Inventory
            - Service
          type: string
        SyncDate__NS:
          description: >
            Date when the product was synchronized with NetSuite. Only available
            if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: productFieldsNS
      type: object
    ProductObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Product object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Product object.
      title: productFieldsCustom
      type: object
    ProxyCreateProduct:
      allOf:
        - properties:
            AllowFeatureChanges:
              description: >
                Controls whether to allow your users to add or remove features
                while creating or amending a subscription.


                **Values**: true, false (default)
              type: boolean
            Category:
              description: >
                Category of the product. Used by Zuora Quotes Guided Product
                Selector.


                **Values**: 
                  - Base Products
                  - Add On Services
                  - Miscellaneous Products
              maxLength: 100
              type: string
            Description:
              description: |
                A description of the product. 
              maxLength: 500
              type: string
            EffectiveEndDate:
              description: >
                The date when the product expires and can't be subscribed to
                anymore, in `yyyy-mm-dd` format.
              format: date
              type: string
            EffectiveStartDate:
              description: >
                The date when the product becomes available and can be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              type: string
            Name:
              description: >
                The name of the product. This information is displayed in the
                product catalog pages in the web-based UI.
              maxLength: 100
              type: string
            ProductNumber:
              description: >
                The natural key of the product.


                **Values**: 
                  - leave null for automatically generated string
                  - an alphanumeric string of 100 characters or fewer

                **Note**: This field is only available if you set the
                `X-Zuora-WSDL-Version` request header to `133` or later.
              maxLength: 100
              type: string
            SKU:
              description: |
                The unique SKU for the product.

                **Values**: 
                  - leave null for automatically generated string
                  - an alphanumeric string of 50 characters or fewer
              maxLength: 50
              type: string
          required:
            - EffectiveEndDate
            - EffectiveStartDate
            - Name
          type: object
        - $ref: '#/components/schemas/ProductObjectNSFields'
        - $ref: '#/components/schemas/ProductObjectCustomFields'
      example:
        Name: SmartLearn Tablet
        EffectiveStartDate: '2024-01-01'
        EffectiveEndDate: '2034-01-01'
    ProxyCreateOrModifyResponse:
      properties:
        Id:
          description: ''
          type: string
        Success:
          description: ''
          type: boolean
      type: object
    ProxyBadRequestResponse:
      properties:
        errors:
          items:
            properties:
              code:
                description: Machine-readable error code identifying the failure type.
                type: string
              message:
                description: >-
                  Human-readable description of the error that provides more
                  context about what went wrong.
                type: string
            type: object
          type: array
        success:
          description: ''
          type: boolean
      type: object
    ProxyUnauthorizedResponse:
      properties:
        message:
          description: >
            Error message.


            If the error message is "Authentication error", ensure that the
            `Authorization` request header contains valid authentication
            credentials, then retry the request. See
            [Authentication](https://developer.zuora.com/docs/guides/authentication/)
            for more information.


            If the error message is "Failed to get user info", retry the
            request.
          type: string
      type: object
    ProxyGetProduct:
      allOf:
        - properties:
            AllowFeatureChanges:
              description: >
                Controls whether to allow your users to add or remove features
                while creating or amending a subscription.


                **Values**: true, false (default)
              type: boolean
            Category:
              description: >
                Category of the product. Used by Zuora Quotes Guided Product
                Selector.


                **Values**:
                  - Base Products
                  - Add On Services
                  - Miscellaneous Products
              maxLength: 100
              type: string
            CreatedById:
              description: >
                The automatically generated ID of the Zuora user who created the
                `Product` object.
              maxLength: 32
              type: string
            CreatedDate:
              description: |
                The date when the `Product` object was created.
              format: date-time
              type: string
            Description:
              description: |
                A description of the product. 
              maxLength: 500
              type: string
            EffectiveEndDate:
              description: >
                The date when the product expires and can't be subscribed to
                anymore, in `yyyy-mm-dd` format.
              format: date
              type: string
            EffectiveStartDate:
              description: >
                The date when the product becomes available and can be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              type: string
            Id:
              description: Object identifier.
              type: string
            Name:
              description: >
                The name of the product. This information is displayed in the
                product catalog pages in the web-based UI.
              maxLength: 100
              type: string
            SKU:
              description: |
                The unique SKU for the product.
              maxLength: 50
              type: string
            UpdatedById:
              description: |
                The ID of the last user to update the object.
              maxLength: 32
              type: string
            UpdatedDate:
              description: |
                The date when the object was last updated.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/ProductObjectNSFields'
        - $ref: '#/components/schemas/ProductObjectCustomFields'
    ProxyNoDataResponse:
      properties:
        done:
          description: ''
          type: boolean
        records:
          description: ''
          items:
            type: object
          type: array
        size:
          description: ''
          type: integer
      type: object
    ProxyModifyProduct:
      allOf:
        - properties:
            AllowFeatureChanges:
              description: >
                Controls whether to allow your users to add or remove features
                while creating or amending a subscription.


                **Values**: true, false (default)
              type: boolean
            Category:
              description: >
                Category of the product. Used by Zuora Quotes Guided Product
                Selector.


                **Values**:
                  - Base Products
                  - Add On Services
                  - Miscellaneous Products
              maxLength: 100
              type: string
            Description:
              description: |
                A description of the product. 
              maxLength: 500
              type: string
            EffectiveEndDate:
              description: >
                The date when the product expires and can't be subscribed to
                anymore, in `yyyy-mm-dd` format.
              format: date
              type: string
            EffectiveStartDate:
              description: >
                The date when the product becomes available and can be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              type: string
            Name:
              description: >
                The name of the product. This information is displayed in the
                product catalog pages in the web-based UI.
              maxLength: 100
              type: string
            ProductNumber:
              description: >
                The natural key of the product. 


                For existing Product objects that are created before this field
                is introduced, this field will be null. Use this field to
                specify a value for only these objects. Zuora also provides a
                tool to help you automatically backfill this field with tenant
                ID for your existing product catalog. If you want to use this
                backfill tool, contact [Zuora Global
                Support](https://support.zuora.com/).


                **Note**: This field is only available if you set the
                `X-Zuora-WSDL-Version` request header to `133` or later.
              maxLength: 100
              type: string
            SKU:
              description: |
                The unique SKU for the product.
              maxLength: 50
              type: string
          type: object
        - $ref: '#/components/schemas/ProductObjectNSFields'
        - $ref: '#/components/schemas/ProductObjectCustomFields'
      example:
        Description: >-
          Portable tablet designed for kids' learning with pre-installed
          educational apps and games.
    ProxyDeleteResponse:
      properties:
        id:
          description: ''
          type: string
        success:
          description: ''
          type: boolean
      type: object
    ProductFeatureObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Product Feature object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Product Feature object.
      title: productFeatureFieldsCustom
      type: object
    GetProductFeatureType:
      allOf:
        - properties:
            code:
              description: |
                Feature code, up to 255 characters long.
              type: string
            description:
              description: |
                Feature description.
              type: string
            id:
              description: |
                Feature ID.
              type: string
            name:
              description: |
                Feature name, up to 255 characters long.
              type: string
            status:
              description: ''
              type: string
          type: object
        - $ref: '#/components/schemas/ProductFeatureObjectCustomFields'
      title: productFeatures
    GETProductType:
      allOf:
        - properties:
            category:
              description: >
                Category of the product. Used by Zuora Quotes Guided Product
                Selector.


                Possible values are:
                  - Base Products
                  - Add On Services
                  - Miscellaneous Products
              type: string
            description:
              description: |
                Optional product description.
              type: string
            effectiveEndDate:
              description: >
                The date when the product expires and cannot be subscribed to
                anymore, as `yyyy-mm-dd`.
              format: date
              type: string
            effectiveStartDate:
              description: >
                The date when the product becomes available and can be
                subscribed to, as `yyyy-mm-dd`.
              format: date
              type: string
            id:
              description: |
                Product ID.
              type: string
            name:
              description: |
                Product name, up to 100 characters.
              type: string
            organizationLabels:
              description: >
                The organization(s) that the object belongs to. 


                Note: This field is available only when the Multi-Org feature is
                enabled.            
              items:
                properties:
                  organizationId:
                    description: |
                      The organization ID.
                    type: string
                  organizationName:
                    description: |
                      The organization name.
                    type: string
                type: object
              type: array
            productFeatures:
              description: >
                Container for one or more product features. Only available when
                the following settings are enabled:

                - The Entitlements feature in your tenant

                - The Enable Feature Specification in Product and Subscriptions
                setting in Settings > Billing
              items:
                $ref: '#/components/schemas/GetProductFeatureType'
              type: array
            productNumber:
              description: |
                The natural key of the product.
              type: string
            productRatePlans:
              description: >
                URL to retrieve information about all product rate plans of a
                specific product. For example,
                `/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan`. 


                **Note**: The value of this field is a URL only if you are on
                the latest API version of the Zuora API or set the
                `Zuora-Version` request header to `230.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).


                Zuora recommends that you use the latest behavior to retrieve
                product information.

                If you set this header to `229.0` or earlier, the value of this
                field is an array of product rate plan details. 
              format: URL
              type: string
            sku:
              description: |
                Unique product SKU, up to 50 characters.
              type: string
            tags:
              description: ''
              type: string
          type: object
        - $ref: '#/components/schemas/ProductObjectNSFields'
        - $ref: '#/components/schemas/ProductObjectCustomFields'
      title: products
    GETCatalogType:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        products:
          description: |
            Container for one or more products:
          items:
            $ref: '#/components/schemas/GETProductType'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    ErrorResponse:
      example:
        reasons:
          - code: ObjectNotFound
            message: >-
              Notification definition with id 6e569e1e05f040eda51a927b140c0ac1
              does not exist
      properties:
        reasons:
          items:
            properties:
              code:
                description: |
                  The error code of response.
                type: string
              message:
                description: The detail information of the error response
                type: string
            type: object
          type: array
      type: object
    CommonResponse:
      properties:
        processId:
          description: |
            The ID of the process that handles the operation.
          type: string
        reasons:
          description: >
            The container of the error code and message. This field is available
            only if the `success` field is `false`.
          items:
            properties:
              code:
                description: |
                  The error code of response.
                type: string
              message:
                description: |
                  The detail information of the error response
                type: string
            type: object
          type: array
        requestId:
          description: |
            Unique identifier of the request.
          format: uuid
          maxLength: 36
          minLength: 36
          type: string
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    GETCatalogGroupProductRatePlanResponse:
      properties:
        description:
          description: |
            The description of the product rate plan.
          type: string
        effectiveEndDate:
          description: |
            The effective end Date of the product rate plan.
          type: string
        effectiveStartDate:
          description: |
            The effective start date of the product rate plan.
          type: string
        grade:
          description: |
            The grade of the product rate plan.
          type: number
        id:
          description: |
            The ID of the product rate plan.
          type: string
        name:
          description: |
            The name of the product rate plan.
          type: string
        organizationLabels:
          description: >
            The organization(s) that the object belongs to. 


            Note: This field is available only when the Multi-Org feature is
            enabled.            
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        status:
          description: |
            The status of the product rate plan.
          enum:
            - Active
            - Expired
            - NotStarted
          type: string
      title: productRatePlans
      type: object
    CatalogGroupResponse:
      properties:
        catalogGroupNumber:
          description: >
            The automatically generated number of the catalog group with the CG-
            perfix. For example, CG-00000001.
          type: string
        description:
          description: |
            The description of the catalog group.
          type: string
        id:
          description: |
            The ID of the catalog group.
          type: string
        name:
          description: |
            The name of the catalog group.
          type: string
        productRatePlans:
          description: |
            The list of product rate plans in the catalog group.
          items:
            $ref: '#/components/schemas/GETCatalogGroupProductRatePlanResponse'
          type: array
        type:
          description: |
            The type of the catalog group.
          enum:
            - Grading
            - Display
          type: string
      title: catalogGroups
      type: object
    ListAllCatalogGroupsResponse:
      properties:
        catalogGroups:
          description: |
            The list of catalog groups that are retrieved..
          items:
            $ref: '#/components/schemas/CatalogGroupResponse'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
      type: object
    POSTorPUTCatalogGroupAddProductRatePlan:
      allOf:
        - properties:
            grade:
              description: >
                The grade that is assigned for the product rate plan. The value
                of this field must be a positive integer. The greater the value,
                the higher the grade.


                A product rate plan to be added to a Grading catalog group must
                have one grade. You can specify a grade for a product rate plan
                in this request or update the product rate plan individually. 
              type: number
            id:
              description: |
                The unique ID of the product rate plan.
              type: string
          type: object
      example:
        grade: 3
        id: 4028e5ab7f1b600c017f1b787d5d01cf
      title: productRatePlans
    POSTCatalogGroupRequest:
      allOf:
        - properties:
            description:
              description: |
                The description of the catalog group.
              type: string
            name:
              description: |
                The unique name of the catalog group.
              type: string
            productRatePlans:
              description: |
                The list of product rate plans to be added to the catalog group.
              items:
                $ref: '#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan'
              type: array
            type:
              default: Grading
              description: |
                The type of the catalog group. 
              enum:
                - Grading
                - Display
              type: string
          type: object
      example:
        description: description
        name: Example
        productRatePlans:
          - grade: 3
            id: 4028e5ab7f1b600c017f1b787d5d01cf
          - grade: 2
            id: 4028e5ab7f1b600c017f1b787d5d01ac
        type: Grading
    PUTCatalogGroupRemoveProductRatePlan:
      allOf:
        - properties:
            id:
              description: >
                The unique ID of the product rate plan to be removed from the
                catalog group.
              type: string
          type: object
      example:
        id: 4028e5ab7f1b600c017f1b787d5d01cf
      title: remove
    PUTCatalogGroup:
      allOf:
        - properties:
            add:
              description: |
                The list of product rate plans to be added to the catalog group.
              items:
                $ref: '#/components/schemas/POSTorPUTCatalogGroupAddProductRatePlan'
              title: add
              type: array
            description:
              description: |
                The description of the catalog group.
              type: string
            name:
              description: |
                The unique name of the catalog group.
              type: string
            remove:
              description: >
                The list of product rate plans to be removed from the catalog
                group.
              items:
                $ref: '#/components/schemas/PUTCatalogGroupRemoveProductRatePlan'
              type: array
          type: object
      example:
        add:
          - grade: 3
            id: 4028e5ab7f1b600c017f1b787d5d01cf
          - grade: 2
            id: 4028e5ab7f1b600c017f1b787d5d01ac
        description: description
        name: name
        remove:
          - id: 4028e5ab7f1b600c017f1b787d5d01cf
          - id: 4028e5ab7f1b600c017f1b787d5d01ac
    GETProductRatePlanChargeDeliverySchedule:
      description: >
        The delivery schedule information of this charge. Only when this charge
        is using Delivery Pricing charge model
      properties:
        frequency:
          description: |
            The frequency of the delivery. Only supports weekly now
          enum:
            - Weekly
          type: string
        friday:
          description: |
            The flag to indicate should the delivery happen on Friday
          type: boolean
        monday:
          description: |
            The flag to indicate should the delivery happen on Monday
          type: boolean
        saturday:
          description: |
            The flag to indicate should the delivery happen on Saturday
          type: boolean
        sunday:
          description: |
            The flag to indicate should the delivery happen on Sunday
          type: boolean
        thursday:
          description: |
            The flag to indicate should the delivery happen on Thursday
          type: boolean
        tuesday:
          description: |
            The flag to indicate should the delivery happen on Tuesday
          type: boolean
        wendesday:
          description: |
            The flag to indicate should the delivery happen on Wendesday
          type: boolean
      title: deliverySchedule
      type: object
    GETProductRatePlanChargePricingTierType:
      properties:
        endingUnit:
          description: |
            Decimal defining end of tier range.
          format: decimal
          type: string
        price:
          description: >
            The decimal value of the tiered charge model. If the charge model is
            not a tiered type then this price field will be null and the price
            field directly under the productRatePlanCharges applies.
          format: decimal
          type: string
        priceFormat:
          description: |
            Tier price format.

            Allowed values:
            - flat fee 
            - per unit
          type: string
        startingUnit:
          description: |
            Decimal defining start of tier range.
          format: decimal
          type: string
        tier:
          description: |
            Unique number of the tier.
          format: int64
          type: integer
      title: tiers
      type: object
    GETProductRatePlanChargePricingType:
      properties:
        currency:
          description: |
            Currency used by the charge model. For example: USD or EUR
          type: string
        discountAmount:
          description: >
            Value subtracted from price in currency specified. Used only when
            the charge model is DiscountFixedAmount.
          format: decimal
          type: string
        discountPercentage:
          description: >
            Percent discount applied to the price. Used only when the charge
            model is DiscountPercentage.
          format: decimal
          type: string
        includedUnits:
          description: >
            Specifies the number of units in the base set of units when the
            charge model is Overage.
          format: decimal
          type: string
        overagePrice:
          description: >
            Price per unit when base set of units is exceeded. Used only when
            charge model is Overage or Tiered with Overage.
          format: decimal
          type: string
        price:
          description: |
            The decimal value that applies when the charge model is not tiered
          format: decimal
          type: string
        tiers:
          description: >
            Container for one or many defined tier ranges with distinct
            pricing.  Applies when model is `Tiered`, `TieredWithOverage`, or
            `Volume`
          items:
            $ref: '#/components/schemas/GETProductRatePlanChargePricingTierType'
          type: array
      title: pricing
      type: object
    GETProductDiscountApplyDetailsType:
      properties:
        appliedProductRatePlanChargeId:
          description: >
            The ID of the product rate plan charge that the discount product
            rate plan charge applies to.
          type: string
        appliedProductRatePlanId:
          description: >
            The ID of the product rate plan that the discount product rate plan
            charge applies to.
          type: string
      title: productDiscountApplyDetails
      type: object
    ProductRatePlanChargeObjectNSFields:
      description: >
        Container for Product Rate Plan Charge fields provided by the [Zuora
        Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        Class__NS:
          description: >
            Class associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        DeferredRevAccount__NS:
          description: >
            Deferrred revenue account associated with the corresponding item in
            NetSuite. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Department__NS:
          description: >
            Department associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IncludeChildren__NS:
          description: >
            Specifies whether the corresponding item in NetSuite is visible
            under child subsidiaries. Only available if you have installed the
            [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - 'Yes'
            - 'No'
          type: string
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the product rate plan charge's synchronization with
            NetSuite. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        ItemType__NS:
          description: >
            Type of item that is created in NetSuite for the product rate plan
            charge. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - Inventory
            - Non Inventory
            - Service
          type: string
        Location__NS:
          description: >
            Location associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        RecognizedRevAccount__NS:
          description: >
            Recognized revenue account associated with the corresponding item in
            NetSuite. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        RevRecEnd__NS:
          description: >
            End date condition of the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - Charge Period Start
            - Rev Rec Trigger Date
            - Use NetSuite Rev Rec Template
          type: string
        RevRecStart__NS:
          description: >
            Start date condition of the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - Charge Period Start
            - Rev Rec Trigger Date
            - Use NetSuite Rev Rec Template
          type: string
        RevRecTemplateType__NS:
          description: >
            Only available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Subsidiary__NS:
          description: >
            Subsidiary associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the product rate plan charge was synchronized with
            NetSuite. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: productRatePlanChargeFieldsNS
      type: object
    ProductRatePlanChargeObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Product Rate Plan Charge object. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Product Rate Plan Charge object.
      title: productRatePlanChargeFieldsCustom
      type: object
    GETProductRatePlanChargeType:
      allOf:
        - properties:
            applyDiscountTo:
              description: >
                Specifies where (to what charge type) the discount will be
                applied. These field values are case-sensitive.


                Permissible values:

                - RECURRING

                - USAGE

                - ONETIMERECURRING

                - ONETIMEUSAGE

                - RECURRINGUSAGE

                - ONETIMERECURRINGUSAGE
              type: string
            billingDay:
              description: >
                The bill cycle day (BCD) for the charge. The BCD determines
                which day of the month or week the customer is billed. The BCD
                value in the account can override the BCD in this object.
              type: string
            billingPeriod:
              description: >
                The billing period for the charge. The start day of the billing
                period is also called the bill cycle day (BCD).


                Values:

                - Month

                - Quarter

                - Annual

                - Semi_Annual

                - Specific Months

                - Week

                - Specific_Weeks
              type: string
            billingPeriodAlignment:
              description: >
                Aligns charges within the same subscription if multiple charges
                begin on different dates.


                Possible values:

                - AlignToCharge

                - AlignToSubscriptionStart

                - AlignToTermStart
              type: string
            billingTiming:
              description: >
                The billing timing for the charge. You can choose to bill for
                charges in advance or in arrears.


                Values:

                - In Advance

                - In Arrears


                **Note:** This feature is in Limited Availability. If you wish
                to have access to the feature, submit a request at [Zuora Global
                Support](https://support.zuora.com). 
              type: string
            chargeFunction:
              description: >
                **Note**: This field is only available if you have the Prepaid
                with Drawdown or Minimum Commitment feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `141` or higher. Otherwise, an error occurs.


                This field defines what type of charge it is:

                * Standard: Normal charge with no Prepayment or Commitment or
                Drawdown.

                * Prepayment: For recurring charges. Unit or currency based
                prepaid charge.

                * CommitmentTrueUp: For recurring charges. Currency based
                minimum commitment charge.

                * Drawdown: For usage charges. Drawdown from prepaid funds.

                * DrawdownAndCreditCommitment: For usage charges. Drawdown from
                prepaid funds and then credit to minimum commitment funds.

                * CreditCommitment: For usage charges. Credit to minimum
                commitment funds.
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            commitmentType:
              description: >
                **Note**: This field is only available if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
                target="_blank">Prepaid with Drawdown</a> feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `133` or higher. Otherwise, an error occurs. 


                This field defines the type of commitment. A prepaid charge can
                be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge
                can only be `CURRENCY` type. For topup(recurring or one-time)
                charges, this field indicates what type of funds are created. 

                * If UNIT, it will create a fund with given prepaidUom.

                * If CURRENCY, it will create a fund with the currency amount
                calculated in list price.
                  
                For drawdown(usage) charges, this field indicates what type of
                funds are drawdown from that created from topup charges.
              enum:
                - UNIT
                - CURRENCY
              type: string
            chargeModelConfigurations:
              description: >-
                This field is for Zuora Internal Use only. See the **pricing**
                field for the same information as this field.
              type: object
            creditOption:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The way to calculate credit. See [Credit
                Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
                for more information. 
              enum:
                - TimeBased
                - ConsumptionBased
                - FullCreditBack
              type: string
            defaultQuantity:
              description: >
                The default quantity of units.  This field is required if you
                use a per-unit charge model.
              format: decimal
              type: string
              nullable: true
            deliverySchedule:
              $ref: '#/components/schemas/GETProductRatePlanChargeDeliverySchedule'
            description:
              description: |
                Usually a brief line item summary of the Rate Plan Charge.
              type: string
            discountClass:
              description: >
                The class that the discount belongs to. The discount class
                defines the order in which discount product rate plan charges
                are applied.


                For more information, see [Manage Discount
                Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).
              type: string
              nullable: true
            discountLevel:
              description: |
                The level of the discount. 

                Values:
                - RatePlan
                - Subscription
                - Account
              type: string
              nullable: true
            drawdownRate:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The [conversion
                rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
                between Usage UOM and Drawdown UOM for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
                Must be a positive number (>0).
              type: number
            drawdownUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                Unit of measurement for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
              type: string
            endDateCondition:
              description: >
                Defines when the charge ends after the charge trigger date. If
                the subscription ends before the charge end date, the charge
                ends when the subscription ends. But if the subscription end
                date is subsequently changed through a Renewal, or Terms and
                Conditions amendment, the charge will end on the charge end
                date.


                Values:

                - Subscription_End

                - Fixed_Period
              type: string
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the related invoice items, invoice item
                adjustments, credit memo items, and debit memo items from
                revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            excludeItemBookingFromRevenueAccounting:
              description: >
                The flag to exclude the related rate plan charges and order line
                items from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            financeInformation:
              description: |
                Container for finance information of a rate plan charge.
              properties:
                adjustmentLiabilityAccountingCode:
                  description: >
                    The accounting code for adjustment liability. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled. 
                  type: string
                adjustmentLiabilityAccountingCodeType:
                  description: >
                    The type associated with the adjustment liability accounting
                    code. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled.
                  type: string
                adjustmentRevenueAccountingCode:
                  description: >
                    The accounting code for adjustment revenue. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled. 
                  type: string
                adjustmentRevenueAccountingCodeType:
                  description: >
                    The type associated with the adjustment revenue accounting
                    code. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled.
                  type: string
                contractAssetAccountingCode:
                  description: >
                    The accounting code for contract asset. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled. 
                  type: string
                contractAssetAccountingCodeType:
                  description: >
                    The type associated with the contract asset accounting
                    code. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled.
                  type: string
                contractLiabilityAccountingCode:
                  description: >
                    The accounting code for contract liability. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled. 
                  type: string
                contractLiabilityAccountingCodeType:
                  description: >
                    The type associated with the contract liability accounting
                    code. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled.
                  type: string
                contractRecognizedRevenueAccountingCode:
                  description: >
                    The accounting code for contract recognized revenue. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled. 
                  type: string
                contractRecognizedRevenueAccountingCodeType:
                  description: >
                    The type associated with the contract recognized revenue
                    accounting code. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled.
                  type: string
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for deferred revenue, such as Monthly
                    Recurring Liability. 
                  type: string
                deferredRevenueAccountingCodeType:
                  description: >
                    The type associated with the deferred revenue accounting
                    code, such as Deferred Revenue. 
                  type: string
                  nullable: true
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for recognized revenue, such as Monthly
                    Recurring Charges or Overage Charges. 
                  type: string
                recognizedRevenueAccountingCodeType:
                  description: >
                    The type associated with the recognized revenue accounting
                    code, such as Sales Revenue or Sales Discount. 
                  type: string
                  nullable: true
                unbilledReceivablesAccountingCode:
                  description: >
                    The accounting code for unbilled receivables. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled. 
                  type: string
                unbilledReceivablesAccountingCodeType:
                  description: >
                    The type associated with the unbilled receivables accounting
                    code. 


                    **Note**: This field is only available if you have the
                    RevPro Integration feature enabled.
                  type: string
              title: financeInformation
              type: object
            formula:
              description: >
                The pricing formula to calculate the actual rating amount for
                each usage record.


                This field is only available for the usage-based charges that
                use the Multi-Attribute Pricing charge model. The charge model
                is available for customers with Enterprise and Nine editions by
                default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.
              type: string
            id:
              description: |
                Unique product rate-plan charge ID.
              type: string
            includedUnits:
              description: >
                Specifies the number of units in the base set of units when the
                charge model is Overage.
              format: decimal
              type: string
            isAllocationEligible:
              description: >
                This field is used to identify if the charge segment is
                allocation

                eligible in revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            isPrepaid:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                Indicates whether this charge is a prepayment (topup) charge or
                a drawdown charge. Values: `true` or `false`.
              type: boolean
            isRollover:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The value is either "true" or "false". It determines whether the
                rollover fields are needed.
              type: boolean
            isStackedDiscount:
              description: >
                **Note**: This field is only applicable to the Discount -
                Percentage charge model.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 130 or higher. Otherwise, an error occurs.


                This field indicates whether the discount is to be calculated as
                stacked discount. Possible values are as follows:


                - `true`: This is a stacked discount, which should be calculated
                by stacking with other discounts.


                - `false`: This is not a stacked discount, which should be
                calculated in sequence with other discounts.


                For more information, see [Stacked
                discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
              type: boolean
            isUnbilled:
              description: >
                This field is used to dictate how to perform the accounting
                during

                revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            listPriceBase:
              description: |
                The list price base for the product rate plan charge.

                This field is only applicable for recurring charges.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            maxQuantity:
              description: >
                Specifies the maximum number of units for this charge. Use this
                field and the `minQuantity` field to create a range of units
                allowed in a product rate plan charge.
              format: decimal
              type: string
            minQuantity:
              description: >
                Specifies the minimum number of units for this charge. Use this
                field and the `maxQuantity` field to create a range of units
                allowed in a product rate plan charge.
              format: decimal
              type: string
            model:
              description: >
                Charge model which determines how charges are calculated. Charge
                models must be individually activated in Zuora Billing
                administration. 


                Possible values are:

                - `FlatFee`

                - `PerUnit`

                - `Overage`

                - `Volume`

                - `Tiered`

                - `TieredWithOverage`

                - `DiscountFixedAmount`

                - `DiscountPercentage`

                - `Delivery` (available only if you have the Delivery Pricing
                charge model enabled)

                - `MultiAttributePricing` (available only if you have the
                Multi-Attribute Pricing charge model enabled. The charge model
                is available for customers with Enterprise and Nine editions by
                default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.)

                - `PreratedPerUnit` (available only if you have the Pre-rated
                Per Unit Pricing charge model enabled. The charge model is
                available for customers with Enterprise and Nine editions by
                default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.)

                - `PreratedPricing` (available only if you have the Pre-rated
                Pricing charge model enabled. The charge model is available for
                customers with Enterprise and Nine editions by default. If you
                are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.)

                - `HighWatermarkVolumePricing` (available only if you have the
                High Water Mark Volume Pricing charge model enabled. The charge
                model is available for customers with Enterprise and Nine
                editions by default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.)

                - `HighWatermarkTieredPricing` (available only if you have the
                High Water Mark Tiered Pricing charge model enabled. The charge
                model is available for customers with Enterprise and Nine
                editions by default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.)


                The value of the `pricing` field contains details about these
                charge models and the value of `pricingSummary` field contains
                their associated pricing summary values.
              type: string
            name:
              description: >
                Name of the product rate-plan charge. (Not required to be
                unique.)
              type: string
            numberOfPeriods:
              description: >
                Specifies the number of periods to use when calculating charges
                in an overage smoothing charge model. This field is ued when
                overage smoothing model is `RollingWindow` or `Rollover`.
              format: int64
              type: integer
              nullable: true
            overageCalculationOption:
              description: |
                Value specifies when to calculate overage charges.

                Values:
                - EndOfSmoothingPeriod
                - PerBillingPeriod
                - null
              type: string
              nullable: true
            overageUnusedUnitsCreditOption:
              description: >
                Determines whether to credit the customer with unused units of
                usage.


                Values:

                - NoCredit

                - CreditBySpecificRate
              type: string
              nullable: true
            prepaidOperationType:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The type of this charge. It is either a prepayment (topup)
                charge or a drawdown charge. 
              enum:
                - topup
                - drawdown
                - null
              type: string
              nullable: true
            prepaidQuantity:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The number of units included in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
                Must be a positive number (>0).
              type: number
              nullable: true
            prepaidTotalQuantity:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The total amount of units that end customers can use during a
                validity period when they subscribe to a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              type: number
              nullable: true
            prepaidUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                Unit of measurement for a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              type: string
              nullable: true
            prepayPeriods:
              description: >
                The number of periods to which prepayment is set. 


                **Note:** This field is only available if you already have the
                prepayment feature enabled. The prepayment feature is deprecated
                and available only for backward compatibility. Zuora does not
                support enabling this feature anymore.
              format: int64
              type: integer
              nullable: true
            priceChangeOption:
              description: >
                Applies an automatic price change when a termed subscription is
                renewed and the following applies:


                1. AutomatedPriceChange setting is on

                2. Charge type is not one-time

                3. Charge model is not discount fixed amount


                Values:

                - NoChange (default)

                - SpecificPercentageValue

                - UseLatestProductCatalogPricing
              type: string
              nullable: true
            priceIncreasePercentage:
              description: >
                Specifies the percentage to increase or decrease the price of a
                termed subscription's renewal. Use this field if you set the
                `PriceChangeOption` value to `SpecificPercentageValue`.


                1. AutomatedPriceChange setting is on

                2. Charge type is not one-time

                3. Charge model is not discount fixed amount


                Values: a decimal between -100 and 100
              format: decimal
              type: string
              nullable: true
            pricing:
              description: >
                One or more price charge models with attributes that further
                describe the model. 

                Some attributes show as null values when not applicable.
              items:
                $ref: '#/components/schemas/GETProductRatePlanChargePricingType'
              type: array
            pricingSummary:
              description: >
                A concise description of the charge model and pricing that is
                suitable to show to your customers. 

                When the rate plan charge model is `Tiered` and multi-currency
                is enabled, this field includes an array of string of each
                currency, and each string of currency includes tier price
                description separated by comma.


                When the rate plan charge model is `DiscountPercentage`, this
                field does not include currency.


                When the rate plan charge model is not `DiscountPercentage`,
                this field includes the currency.


                For the following charge models, the value of this field is an
                empty string:

                - Multi-Attribute Pricing

                - High Water Mark Tiered Pricing

                - High Water Mark Volume Pricing

                - Pre-Rated Per Unit Pricing

                - Pre-Rated Pricing


                The charge models are available for customers with Enterprise
                and Nine editions by default. If you are a Growth customer, see
                [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.
              items:
                type: string
              type: array
            productChargeDefinitions:
              description: |
                A link to retrieve product charge definitions of this charge.
              type: string
            productDiscountApplyDetails:
              description: >
                Container for the application details about a discount product
                rate plan charge. 


                Only discount product rate plan charges have values in this
                field.
              items:
                $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
              type: array
            productRatePlanChargeNumber:
              description: |
                The natural key of the product rate plan charge.
              type: string
            ratingGroup:
              description: >
                Specifies a rating group based on which usage records are rated.


                Possible values:


                - `ByBillingPeriod` (default): The rating is based on all the
                usages in a billing period.

                - `ByUsageStartDate`: The rating is based on all the usages on
                the same usage start date. 

                - `ByUsageRecord`: The rating is based on each usage record.

                - `ByUsageUpload`: The rating is based on all the  usages in a
                uploaded usage file (`.xls` or `.csv`).

                - `ByGroupId`: The rating is based on all the usages in a custom
                group.


                **Note:** 

                - The `ByBillingPeriod` value can be applied for all charge
                models. 

                - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload`
                values can only be applied for per unit, volume pricing, and
                tiered pricing charge models. 

                - The `ByGroupId` value is only available if you have the Active
                Rating feature enabled.

                - Use this field only for Usage charges. One-Time Charges and
                Recurring Charges return `NULL`.
              type: string
              nullable: true
            revRecCode:
              description: >
                Associates this product rate plan charge with a specific revenue
                recognition code. The value is a valid revenue recognition code.
              maxLength: 70
              type: string
              nullable: true
            revRecTriggerCondition:
              description: |
                Specifies when revenue recognition begins.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              maxLength: 22
              type: string
              nullable: true
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.
              type: string
            rolloverApply:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                This field defines the priority of rollover, which is either
                first or last.
              enum:
                - ApplyFirst
                - ApplyLast
              type: string
            rolloverPeriodLength:
              default: null
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with

                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

                feature enabled.


                Use this field when you want to set the rollover fund's period
                length shorter than the prepayment charge's validity period. In
                this case, you must set the `rolloverPeriods` field to 1. For
                example, you can define the rollover fund's period length as 5
                months, shorter than the prepayment charge's validity period: a
                year.
              type: integer
            rolloverPeriods:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                This field defines the number of rollover periods, it is
                restricted to 3.
              type: number
            smoothingModel:
              description: >
                Specifies the smoothing model for an overage smoothing charge
                model or an tiered with overage model, which is an advanced type
                of a usage model that avoids spikes in usage charges. If a
                customer's usage spikes in a single period, then an overage
                smoothing model eases overage charges by considering usage and
                multiple periods.


                One of the following values shows which smoothing model will be
                applied to the charge when `Overage` or `Tiered with Overage` is
                used:


                - `RollingWindow` considers a number of periods to smooth usage.
                The rolling window starts and increments forward based on
                billing frequency. When allowed usage is met, then period resets
                and a new window begins.

                - `Rollover` considers a fixed number of periods before
                calculating usage. The net balance at the end of a period is
                unused usage, which is carried over to the next period's
                balance.
              type: string
              nullable: true
            specificBillingPeriod:
              description: >
                When the billing period is set to `Specific` Months then this
                positive integer reflects the number of months for billing
                period charges.
              format: int64
              type: integer
              nullable: true
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. The
                value of this field is `null` if you do not set the value of the
                `listPriceBase` field to `Per_Specific_Months`.
              type: integer
              nullable: true
            taxCode:
              description: |
                Specifies the tax code for taxation rules; used by Zuora Tax.
              type: string
            taxMode:
              description: >
                Specifies how to define taxation for the charge; used by Zuora
                Tax.
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            taxable:
              description: >
                Specifies whether the charge is taxable; used by Zuora Tax.
                Possible values are:`true`, `false`.
              type: boolean
            triggerEvent:
              description: >
                Specifies when to start billing the customer for the charge.


                Values: one of the following:

                - `ContractEffective` is the date when the subscription's
                contract goes into effect and the charge is ready to be billed.

                - `ServiceActivation` is the date when the services or products
                for a subscription have been activated and the customers have
                access.

                - `CustomerAcceptance` is when the customer accepts the services
                or products for a subscription. 

                - `SpecificDate` is the date specified.
              type: string
            type:
              description: >
                The type of charge. Possible values are: `OneTime`, `Recurring`,
                `Usage`.
              type: string
            uom:
              description: >
                Describes the Units of Measure (uom) configured in **Settings >
                Billing** for the productRatePlanCharges.


                Values: `Each`, `License`, `Seat`, or `null`
              type: string
              nullable: true
            upToPeriods:
              description: >
                Specifies the length of the period during which the charge is
                active. If this period ends before the subscription ends, the
                charge ends when this period ends.

                If the subscription end date is subsequently changed through a
                Renewal, or Terms and Conditions amendment, the charge end date
                will change accordingly up to the original period end.
              format: int64
              type: integer
              nullable: true
            upToPeriodsType:
              description: |
                The period type used to define when the charge ends.
              enum:
                - Billing_Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            usageRecordRatingOption:
              description: >
                Determines how Zuora processes usage records for per-unit usage
                charges. 
              type: string
              nullable: true
            useDiscountSpecificAccountingCode:
              description: >
                Determines whether to define a new accounting code for the new
                discount charge.

                Values: `true`, `false`
              type: boolean
              nullable: true
            useTenantDefaultForPriceChange:
              description: >
                Shows the tenant-level percentage uplift value for an automatic
                price change to a termed subscription's renewal. You set the
                tenant uplift value in the web-based UI: **Settings > Billing >
                Define Default Subscription Settings**.


                Values: `true`, `false`
              type: boolean
            validityPeriodType:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The period in which the prepayment units are valid to use as
                defined in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              enum:
                - SUBSCRIPTION_TERM
                - ANNUAL
                - SEMI_ANNUAL
                - QUARTER
                - MONTH
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
      title: productRatePlanCharges
    ProductRatePlanObjectNSFields:
      description: >
        Container for Product Rate Plan fields provided by the [Zuora Connector
        for NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        BillingPeriod__NS:
          description: >
            Billing period associated with the corresponding item in NetSuite.
            Only available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - Monthly
            - Quarterly
            - Annual
            - Semi-Annual
          type: string
        Class__NS:
          description: >
            Class associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Department__NS:
          description: >
            Department associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IncludeChildren__NS:
          description: >
            Specifies whether the corresponding item in NetSuite is visible
            under child subsidiaries. Only available if you have installed the
            [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - 'Yes'
            - 'No'
          type: string
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the product rate plan's synchronization with NetSuite.
            Only available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        ItemType__NS:
          description: >
            Type of item that is created in NetSuite for the product rate plan.
            Only available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - Inventory
            - Non Inventory
            - Service
          type: string
        Location__NS:
          description: >
            Location associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        MultiCurrencyPrice__NS:
          description: >
            Multi-currency price associated with the corresponding item in
            NetSuite. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Price__NS:
          description: >
            Price associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Subsidiary__NS:
          description: >
            Subsidiary associated with the corresponding item in NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the product rate plan was synchronized with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: productRatePlanFieldsNS
      type: object
    ProductRatePlanObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Product Rate Plan object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Product Rate Plan object.
      title: ProductRatePlanCustomFields
      type: object
    GETProductRatePlanType:
      allOf:
        - properties:
            description:
              description: |
                Rate plan description.
              type: string
            effectiveEndDate:
              description: >
                Final date the rate plan is active, as `yyyy-mm-dd`. After this
                date, the rate plan status is `Expired`.
              format: date
              type: string
            effectiveStartDate:
              description: >
                First date the rate plan is active (i.e., available to be
                subscribed to), as `yyyy-mm-dd`.  Before this date, the status
                is `NotStarted`.
              format: date
              type: string
            grade:
              description: >
                The grade of the product rate plan.


                **Note**: This field is in the **Early Adopter** phase. We are
                actively soliciting feedback from a small set of early adopters
                before releasing it as generally available. If you want to join
                this early adopter program, submit a request at [Zuora Global
                Support](http://support.zuora.com/).
              type: number
            id:
              description: |
                Unique product rate-plan ID.
              type: string
            name:
              description: >
                Name of the product rate-plan charge. (Not required to be
                unique.)
              type: string
            productRatePlanCharges:
              description: |
                Field attributes describing the product rate plan charges:
              items:
                $ref: '#/components/schemas/GETProductRatePlanChargeType'
              type: array
            productRatePlanNumber:
              description: |
                The natural key of the product rate plan.  
              type: string
            status:
              description: |
                The status of the product rate plan.
              enum:
                - Active
                - Expired
                - NotStarted
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
      title: productRatePlans
    GETProductRatePlansResponse:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        productRatePlans:
          description: |
            Container for one or more products.
          items:
            $ref: '#/components/schemas/GETProductRatePlanType'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETProductRatePlanWithExternalIdResponse:
      properties:
        ExternalIdSourceSystem:
          description: >
            The combination of `externallyManagedPlanId` and
            `externalIdSourceSystem` is the unique identifier for the rate plan
            purchased on a third-party store. This field is used to represent a
            subscription rate plan created through third-party stores.
          type: string
        description:
          description: |
            The short description of the product rate plan.
          type: string
        effectiveEndDate:
          description: |
            The end date of the product rate plan.
          format: date
          type: string
        effectiveStartDate:
          description: |
            The start date of the product rate plan.
          format: date
          type: string
        externallyManagedPlanIds:
          description: >
            The unique identifier for the product rate plan in a third-party
            store. This field is used to represent a rate plan created through
            third-party stores.
          items:
            type: string
          type: array
        grade:
          description: >
            The grade of the product rate plan.


            **Note**: This field is in the **Early Adopter** phase. We are
            actively soliciting feedback from a small set of early adopters
            before releasing it as generally available. If you want to join this
            early adopter program, submit a request at [Zuora Global
            Support](http://support.zuora.com/).
          type: number
        id:
          description: |
            The unique product rate plan ID.
          type: string
        name:
          description: |
            The name of the product rate plan.
          type: string
        organizationLabels:
          description: >
            The organization(s) that the object belongs to. 


            Note: This field is available only when the Multi-Org feature is
            enabled.            
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        productRatePlanNumber:
          description: |
            The natural key of the product rate plan.
          type: string
        status:
          description: |
            The status of the product rate plan. 
          enum:
            - Active
            - Expired
            - NotStarted
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETProductRatePlanWithExternalIdMultiResponse:
      type: object
      properties:
        productRatePlans:
          description: >
            A list of product rate plans associated with the product. 

            Each rate plan defines a set of charges and billing conditions that
            determine how a product is priced and billed.
          type: array
          items:
            type: object
            properties:
              id:
                description: |
                  The unique product rate plan ID.
                type: string
              status:
                description: |
                  The status of the product rate plan. 
                enum:
                  - Active
                  - Expired
                  - NotStarted
                type: string
              name:
                description: |
                  The name of the product rate plan.
                type: string
              description:
                description: |
                  The short description of the product rate plan.
                type: string
              effectiveStartDate:
                description: |
                  The start date of the product rate plan.
                format: date
                type: string
              effectiveEndDate:
                description: |
                  The end date of the product rate plan.
                format: date
                type: string
              externalIdSourceSystem:
                description: >
                  The combination of `externallyManagedPlanId` and
                  `externalIdSourceSystem` is the unique identifier for the rate
                  plan purchased on a third-party store. This field is used to
                  represent a subscription rate plan created through third-party
                  stores.
                type: string
              externallyManagedPlanIds:
                description: >
                  The unique identifier for the product rate plan in a
                  third-party store. This field is used to represent a rate plan
                  created through third-party stores.
                type: array
                items:
                  type: string
              productRatePlanNumber:
                description: >
                  A unique, human-readable identifier for the product rate plan.
                  This value is typically auto-generated by Zuora but can also
                  be set explicitly by the customer.

                  This field is required and should never be null.
                type: string
              grade:
                description: >
                  The grade of the product rate plan.


                  **Note**: This field is in the **Early Adopter** phase. We are
                  actively soliciting feedback from a small set of early
                  adopters before releasing it as generally available. If you
                  want to join this early adopter program, submit a request at
                  [Zuora Global Support](http://support.zuora.com/).
                type: number
              organizationLabels:
                description: >
                  The organization(s) that the object belongs to. 


                  Note: This field is available only when the Multi-Org feature
                  is enabled.            
                items:
                  properties:
                    organizationId:
                      description: |
                        The organization ID.
                      type: string
                    organizationName:
                      description: |
                        The organization name.
                      type: string
                  type: object
                type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
    ProxyCreateProductRatePlan:
      allOf:
        - properties:
            ActiveCurrencies:
              description: >
                A list of 3-letter currency codes representing active currencies
                for the product rate plan. Use a comma to separate each currency
                code.


                When creating a product rate plan, you can use this field to
                specify default currency and at most four other active
                currencies.
              items:
                type: string
              type: array
            Description:
              description: |
                A description of the product rate plan.
              maxLength: 500
              type: string
            EffectiveEndDate:
              description: >
                The date when the product rate plan expires and can't be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              maxLength: 29
              type: string
            EffectiveStartDate:
              description: >
                The date when the product rate plan becomes available and can be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              maxLength: 29
              type: string
            ExternalIdSourceSystem:
              description: >
                The ID of the external source system.


                **Note:** To use this field, you must set the
                `X-Zuora-WSDL-Version` request header to `130` or later.
                Otherwise, an error occurs.
              type: string
            ExternalRatePlanIds:
              description: >
                An external ID of the product rate plan to be added. You can use
                this field to specify a product rate plan that is imported from
                an external system. 

                If you want to update to multiple values, use a comma separated
                string.


                **Note:** To use this field, you must set the
                `X-Zuora-WSDL-Version` request header to `130` or later.
                Otherwise, an error occurs.
              type: string
            Grade:
              description: >
                The grade that is assigned for the product rate plan. The value
                of this field must be a positive integer. The greater the value,
                the higher the grade.


                A product rate plan to be added to a Grading catalog group must
                have one grade. You can specify a grade for a product rate plan
                in this request or update the product rate plan individually.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.
                  - This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
              type: number
            Name:
              description: >
                The name of the product rate plan. The name doesn't have to be
                unique in a Product Catalog, but the name has to be unique
                within a product.
              maxLength: 255
              type: string
            ProductId:
              description: |
                The ID of the product that contains the product rate plan.
              maxLength: 32
              type: string
            ProductRatePlanNumber:
              description: >
                The natural key of the product rate plan.


                **Possible values**:

                  - leave null for automatically generated string
                  - an alphanumeric string of 100 characters or fewer

                **Note**: This field is only available if you set the
                `X-Zuora-WSDL-Version` request header to `133` or later.
              maxLength: 100
              type: string
          required:
            - Name
            - ProductId
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
      example:
        Name: Basic Plan
        Description: monthly plan
        ProductId: 8ad081dd90c4bdwafe0190desada8f9b15
        ActiveCurrencies: USD
        EffectiveStartDate: '2020-10-20'
        EffectiveEndDate: '2030-10-20'
        ExternalIdSourceSystem: extsys
        ExternalRatePlanIds: ext01,ext02
    ProxyGetProductRatePlan:
      allOf:
        - properties:
            ActiveCurrencies:
              description: >
                A list of 3-letter currency codes representing active currencies
                for the product rate plan. 


                This field cannot be queried in conjunction with any other
                fields except `id` at the same time. 
              items:
                type: string
              type: array
            CreatedById:
              description: >
                The automatically generated ID of the Zuora user who created the
                `ProductRatePlan` object.
              maxLength: 32
              type: string
            CreatedDate:
              description: |
                The date when the `ProductRatePlan` object was created.
              format: date-time
              maxLength: 29
              type: string
            Description:
              description: |
                A description of the product rate plan.
              maxLength: 500
              type: string
            EffectiveEndDate:
              description: >
                The date when the product rate plan expires and can't be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              maxLength: 29
              type: string
            EffectiveStartDate:
              description: >
                The date when the product rate plan becomes available and can be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              maxLength: 29
              type: string
            Grade:
              description: |
                The grade that is assigned for the product rate plan.

                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.
                  - This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
              type: number
            Id:
              description: Object identifier.
              type: string
            Name:
              description: >
                The name of the product rate plan. The name doesn't have to be
                unique in a Product Catalog, but the name has to be unique
                within a product.
              maxLength: 255
              type: string
            ProductId:
              description: |
                The ID of the product that contains the product rate plan.
              maxLength: 32
              type: string
            UpdatedById:
              description: >
                The automatically generated ID of the last user to update the
                object.
              maxLength: 32
              type: string
            UpdatedDate:
              description: |
                The date when the object was last updated.
              format: date-time
              maxLength: 29
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
    ProxyModifyProductRatePlan:
      allOf:
        - properties:
            ActiveCurrencies:
              description: >
                A list of 3-letter currency codes representing active currencies
                for the product rate plan. Use a comma to separate each currency
                code.


                If the request body contains this field, the value of this field
                must contain the desired list of active currencies. The new list
                can never have more than four differences from the existing
                list.


                This field cannot be used to modify the status of more than four
                currencies in a single request. For example, in a single
                request, you can only activate four currencies, or deactivate
                four currencies, or activate two and deactivate two. Making more
                than four changes to currencies always requires more than one
                call.


                When specifying this field in the update request, you must
                provide the full list of active currencies you want, not just
                incremental changes. For each active currency update, provide
                the following currencies in the list:


                Current active currencies + at most four changes (additions or
                deletions)
              items:
                type: string
              type: array
            Description:
              description: |
                A description of the product rate plan.
              maxLength: 500
              type: string
            EffectiveEndDate:
              description: >
                The date when the product rate plan expires and can't be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              maxLength: 29
              type: string
            EffectiveStartDate:
              description: >
                The date when the product rate plan becomes available and can be
                subscribed to, in `yyyy-mm-dd` format.
              format: date
              maxLength: 29
              type: string
            ExternalIdSourceSystem:
              description: >
                The ID of the external source system.


                **Note:** To use this field, you must set the
                `X-Zuora-WSDL-Version` request header to `130` or later.
                Otherwise, an error occurs.
              type: string
            ExternalRatePlanIds:
              description: >
                An external ID of the product rate plan to be added. You can use
                this field to specify a product rate plan that is imported from
                an external system. 

                If you want to update to multiple values, use a comma separated
                string.


                **Note:** To use this field, you must set the
                `X-Zuora-WSDL-Version` request header to `130` or later.
                Otherwise, an error occurs.
              type: string
            Grade:
              description: >
                The grade that is assigned for the product rate plan. The value
                of this field must be a positive integer. The greater the value,
                the higher the grade.


                A product rate plan to be added to a Grading catalog group must
                have one grade. You can specify a grade for a product rate plan
                in this request or update the product rate plan individually.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `116` or later. Otherwise, an error occurs.
                  - This field is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/).
              type: number
            Name:
              description: >
                The name of the product rate plan. The name doesn't have to be
                unique in a Product Catalog, but the name has to be unique
                within a product.
              maxLength: 255
              type: string
            ProductId:
              description: |
                The ID of the product that contains the product rate plan.
              maxLength: 32
              type: string
            ProductRatePlanNumber:
              description: >
                The natural key of the product rate plan. 


                For existing Product Rate Plan objects that are created before
                this field is introduced, this field will be null. Use this
                field to specify a value for only these objects. Zuora also
                provides a tool to help you automatically backfill this field
                with tenant ID for your existing product catalog. If you want to
                use this backfill tool, contact [Zuora Global
                Support](https://support.zuora.com/).


                **Note**: This field is only available if you set the
                `X-Zuora-WSDL-Version` request header to `133` or later.
              maxLength: 100
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanObjectCustomFields'
      example:
        Name: Monthly Plan2
        Description: monthly plan
        ProductId: 8ad081dd90c4bafe0190desada8f9b154b
        ActiveCurrencies: USD
        ExternalIdSourceSystem: extsys9
        ExternalRatePlanIds: ext01
    GETProductRatePlanDefinitionsResponse:
      properties:
        productRatePlanDefinitions:
          description: |
            The list of the product rate plan definitions that are retrieved.
          items:
            properties:
              id:
                description: |
                  The unique ID of the product rate plan definition.
                type: string
              productRatePlanChargeId:
                description: >
                  The unique ID of the product charge in this rate plan
                  definition.
                type: string
              productRatePlanChargeName:
                description: |
                  Th name of the product charge in this rate plan definition.
                type: string
              productRatePlanChargeNumber:
                description: >
                  The unique number (natural key) of the product charge in this
                  rate plan definition.
                type: string
              productRatePlanId:
                description: >
                  The unique ID of the product rate plan that uses this rate
                  plan definition.
                type: string
              productRatePlanName:
                description: >
                  Th name of the product rate plan that uses this rate plan
                  definition.
                type: string
              productRatePlanNumber:
                description: >
                  The unique number (natural key) of the product rate plan that
                  uses this rate plan definition.
                type: string
            title: productRatePlanDefinitions
            type: object
          type: array
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
      type: object
    POSTRatePlanDefinitionRequest:
      example:
        productRatePlanChargeId: 2c9890e489f227bd0189f22f3482001f
        productRatePlanChargeNumber: PRPC-00000001
        productRatePlanId: 2c9890678b1ca909018b1caea5c30000
        productRatePlanNumber: PRP-00000008
      properties:
        productRatePlanChargeId:
          description: >
            The unique ID of the product rate plan charge to be used in the
            product rate plan.
          type: string
        productRatePlanChargeNumber:
          description: >
            The unique number (natural key) of the product rate plan charge to
            be used in the product rate plan.
          type: string
        productRatePlanId:
          description: >
            The unique ID of the product rate plan that uses this rate plan
            definition.
          type: string
        productRatePlanNumber:
          description: >
            The unique number (natural key) of the product rate plan that uses
            this rate plan definition.
          type: string
      type: object
    POSTRatePlanDefinitionResponse:
      properties:
        id:
          description: |
            The unique ID of the product charge definition.
          type: string
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
      type: object
    GETProductRatePlanDefinitionResponse:
      properties:
        id:
          description: |
            The unique ID of the product rate plan definition.
          type: string
        productRatePlanChargeId:
          description: |
            The unique ID of the product charge in this rate plan definition.
          type: string
        productRatePlanChargeName:
          description: |
            Th name of the product charge in this rate plan definition.
          type: string
        productRatePlanChargeNumber:
          description: >
            The unique number (natural key) of the product charge in this rate
            plan definition.
          type: string
        productRatePlanId:
          description: >
            The unique ID of the product rate plan that uses this rate plan
            definition.
          type: string
        productRatePlanName:
          description: >
            Th name of the product rate plan that uses this rate plan
            definition.
          type: string
        productRatePlanNumber:
          description: >
            The unique number (natural key) of the product rate plan that uses
            this rate plan definition.
          type: string
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
      type: object
    GETDeliverySchedule:
      properties:
        frequency:
          description: >
            The frequency of the delivery. Only weekly delivery is supported
            now.
          enum:
            - Weekly
          type: string
        friday:
          description: |
            The flag to indicate whether the delivery happens on Friday.
          type: boolean
        monday:
          description: |
            The flag to indicate whether the delivery happens on Monday.
          type: boolean
        saturday:
          description: |
            The flag to indicate whether the delivery happens on Saturday.
          type: boolean
        sunday:
          description: |
            The flag to indicate whether the delivery happens on Sunday.
          type: boolean
        thursday:
          description: |
            The flag to indicate whether the delivery happens on Thursday.
          type: boolean
        tuesday:
          description: |
            The flag to indicate whether the delivery happens on Tuesday.
          type: boolean
        wednesday:
          description: |
            The flag to indicate whether the delivery happens on Wendesday.
          type: boolean
      title: deliverySchedule
      type: object
      nullable: true
    GETRatePlanChargePricingTier:
      description: >
        Array of product rate plan charge tiers.


        You should specify all relevant fields of all tiers, including pricing
        information for each currency.


        For each currency, ensure that the tiers appear in ascending order of
        `StartingUnit`.


        For example:


        ```

        [
          {
            "StartingUnit": "1",
            "EndingUnit": "150",
            "Currency": "USD",
            "Price": 1.95,
            "PriceFormat": "Per Unit"
          },
          {
            "StartingUnit": "151",
            "EndingUnit": "300",
            "Currency": "USD",
            "Price": 1.45,
            "PriceFormat": "Per Unit"
          },
          {
            "StartingUnit": "1",
            "EndingUnit": "150",
            "Currency": "EUR",
            "Price": 1.75,
            "PriceFormat": "Per Unit"
          },
          {
            "StartingUnit": "151",
            "EndingUnit": "300",
            "Currency": "EUR",
            "Price": 1.30,
            "PriceFormat": "Per Unit"
          }
        ]

        ```
      items:
        properties:
          currency:
            description: |
              The code corresponding to the currency for the price tier.
            type: string
          discountAmount:
            description: >
              The specific amount for a fixed discount. This field is applicable
              for charges based on the Discount-Fixed Amount charge model.
            format: double
            type: number
          discountPercentage:
            description: >
              The percentage of discount for a percentage discount. This field
              is applicable for charges based on the Discount-Percentage charge
              model.
            format: double
            type: number
          endingUnit:
            description: >
              The end number of a range of units for the tier. This field is
              applicable for charges based on the Tiered Pricing or Tiered with
              Overage Pricing charge model.
            format: double
            type: number
          overagePrice:
            description: >
              Indicates whether the price is an overage price, which is the
              price when usage surpasses the last defined tier.
            format: double
            type: number
          price:
            description: >
              The price of the tier if the charge is a flat fee, or the price of
              each unit in the tier if the charge model is tiered pricing.
            format: double
            type: number
          startingUnit:
            description: >
              The starting number of a range of units for the tier. This field
              is applicable for charges based on the Tiered Pricing or Tiered
              with Overage Pricing charge model.
            format: double
            type: number
        type: object
      type: array
    GETRatePlanChargePricing:
      properties:
        currency:
          description: |
            The currency for the price.
          type: string
        discountAmount:
          description: >
            The specific amount for a fixed discount. This field is applicable
            for charges based on the Discount-Fixed Amount charge model.
          format: double
          type: number
          nullable: true
        discountPercentage:
          description: >
            The percentage of discount for a percentage discount. This field is
            applicable for charges based on the Discount-Percentage charge
            model.
          format: double
          type: number
          nullable: true
        includedUnits:
          description: >
            The number of units included in this price item. 


            This field is only applicable for charges based on the Overage
            Pricing charge model.
          type: number
          nullable: true
        overagePrice:
          description: >
            The overage price of the price item. 


            This field is only applicable for charges based on the Overage
            Pricing or Tiered with Overage Pricing charge model.
          type: number
          nullable: true
        price:
          description: >
            The price. 


            This field is only applicable for charges based on the following
            charge models:
              - Flat Fee
              - Per Unit
              - Delivery Pricing
          type: number
        tiers:
          description: >
            Container for the tiers of the price item. 


            This field is only applicable for charges based on the following
            charge models:
              - Tiered Pricing
              - Volume Pricing
              - Tiered with Overage Pricing
          items:
            $ref: '#/components/schemas/GETRatePlanChargePricingTier'
          type: array
          nullable: true
      type: object
    GETProductRatePlanChargeResponse:
      properties:
        applyDiscountTo:
          description: |
            Indicates which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          type: string
          nullable: true
        billingDay:
          description: |
            The bill cycle type for this charge.
          type: string
        billingPeriod:
          description: |
            The billing period for this charge.
          type: string
        billingPeriodAlignment:
          description: |
            The billing period alignment setting for this charge.
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
          type: string
        billingTiming:
          description: |
            The billing timing for this charge.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeFunction:
          description: >
            **Note**: This field is only available if you have the Prepaid with
            Drawdown or Minimum Commitment feature enabled.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to `141` or higher. Otherwise, an error occurs.


            This field defines what type of charge it is:

            * Standard: Normal charge with no Prepayment or Commitment or
            Drawdown.

            * Prepayment: For recurring charges. Unit or currency based prepaid
            charge.

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge.

            * Drawdown: For usage charges. Drawdown from prepaid funds.

            * DrawdownAndCreditCommitment: For usage charges. Drawdown from
            prepaid funds and then credit to minimum commitment funds.

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - Standard
            - Prepayment
            - CommitmentTrueUp
            - Drawdown
            - CreditCommitment
            - DrawdownAndCreditCommitment
          type: string
        commitmentType:
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> feature enabled.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to `133` or higher. Otherwise, an error occurs. 


            This field defines the type of commitment. A prepaid charge can be
            `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can
            only be `CURRENCY` type. For topup(recurring or one-time) charges,
            this field indicates what type of funds are created. 

            * If UNIT, it will create a fund with given prepaidUom.

            * If CURRENCY, it will create a fund with the currency amount
            calculated in list price.
              
            For drawdown(usage) charges, this field indicates what type of funds
            are drawdown from that created from topup charges.
          enum:
            - UNIT
            - CURRENCY
          type: string
        customFields:
          $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
        defaultQuantity:
          description: |
            The default quantity. 

            This field is applicable only for one-time and recurring charges.
          type: number
          nullable: true
        deliverySchedule:
          $ref: '#/components/schemas/GETDeliverySchedule'
        description:
          description: |
            The description for this charge.
          type: string
        discountClass:
          description: >
            The class that the discount belongs to. The discount class defines
            the order in which discount product rate plan charges are applied.


            For more information, see [Manage Discount
            Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).
          type: string
          nullable: true
        discountLevel:
          description: >
            The application scope of the discount charge. For example, if the
            value of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        endDateCondition:
          description: |
            The end date condition for this charge.
          enum:
            - Subscription_End
            - One_Time
            - Fixed_Period
            - Specific_End_Date
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled. 
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related rate plan charges and order
            line items from revenue accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled.
        isAllocationEligible:
          type: boolean
          description: >
            Indicates whether the charge segment is allocation eligible in
            revenue recognition. The default value is `false`.


            **Values**: `true`, `false`


            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
        isUnbilled:
          type: boolean
          description: >
            Specifies how to perform the accounting during revenue recognition.
            The default value is `false`.


            **Values**: `true`, `false`


            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.    
        productCategory:
          type: string
          description: >
            This field is used to maintain the product category for integration
            with Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.    
        productClass:
          type: string
          description: >
            This field is used to maintain the product class for integration
            with Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.    
        productFamily:
          type: string
          description: >
            This field is used to maintain the product family for integration
            with Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.
        productLine:
          type: string
          description: >
            This field is used to maintain the product line for integration with
            Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.
        prorationOption:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
            target="_blank">Usage charge proration</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to `135` or higher. Otherwise, an error occurs.


            You can use this field to specify the charge-level proration option
            for a usage charge or recurring charge. The tenant-level proration
            option will be overridden.
              * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
              * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
              * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
              * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
          type: string
        reflectDiscountInNetAmount:
          type: boolean
          default: false
          description: >
            When you apply percentage discounts to either of the following
            charges, you need to set the `reflectDiscountInNetAmount` field on
            your discount charge to `true`, to enable calculating and displaying
            the net amount of the following charges in Zuora Revenue.

            * delivery pricing charge

            * prepayment charge

            * drawdown charge


            Note the following:

            * If you are an <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> customer, when you set the
            `reflectDiscountInNetAmount` field to `true`, you must also set both
            the `excludeItemBookingFromRevenueAccounting` and
            `excludeItemBillingFromRevenueAccounting` fields to `true`. 

            * If you are a <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> customer, you must
            set the `reflectDiscountInNetAmount` field to `false`, otherwise an
            error will be returned. Billing - Revenue Integration does not
            support discounts on the preceding charges.

            * If you are a Zuora Billing customer who does not enable the Order
            to Revenue or Billing - Revenue Integration feature, when you apply
            percentage discounts to the preceding charges, you also need to set
            the `reflectDiscountInNetAmount` field to `true`.      
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference. 

            Other options might also be avaliable depending on 

            the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference. 

            Other options might also be avaliable depending on 

            the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        numberOfPeriods:
          description: >
            Specifies the number of periods to use when calculating charges in
            an overage smoothing charge model.

            This field is ued when overage smoothing model is `RollingWindow` or
            `Rollover`.
          format: int64
          type: integer
          nullable: true
        financeInformation:
          description: |
            Container for the finance information of a product rate plan charge.
          properties:
            accountsReceivableAccountingCode:
              description: |
                The accounting code for accounts receivable.
              type: string
              nullable: true
            accountsReceivableAccountingCodeType:
              description: |
                The type of the accounting code for accounts receivable.
              type: string
              nullable: true
            adjustmentLiabilityAccountingCode:
              description: >
                The accounting code for adjustment liability. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            adjustmentLiabilityAccountingCodeType:
              description: >
                The type associated with the adjustment liability accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            adjustmentRevenueAccountingCode:
              description: >
                The accounting code for adjustment revenue. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            adjustmentRevenueAccountingCodeType:
              description: >
                The type associated with the adjustment revenue accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            contractAssetAccountingCode:
              description: >
                The accounting code for contract asset. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            contractAssetAccountingCodeType:
              description: >
                The type associated with the contract asset accounting code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            contractLiabilityAccountingCode:
              description: >
                The accounting code for contract liability. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            contractLiabilityAccountingCodeType:
              description: >
                The type associated with the contract liability accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            contractRecognizedRevenueAccountingCode:
              description: >
                The accounting code for contract recognized revenue. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            contractRecognizedRevenueAccountingCodeType:
              description: >
                The type associated with the contract recognized revenue
                accounting code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            deferredRevenueAccountingCode:
              description: >
                The accounting code for deferred revenue, such as Monthly
                Recurring Liability.
              type: string
              nullable: true
            deferredRevenueAccountingCodeType:
              description: >
                The type associated with the deferred revenue accounting code,
                such as Deferred Revenue. 
              type: string
              nullable: true
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for recognized revenue, such as Monthly
                Recurring Charges or Overage Charges. 
              type: string
              nullable: true
            recognizedRevenueAccountingCodeType:
              description: >
                The type associated with the recognized revenue accounting code,
                such as Sales Revenue or Sales Discount.
              type: string
              nullable: true
            unbilledReceivablesAccountingCode:
              description: >
                The accounting code for unbilled receivables. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
            unbilledReceivablesAccountingCodeType:
              description: >
                The type associated with the unbilled receivables accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
              nullable: true
          title: financeInformation
          type: object
        id:
          description: |
            The unique ID of the product rate plan charge.
          type: string
        isStackedDiscount:
          description: >
            **Note**: This field is only applicable to the Discount - Percentage
            charge model.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to 130 or higher. Otherwise, an error occurs.


            This field indicates whether the discount is to be calculated as
            stacked discount. Possible values are as follows:
              - `true`: This is a stacked discount, which should be calculated by stacking with other discounts.
              - `false`: This is not a stacked discount, which should be calculated in sequence with other discounts.

            For more information, see [Stacked
            discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
          type: boolean
        listPriceBase:
          description: >
            The base of list price. 


            This field is applicable only for recurring charges.


            **Note**: The `Per_Year` enum value is available only if you have
            the <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
            target="_blank">Annual List Price</a> feature enabled.
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        model:
          description: >
            Determines how to calculate charges. Charge models must be
            individually activated in Zuora Billing administration.
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Overage
            - Tiered
            - TieredwithOverage
            - Volume
            - Delivery
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        name:
          description: |
            The name of the product rate plan charge.
          type: string
        numberOfPeriod:
          description: >
            Indicates the number of periods to use when calculating charges in
            an overage smoothing charge model. The valid value is a positive
            whole number.
          format: int64
          type: integer
        overageCalculationOption:
          description: >
            Determines when to calculate overage charges. If the value of the
            `smoothingMode` field is not specified, the value of this field is
            ignored.


            **Values**: 
              - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.
              - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          type: string
          nullable: true
        overageUnusedUnitsCreditOption:
          description: >
            Determines whether to credit the customer with unused units of
            usage.
          enum:
            - NoCredit
            - CreditBySpecificRate
            - null
          type: string
          nullable: true
        priceChangeOption:
          default: NoChange
          description: >
            Applies an automatic price change when a termed subscription is
            renewed.
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
            - null
          type: string
          nullable: true
        priceIncreaseOption:
          description: >
            Applies an automatic price change when a termed subscription is
            renewed.
          enum:
            - FromTenantPercentageValue
            - SpecificPercentageValue
          type: string
        priceIncreasePercentage:
          description: >
            Specifies the percentage to increase or decrease the price of a
            termed subscription's renewal. Use this field if you set the
            `priceIncreaseOption` field to `SpecificPercentageValue`.


            **Character limit**: 16


            **Values**: a decimal value between -100 and 100
          format: double
          type: number
          nullable: true
        pricing:
          description: |
            Container for the prices of the product rate plan charge.
          items:
            $ref: '#/components/schemas/GETRatePlanChargePricing'
          type: array
        pricingSummary:
          description: >
            A concise description of the charge model and pricing that is
            suitable to show to your customers. 


            When the rate plan charge model is `Tiered` and multi-currency is
            enabled, this field includes an array of string of each currency,
            and each string of currency includes tier price description
            separated by comma.


            When the rate plan charge model is `DiscountPercentage`, this field
            does not include currency.


            When the rate plan charge model is not `DiscountPercentage`, this
            field includes the currency.
                

            For the following charge models, the value of this field is an empty
            string:

            - Multi-Attribute Pricing

            - High Water Mark Tiered Pricing

            - High Water Mark Volume Pricing

            - Pre-Rated Per Unit Pricing

            - Pre-Rated Pricing


            The charge models are available for customers with Enterprise and
            Nine editions by default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
          items:
            type: string
          type: array
        productChargeDefinitions:
          description: |
            A link to retrieve product charge definitions of this charge.
          type: string
        productDiscountApplyDetails:
          description: >
            Container for the application details about a discount product rate
            plan charge. 


            Only discount product rate plan charges have values in this field.
          items:
            $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
          type: array
        productRatePlanChargeNumber:
          description: |
            The number of this product rate plan charge.
          type: string
          nullable: true
        ratingGroup:
          default: ByBillingPeriod
          description: |
            Specifies a rating group based on which usage records are rated.

            Possible values:                
              - `ByBillingPeriod`: The rating is based on all the usages in a billing period. 
              - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. 
              - `ByUsageRecord`: The rating is based on each usage record.
              - `ByUsageUpload`: The rating is based on all the  usages in a uploaded usage file (`.xls` or `.csv`).
              - `ByGroupId`: The rating is based on all the usages in a custom group.

            **Notes:** 
              - The `ByBillingPeriod` value can be applied for all charge models. 
              - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. 
              - The `ByGroupId` value is only available if you have the Active Rating feature enabled.
              - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
            - null
          type: string
          nullable: true
        recognizedRevenueAccount:
          description: |
            The name of the recognized revenue account for this charge.
              - Required when the Allow Blank Accounting Code setting is No.
              - Optional when the Allow Blank Accounting Code setting is Yes.

              This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
          maxLength: 100
          type: string
        revRecCode:
          description: >
            Associates this product rate plan charge with a specific revenue
            recognition code.
          maxLength: 70
          type: string
          nullable: true
        revRecTriggerCondition:
          description: |
            Specifies when revenue recognition begins.
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          type: string
          nullable: true
        revenueRecognitionRuleName:
          description: |
            Determines when to recognize the revenue for this charge.
          enum:
            - Recognize upon invoicing
            - Recognize daily over time
          type: string
        smoothingModel:
          description: |
            Specifies the smoothing model for an overage smoothing charge model.
          enum:
            - RollingWindow
            - Rollover
            - null
          type: string
          nullable: true
        specificBillingPeriod:
          description: |
            The specific number of billing periods for this charge.
          type: number
          nullable: true
        specificListPriceBase:
          description: >
            The number of months for the list price base of the charge. The
            value of this field is `null` if you do not set the value of the
            `listPriceBase` field to `Per_Specific_Months`.
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
        taxCode:
          description: >
            Specifies the tax code for taxation rules. This field is required
            when the `taxable` field is set to `true`.


            **Note**: This value affects the tax calculation of the rate plan
            charge.
          maxLength: 64
          type: string
        taxMode:
          description: >
            Determines how to define taxation for the charge. This field is
            required when the `taxable` field is set to `true`.


            **Note**: This value affects the tax calculation of the rate plan
            charge.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          description: >
            Determines whether the charge is taxable. When set to `true`, the
            `taxMode` and `taxCode` fields are required when creating or
            updating th Product Rate Plan Charge object.


            **Character limit**: 5


            **Values**: `true`, `false`


            **Note**: This value affects the tax calculation of rate plan
            charges that come from the `ProductRatePlanCharge`.
          type: boolean
        triggerEvent:
          description: |
            Specifies when to start billing the customer for the charge.

            **Values**:
              - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.
              - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.
              - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
        type:
          description: |
            Specifies the type of charge.
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        uom:
          description: >
            Indicates the units of measure (UOM) that is configured in
            **Settings > Billing** for the product rate plan charge.
          type: string
          nullable: true
        upToPeriods:
          description: |
            The number of up-to-periods value for this charge.
          type: number
          nullable: true
        upToPeriodsType:
          description: |
            The up-to-periods type setting for this charge.
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          default: EndOfBillingPeriod
          description: >
            Determines how Zuora processes usage records for per-unit usage
            charges.
          enum:
            - EndOfBillingPeriod
            - OnDemand
            - null
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          description: >
            Determines whether to define a new accounting code for the new
            discount charge.


            **Character limit**: 5


            **Values**: `true`, `false`
          type: boolean
          nullable: true
        useTenantDefaultForPriceChange:
          description: >
            Applies the tenant-level percentage uplift value for an automatic
            price change to a termed subscription's renewal. 


            **Character limit**: 5


            **Values**: `true`, `false`
          type: boolean
        applyToBillingPeriodPartially:
          description: >
            Allow the discount duration to be aligned with the billing period
            partially.


            **Note**: You must enable the [Enhanced
            Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          type: boolean
        isPrepaid:
          description: >
            Indicates whether this charge is a prepayment (topup) charge or a

            drawdown charge.


            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            **Values**: `true` or `false`.
          type: boolean
        prepaidOperationType:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The type of this charge. It is either a prepayment (topup) charge or
            a drawdown charge. 
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
          nullable: true
        prepaidTotalQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The total amount of units that end customers can use during a
            validity period when they subscribe to a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: number
          nullable: true
        prepaidUom:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            Unit of measurement for a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: string
          nullable: true
        validityPeriodType:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The period in which the prepayment units are valid to use as defined
            in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
          nullable: true
        drawdownUom:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            Unit of measurement for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
          type: string
          nullable: true
        creditOption:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information. 
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        isRollover:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The value is either "true" or "false". It determines whether the
            rollover fields are needed.
          type: boolean
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. In this
            case, you must set the `rolloverPeriods` field to 1. For example,
            you can define the rollover fund's period length as 5 months,
            shorter than the prepayment charge's validity period: a year.
          type: integer
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: number
        formula:
          description: >
            The price lookup formula defined for the product rate plan charge,
            which is used to identify

            the correct and relevant charge definition based on the context.


            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing" 
            target="_blank">Price lookup in Attribute-based Pricing</a>.



            **Note**: This field is available only if the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing"
            target="_blank">Attribute-based Pricing</a> feature is enabled.
          type: string
      type: object
    ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem:
      properties:
        Key:
          description: >
            The name of the field that is specified for a specific charge model.


            Configuration keys supported are as follows:


            * `formula` (only available if you have the Multi-Attribute Pricing
            charge model enabled. The charge model is available for customers
            with Enterprise and Nine editions by default. If you are a Growth
            customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.)

            * `customFieldPerUnitRate` (only available if you have the Pre-Rated
            Per Unit Pricing charge model enabled. The charge model is available
            for customers with Enterprise and Nine editions by default. If you
            are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.)

            * `customFieldTotalAmount` (only available if you have the Pre-Rated
            Pricing model enabled. The charge model is available for customers
            with Enterprise and Nine editions by default. If you are a Growth
            customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.)
          type: string
        Value:
          description: >
            The value of the field that is specified in the `Key` field.


            Possible values are follows:


            * A valid pricing formula to calculate actual rating amount for each
            usage record. For example, `usageQuantity()*10`. Use it with Key
            `formula` when the Multi-Attribute Pricing charge model is used. The
            charge model is available for customers with Enterprise and Nine
            editions by default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.

            * A name of a usage custom field that carries the per-unit rate for
            a usage record. For example, `perUnitRate__c`. Use it with Key
            `customFieldPerUnitRate` when the Pre-Rated Per Unit Pricing charge
            model is used. The charge model is available for customers with
            Enterprise and Nine editions by default. If you are a Growth
            customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.

            * A name of a usage custom field that carries the total amount for a
            usage record. For example, `totalAmount__c`. Use it with Key
            `customFieldTotalAmount` when the Pre-Rated Pricing model is used.
            The charge model is available for customers with Enterprise and Nine
            editions by default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
          type: string
      required:
        - Key
        - Value
      title: ConfigurationItem
      type: object
    ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration:
      description: |
        Container for charge model configuration data.

        **Notes**:
          - This field is only available if you have the Pre-Rated Pricing or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.
          - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `102` or later. Otherwise, an error occurs with "Code: INVALID_VALUE".
      properties:
        ConfigurationItem:
          description: |
            An array of Charge Model Configuration Key-Value pairs.
          items:
            $ref: >-
              #/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfigurationItem
          type: array
      title: ChargeModelConfiguration
      type: object
    ProxyCreateOrModifyDeliverySchedule:
      properties:
        frequency:
          description: |
            The frequency of the delivery. Only supports weekly now
          enum:
            - Weekly
          type: string
        friday:
          description: |
            The flag to indicate should the delivery happen on Friday
          type: boolean
        monday:
          description: |
            The flag to indicate should the delivery happen on Monday
          type: boolean
        saturday:
          description: |
            The flag to indicate should the delivery happen on Saturday
          type: boolean
        sunday:
          description: |
            The flag to indicate should the delivery happen on Sunday
          type: boolean
        thursday:
          description: |
            The flag to indicate should the delivery happen on Thursday
          type: boolean
        tuesday:
          description: |
            The flag to indicate should the delivery happen on Tuesday
          type: boolean
        wendesday:
          description: |
            The flag to indicate should the delivery happen on Wendesday
          type: boolean
      title: DeliverySchedule
      type: object
    ProxyCreateOrModifyProductRatePlanChargeTierData:
      description: >
        Container for pricing information associated with the product rate plan
        charge.
      properties:
        ProductRatePlanChargeTier:
          description: >
            Array of product rate plan charge tiers.


            You should specify all relevant fields of all tiers, including
            pricing information for each currency.


            For each currency, ensure that the tiers appear in ascending order
            of `StartingUnit`.


            For example:


            ```

            [
              {
                "StartingUnit": "1",
                "EndingUnit": "150",
                "Currency": "USD",
                "Price": 1.95,
                "PriceFormat": "Per Unit"
              },
              {
                "StartingUnit": "151",
                "EndingUnit": "300",
                "Currency": "USD",
                "Price": 1.45,
                "PriceFormat": "Per Unit"
              },
              {
                "StartingUnit": "1",
                "EndingUnit": "150",
                "Currency": "EUR",
                "Price": 1.75,
                "PriceFormat": "Per Unit"
              },
              {
                "StartingUnit": "151",
                "EndingUnit": "300",
                "Currency": "EUR",
                "Price": 1.30,
                "PriceFormat": "Per Unit"
              }
            ]

            ```
          items:
            properties:
              Currency:
                description: |
                  The code corresponding to the currency for the tier's price.
                type: string
              DiscountAmount:
                description: >
                  The specific amount for a fixed discount. Required if the
                  charge model of the product rate plan charge is
                  `Discount-Fixed Amount`.
                format: double
                type: number
              DiscountPercentage:
                description: >
                  The percentage of discount for a percentage discount. Required
                  if the charge model of the product rate plan charge is
                  `Discount-Percentage`.
                format: double
                type: number
              EndingUnit:
                description: >
                  The end number of a range of units for the tier. Required if
                  the charge model of the product rate plan charge is `Tiered
                  Pricing` or `Tiered with Overage Pricing`.
                format: double
                type: number
              IsOveragePrice:
                description: >
                  Indicates if the price is an overage price, which is the price
                  when usage surpasses the last defined tier.
                type: boolean
              Price:
                description: >
                  The price of the tier if the charge is a flat fee, or the
                  price of each unit in the tier if the charge model is tiered
                  pricing.
                format: double
                type: number
              PriceFormat:
                description: >
                  Indicates if pricing is a flat fee or is per unit. This field
                  is for tiered and volume pricing models only.
                enum:
                  - Flat Fee
                  - Per Unit
                type: string
              StartingUnit:
                description: >
                  The starting number of a range of units for the tier. Required
                  if the charge model of the product rate plan charge is `Tiered
                  Pricing` or `Tiered with Overage Pricing`.
                format: double
                type: number
            type: object
          type: array
      title: productRatePlanChargeTierData
      type: object
    ProxyCreateProductRatePlanCharge:
      allOf:
        - properties:
            AccountingCode:
              description: >
                The accounting code for the charge. Accounting codes group
                transactions that contain similar accounting attributes.
              maxLength: 100
              type: string
            ApplyDiscountTo:
              description: >
                Specifies the type of charges that you want a specific discount
                to apply to. All field values are case sensitive and in
                all-caps.
              enum:
                - ONETIME (1)
                - RECURRING (2)
                - USAGE (4)
                - ONETIMERECURRING (3)
                - ONETIMEUSAGE (5)
                - RECURRINGUSAGE (6)
                - ONETIMERECURRINGUSAGE (7)
              type: string
            BillCycleDay:
              description: >
                Sets the bill cycle day (BCD) for the charge. The BCD determines
                which day of the month customer is billed. The BCD value in the
                account can override the BCD in this object.


                **Character limit**: 2


                **Values**: a valid BCD integer, 1 - 31
              format: int32
              type: integer
            BillCycleType:
              description: |
                Specifies how to determine the billing day for the charge. 

                **Notes**:
                  - If you set this field to `SpecificDayofMonth`, you must specify which day of the month as the billing day for the charge in the BillCycleDay field. 
                  - If you set this field to `SpecificDayofWeek`, you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field. 
                  - By default, `TermStartDay` and `TermEndDay` are only available for prepayment charges. But you can reach out to Zuora Global Support to request enabling it for non-prepaid recurring charges. Meanwhile, note the following rules applies to these options:
                    - The Term End Day option of the Billing Day field must be coupled with the Align to Term End option of the Billing Period Alignment field.
                    - For prepaid charges, the Term Start Day option of the Billing Day field must be coupled with the existing Align to Term Start option of the Billing Period Alignment field.
                    - For non-prepaid recurring charges: If Billing Day is set to Term Start Day, Billing Period Alignment must be Align to Term Start; If Billing Day is set to Term End Day, Billing Period Alignment can be set to other values.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
                - TermStartDay
                - TermEndDay
              type: string
            BillingPeriod:
              description: >
                The billing period for the charge. The start day of the billing
                period is also called the bill cycle day (BCD).


                **Notes**:
                  - Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to `Specific Months` or `Specific Weeks`.
                  - The `Subscription Term` value is in **Limited Availability**.
              enum:
                - Month
                - Quarter
                - Annual
                - Semi-Annual
                - Specific Months
                - Subscription Term
                - Week
                - Specific Weeks
                - Specific Days
              type: string
            BillingPeriodAlignment:
              description: >
                Aligns charges within the same subscription if multiple charges
                begin on different dates.


                **Note:** The `AlignToTermEnd` value is only available for
                prepayment charges by default. Reach out to Zuora Global Support
                to enable it for non-prepaid recurring charges.
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
                - AlignToTermEnd
              type: string
            BillingTiming:
              description: >
                The billing timing for the charge. You can choose to bill in
                advance or in arrears for recurring charge types. This field is
                not used in one-time or usage based charge types.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              enum:
                - In Advance
                - In Arrears
              type: string
            ChargeFunction:
              description: >
                **Note**: This field is only available if you have the Prepaid
                with Drawdown or Minimum Commitment feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `141` or higher. Otherwise, an error occurs.


                This field defines what type of charge it is:

                * Standard: Normal charge with no Prepayment or Commitment or
                Drawdown.

                * Prepayment: For recurring charges. Unit or currency based
                prepaid charge.

                * CommitmentTrueUp: For recurring charges. Currency based
                minimum commitment charge.

                * Drawdown: For usage charges. Drawdown from prepaid funds.

                * DrawdownAndCreditCommitment: For usage charges. Drawdown from
                prepaid funds and then credit to minimum commitment funds.

                * CreditCommitment: For usage charges. Credit to minimum
                commitment funds.
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            CommitmentType:
              description: >
                **Note**: This field is only available if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
                target="_blank">Prepaid with Drawdown</a> feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `133` or higher. Otherwise, an error occurs. 


                This field defines the type of commitment. A prepaid charge can
                be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge
                can only be `CURRENCY` type. For topup(recurring or one-time)
                charges, this field indicates what type of funds are created. 

                * If UNIT, it will create a fund with given prepaidUom.

                * If CURRENCY, it will create a fund with the currency amount
                calculated in list price.


                For drawdown(usage) charges, this field indicates what type of
                funds are drawdown from that created from topup charges.
              enum:
                - UNIT
                - CURRENCY
              type: string
            ChargeModel:
              description: >
                Determines how to calculate charges. Charge models must be
                individually activated in Zuora Billing administration.


                **Notes:**
                  - The `Delivery Pricing` value is available only if you have the Delivery Pricing charge model enabled. The minimal required WSDL version is 128.
                  - The `MultiAttributePricing` value is available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. The minimal required WSDL version is 102.      
                  - The `PreratedPerUnit` and  value is available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. The minimal required WSDL version is 102.      
                  - The `PreratedPricing` value is available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. The minimal required WSDL version is 102.    
                  - The `HighWatermarkVolumePricing`value is available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. The minimal required WSDL version is 102.      
                  - The `HighWatermarkTieredPricing` value is available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. The minimal required WSDL version is 102.
              enum:
                - Discount-Fixed Amount
                - Discount-Percentage
                - Flat Fee Pricing
                - Per Unit Pricing
                - Overage Pricing
                - Tiered Pricing
                - Tiered with Overage Pricing
                - Volume Pricing
                - Delivery Pricing
                - MultiAttributePricing
                - PreratedPerUnit
                - PreratedPricing`
                - HighWatermarkVolumePricing
                - HighWatermarkTieredPricing
              type: string
            ChargeModelConfiguration:
              $ref: >-
                #/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration
            ChargeType:
              description: |
                Specifies the type of charge.
              enum:
                - OneTime
                - Recurring
                - Usage
              type: string
            CreditOption:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The way to calculate credit. See [Credit
                Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
                for more information. 
              enum:
                - TimeBased
                - ConsumptionBased
                - FullCreditBack
              type: string
            DefaultQuantity:
              description: >
                The default quantity of units, such as the number of authors in
                a hosted wiki service. This field is required if you use a
                per-unit pricing model. 


                **Character limit**: 16


                **Values**: a valid quantity value. 


                **Note:** When the `ChargeModel` field is set to `Tiered
                Pricing` or `Volume Pricing`, if this field is not specified,
                the value will default to `0`.
              format: double
              type: number
            DeferredRevenueAccount:
              description: >
                The name of the deferred revenue account for this charge.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              maxLength: 100
              type: string
            DeliverySchedule:
              $ref: '#/components/schemas/ProxyCreateOrModifyDeliverySchedule'
            Description:
              description: |
                A description of the charge.
              maxLength: 500
              type: string
            DiscountLevel:
              description: >
                Specifies if the discount applies to just the product rate plan,
                the entire subscription, or to any activity in the account.
              enum:
                - rateplan
                - subscription
                - account
              type: string
            DrawdownRate:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                The [conversion
                rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
                between Usage UOM and Drawdown UOM for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
                See [Fields related to Prepaid with
                Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown)
                for more information.
              type: number
            DrawdownUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                Unit of measurement for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). 
              type: string
            EndDateCondition:
              default: SubscriptionEnd
              description: >
                Defines when the charge ends after the charge trigger date.


                **Values**: 
                  - `SubscriptionEnd`: The charge ends on the subscription end date after a specified period based on the trigger date of the charge.  
                  - `FixedPeriod`: The charge ends after a specified period based on the trigger date of the charge. If you set this field to `FixedPeriod`, you must specify the length of the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType` fields. 

                  
                **Note**: If the subscription ends before the charge end date,
                the charge ends when the subscription ends. But if the
                subscription end date is subsequently changed through a Renewal,
                or Terms and Conditions amendment, the charge will end on the
                charge end date.
              enum:
                - SubscriptionEnd
                - FixedPeriod
              type: string
            ExcludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the related invoice items, invoice item
                adjustments, credit memo items, and debit memo items from
                revenue accounting.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.
                  - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            ExcludeItemBookingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the related rate plan charges and order line
                items from revenue accounting.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.
                  - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            IncludedUnits:
              description: |
                Specifies the number of units in the base set of units.

                **Character limit**: 16

                **Values**: a positive decimal value
              format: double
              type: number
            IsAllocationEligible:
              description: >
                Indicates whether the charge segment is allocation eligible in
                revenue recognition. The default value is `False`.


                **Values**: `True`, `False`


                **Notes**: 
                  - The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. 
              type: boolean
            IsPrepaid:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                Indicates whether this charge is a prepayment (topup) charge or
                a drawdown charge. 


                **Values**: `true` or `false`.
              type: boolean
            IsRollover:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                The value is either "True" or "False". It determines whether the
                rollover fields are needed.
              type: boolean
            IsStackedDiscount:
              description: >
                **Note**: This field is only applicable to the Discount -
                Percentage charge model.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 130 or higher. Otherwise, an error occurs.


                This field indicates whether the discount is to be calculated as
                stacked discount. Possible values are as follows:
                  - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.
                  - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.

                For more information, see [Stacked
                discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
              type: boolean
            IsUnbilled:
              description: >
                Specifies how to perform the accounting during revenue
                recognition. The default value is `False`.


                **Values**: `True`, `False`


                **Notes**: 
                  - The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.    
              type: boolean
            LegacyRevenueReporting:
              description: ''
              type: boolean
            ListPriceBase:
              description: >
                The list price base for the product rate plan charge.


                **Note**: If the `ListBasePrice` field is not set in the
                request, the system will use the `BillingPeriod` value as the
                default value.
              enum:
                - Per Billing Period
                - Per Month
                - Per Week
                - Per Year
                - Per Specific Months
              type: string
            MaxQuantity:
              description: >
                Specifies the maximum number of units for this charge. Use this
                field and the `MinQuantity` field to create a range of units
                allowed in a product rate plan charge.


                **Character limit**: 16


                **Values**: a positive decimal value
              format: double
              type: number
            MinQuantity:
              description: >
                Specifies the minimum number of units for this charge. Use this
                field and the `MaxQuantity` field to create a range of units
                allowed in a product rate plan charge.


                **Character limit**: 16


                **Values**: a positive decimal value
              format: double
              type: number
            Name:
              description: |
                The name of the product rate plan charge.
              maxLength: 100
              type: string
            NumberOfPeriod:
              description: >
                Specifies the number of periods to use when calculating charges
                in an overage smoothing charge model. The valid value is a
                positive whole number.
              format: int64
              type: integer
            OverageCalculationOption:
              description: >
                Determines when to calculate overage charges. If the value of
                the SmoothingMode field is not specified, the value of this
                field is ignored.


                **Values**: 
                  - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.
                  - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.
              enum:
                - EndOfSmoothingPeriod
                - PerBillingPeriod
              type: string
            OverageUnusedUnitsCreditOption:
              description: >
                Determines whether to credit the customer with unused units of
                usage.
              enum:
                - NoCredit
                - CreditBySpecificRate
                - null
              type: string
              nullable: true
            PrepaidOperationType:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The type of this charge. It is either a prepayment (topup)
                charge or a drawdown charge. 
              enum:
                - topup
                - drawdown
              type: string
            PrepaidQuantity:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The number of units included in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
                Must be a positive number.
              type: number
            PrepaidTotalQuantity:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The total amount of units that end customers can use during a
                validity period when they subscribe to a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              type: number
            PrepaidUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                Unit of measurement for a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              type: string
            PriceChangeOption:
              default: NoChange
              description: >
                Applies an automatic price change when a termed subscription is
                renewed.
              enum:
                - NoChange
                - SpecificPercentageValue
                - UseLatestProductCatalogPricing
              type: string
            PriceIncreaseOption:
              description: >
                Applies an automatic price change when a termed subscription is
                renewed.
              enum:
                - FromTenantPercentageValue
                - SpecificPercentageValue
              type: string
            PriceIncreasePercentage:
              description: >
                Specifies the percentage to increase or decrease the price of a
                termed subscription's renewal. Use this field if you set the
                value to `SpecificPercentageValue`.


                **Character limit**: 16


                **Values**: a decimal value between -100 and 100
              format: double
              type: number
              nullable: true
            ProductCategory:
              description: >
                This field is used to maintain the product category for
                integration with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. 
              type: string
            ProductClass:
              description: >
                This field is used to maintain the product class for integration
                with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. 
              type: string
            ProductFamily:
              description: >
                This field is used to maintain the product family for
                integration with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. 
              type: string
            ProductLine:
              description: >
                This field is used to maintain the product line for integration
                with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.         
              type: string
            ReflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `ReflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `ReflectDiscountInNetAmount` field to `true`, you must also set
                both the `ExcludeItemBookingFromRevenueAccounting` and
                `ExcludeItemBillingFromRevenueAccounting` fields to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `ReflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration does not support discounts on the preceding charges.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `ReflectDiscountInNetAmount` field to
                `true`.
            RevenueRecognitionTiming:
              description: >
                Specifies the type of revenue recognition timing.


                Predefined options are listed as enum values in this API
                Reference. 

                Other options might also be avaliable depending on 

                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled. 
              maxLength: 200
              type: string
              enum:
                - Upon Billing Document Posting Date
                - Upon Order Activation Date
            RevenueAmortizationMethod:
              description: >
                Specifies the type of revenue amortization method.


                Predefined options are listed as enum values in this API
                Reference. 

                Other options might also be avaliable depending on 

                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled. 
              maxLength: 200
              type: string
              enum:
                - Immediate
                - Ratable Using Start And End Dates
            ProductRatePlanChargeNumber:
              description: >
                The natural key of the product rate plan charge.


                **Values**:

                  - leave null for automatically generated string
                  - an alphanumeric string of 100 characters or fewer

                **Note**: This field is only available if you set the
                `X-Zuora-WSDL-Version` request header to `133` or later.
              maxLength: 100
              type: string
            ProductRatePlanChargeTierData:
              $ref: >-
                #/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData
            ProductRatePlanId:
              description: >
                The ID of the product rate plan associated with this product
                rate plan charge.
              maxLength: 32
              type: string
            ProrationOption:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
                target="_blank">Usage charge proration</a> and <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `135` or higher. Otherwise, an error occurs.


                You can use this field to specify the charge-level proration
                option for a usage charge or recurring charge. The tenant-level
                proration option will be overridden.
                  * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
                  * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
                  * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
                  * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              enum:
                - NoProration
                - TimeBasedProration
                - DefaultFromTenantSetting
                - ChargeFullPeriod
              type: string
            RatingGroup:
              default: ByBillingPeriod
              description: |
                Specifies a rating group based on which usage records are rated.

                Possible values:                
                  - `ByBillingPeriod`: The rating is based on all the usages in a billing period. 
                  - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. 
                  - `ByUsageRecord`: The rating is based on each usage record.
                  - `ByUsageUpload`: The rating is based on all the  usages in a uploaded usage file (`.xls` or `.csv`).
                  - `ByGroupId`: The rating is based on all the usages in a custom group.

                **Notes:** 
                  - The `ByBillingPeriod` value can be applied for all charge models. 
                  - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. 
                  - The `ByGroupId` value is only available if you have the Active Rating feature enabled.
                  - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
                - ByGroupId
                - null
              type: string
              nullable: true
            RecognizedRevenueAccount:
              description: |
                The name of the recognized revenue account for this charge.
                  - Required when the Allow Blank Accounting Code setting is No.
                  - Optional when the Allow Blank Accounting Code setting is Yes.

                  This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). 
              maxLength: 100
              type: string
            RevRecCode:
              description: >
                Associates this product rate plan charge with a specific revenue
                recognition code.
              maxLength: 70
              type: string
              nullable: true
            RevRecTriggerCondition:
              description: |
                Specifies when revenue recognition begins.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              type: string
              nullable: true
            RevenueRecognitionRuleName:
              description: |
                Determines when to recognize the revenue for this charge.
              enum:
                - Recognize upon invoicing
                - Recognize daily over time
              type: string
            RolloverApply:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                This field defines the priority of rollover, which is either
                first or last.
              enum:
                - ApplyFirst
                - ApplyLast
              type: string
            RolloverPeriods:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                This field defines the number of rollover periods, it is
                restricted to 3.
              type: number
            SmoothingModel:
              description: >
                Specifies the smoothing model for an overage smoothing charge
                model.
              enum:
                - RollingWindow
                - Rollover
                - null
              type: string
              nullable: true
            SpecificBillingPeriod:
              description: >
                Customizes the number of months or weeks for the charges billing
                period. This field is required if you set the value of the
                BillingPeriod field to `Specific Months` or `Specific Weeks`.

                The valid value is a positive integer.
              format: int64
              type: integer
              nullable: true
            SpecificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `ListPriceBase`
                field to `Per Specific Months`. The value must be a positive
                integer between **1** and **120** inclusive.


                **Notes**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.
                  - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
              format: int32
              maximum: 120
              minimum: 1
              example: 12
              type: integer
              nullable: true
            TaxCode:
              description: >
                Specifies the tax code for taxation rules. Required when the
                Taxable field is set to `True`.


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              maxLength: 64
              type: string
            TaxMode:
              description: >
                Determines how to define taxation for the charge. Required when
                the Taxable field is set to `True`.


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            Taxable:
              description: >
                Determines whether the charge is taxable. When set to `True`,
                the TaxMode and TaxCode fields are required when creating or
                updating th ProductRatePlanCharge object.


                **Character limit**: 5


                **Values**: `True`, `False`


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              type: boolean
            TriggerEvent:
              description: |
                Specifies when to start billing the customer for the charge.

                **Values**:
                  - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.
                  - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.
                  - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.
              enum:
                - ContractEffective
                - ServiceActivation
                - CustomerAcceptance
              type: string
            UOM:
              description: >
                Specifies a configured unit to measure usage. 


                **Note**: You must specify this field when creating the
                following charge models:
                  - Per Unit Pricing
                  - Volume Pricing
                  - Overage Pricing
                  - Tiered Pricing
                  - Tiered with Overage Pricing
              maxLength: 25
              type: string
              nullable: true
            UpToPeriods:
              description: >
                Specifies the length of the period during which the charge is
                active. If this period ends before the subscription ends, the
                charge ends when this period ends.


                **Character limit**: 5


                **Values**: a whole number between 0 and 65535, exclusive


                **Notes**:
                  - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. 
                  - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.
              format: int64
              type: integer
              nullable: true
            UpToPeriodsType:
              default: Billing Periods
              description: |
                The period type used to define when the charge ends.

                **Notes**: 
                 - You must use this field together with the `UpToPeriods` field to specify the time period.
                 - This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. 
              enum:
                - Billing Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            UsageRecordRatingOption:
              default: EndOfBillingPeriod
              description: >
                Determines how Zuora processes usage records for per-unit usage
                charges. 
              enum:
                - EndOfBillingPeriod
                - OnDemand
                - null
              type: string
              nullable: true
            UseDiscountSpecificAccountingCode:
              description: >
                Determines whether to define a new accounting code for the new
                discount charge.


                **Character limit**: 5


                **Values**: `True`, `False`
              type: boolean
              nullable: true
            UseTenantDefaultForPriceChange:
              description: >
                Applies the tenant-level percentage uplift value for an
                automatic price change to a termed subscription's renewal. 


                **Character limit**: 5


                **Values**: `true`, `false`
              type: boolean
            ValidityPeriodType:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The period in which the prepayment units are valid to use as
                defined in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              enum:
                - SUBSCRIPTION_TERM
                - ANNUAL
                - SEMI_ANNUAL
                - QUARTER
                - MONTH
              type: string
            WeeklyBillCycleDay:
              description: >
                Specifies which day of the week as the bill cycle day (BCD) for
                the charge.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
            ApplyToBillingPeriodPartially:
              description: >
                Allow the discount duration to be aligned with the billing
                period partially.


                **Note**: You must enable the [Enhanced
                Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
                feature to access this field.
              type: boolean
            RolloverPeriodLength:
              default: null
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with

                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

                feature enabled.



                To use this field, you must set the `X-Zuora-WSDL-Version`
                request

                header to 137 or higher. Otherwise, an error occurs.



                Use this field when you want to set the rollover fund's period
                length shorter than the prepayment charge's validity period. In
                this case, you must set the `rolloverPeriods` field to 1. For
                example, you can define the rollover fund's period length as 5
                months, shorter than the prepayment charge's validity period: a
                year.
              type: integer
            Formula:
              description: >
                The price lookup formula defined for the product rate plan
                charge, which is used to identify the correct and relevant
                charge definition based on the context.


                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing" 
                target="_blank">Price lookup in Attribute-based Pricing</a>.


                **Notes**: 
                  - This field is available only if the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing" target="_blank">Attribute-based Pricing</a> feature is enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 138 or higher.
              type: string
          required:
            - BillCycleType
            - BillingPeriod
            - ChargeModel
            - ChargeType
            - Name
            - ProductRatePlanChargeTierData
            - ProductRatePlanId
            - TriggerEvent
            - UseDiscountSpecificAccountingCode
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
      example:
        Name: One-Time charge
        ProductRatePlanId: 8ad08ae290c4bb470190dedf752745af
        ChargeType: OneTime
        ChargeModel: Flat Fee Pricing
        ProductRatePlanChargeTierData:
          ProductRatePlanChargeTier:
            - Price: 10
        TriggerEvent: ContractEffective
    ProxyGetProductRatePlanCharge:
      allOf:
        - properties:
            AccountingCode:
              description: >
                The accounting code for the charge. Accounting codes group
                transactions that contain similar accounting attributes.
              maxLength: 100
              type: string
            ApplyDiscountTo:
              description: >
                Specifies the type of charges that you want a specific discount
                to apply to. All field values are case sensitive and in
                all-caps.
              enum:
                - ONETIME (1)
                - RECURRING (2)
                - USAGE (4)
                - ONETIMERECURRING (3)
                - ONETIMEUSAGE (5)
                - RECURRINGUSAGE (6)
                - ONETIMERECURRINGUSAGE (7)
              type: string
            BillCycleDay:
              description: >
                Sets the bill cycle day (BCD) for the charge. The BCD determines
                which day of the month customer is billed. The BCD value in the
                account can override the BCD in this object.


                **Character limit**: 2


                **Values**: a valid BCD integer, 1 - 31
              format: int32
              type: integer
            BillCycleType:
              description: >
                Specifies how to determine the billing day for the
                charge.               
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
                - TermStartDay
                - TermEndDay
              type: string
            BillingPeriod:
              description: >
                The billing period for the charge. The start day of the billing
                period is also called the bill cycle day (BCD).
              enum:
                - Month
                - Quarter
                - Annual
                - Semi-Annual
                - Specific Months
                - Subscription Term
                - Week
                - Specific Weeks
                - Specific Days
              type: string
            BillingPeriodAlignment:
              description: >
                Aligns charges within the same subscription if multiple charges
                begin on different dates.
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
                - AlignToTermEnd
              type: string
            BillingTiming:
              description: >
                The billing timing for the charge. You can choose to bill in
                advance or in arrears for recurring charge types. This field is
                not used in one-time or usage based charge types.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              enum:
                - In Advance
                - In Arrears
              type: string
            ChargeFunction:
              description: >
                **Note**: This field is only available if you have the Prepaid
                with Drawdown or Minimum Commitment feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `141` or higher. Otherwise, an error occurs.


                This field defines what type of charge it is:

                * Standard: Normal charge with no Prepayment or Commitment or
                Drawdown.

                * Prepayment: For recurring charges. Unit or currency based
                prepaid charge.

                * CommitmentTrueUp: For recurring charges. Currency based
                minimum commitment charge.

                * Drawdown: For usage charges. Drawdown from prepaid funds.

                * DrawdownAndCreditCommitment: For usage charges. Drawdown from
                prepaid funds and then credit to minimum commitment funds.

                * CreditCommitment: For usage charges. Credit to minimum
                commitment funds.
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            CommitmentType:
              description: >
                **Note**: This field is only available if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
                target="_blank">Prepaid with Drawdown</a> feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `133` or higher. Otherwise, an error occurs. 


                This field defines the type of commitment. A prepaid charge can
                be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge
                can only be `CURRENCY` type. For topup(recurring or one-time)
                charges, this field indicates what type of funds are created. 

                * If UNIT, it will create a fund with given prepaidUom.

                * If CURRENCY, it will create a fund with the currency amount
                calculated in list price.
                  
                For drawdown(usage) charges, this field indicates what type of
                funds are drawdown from that created from topup charges.
              enum:
                - UNIT
                - CURRENCY
              type: string
            ChargeModel:
              description: >
                Determines how to calculate charges. Charge models must be
                individually activated in Zuora Billing administration.
              enum:
                - Discount-Fixed Amount
                - Discount-Percentage
                - Flat Fee Pricing
                - Per Unit Pricing
                - Overage Pricing
                - Tiered Pricing
                - Tiered with Overage Pricing
                - Volume Pricing
                - Delivery Pricing
                - MultiAttributePricing
                - PreratedPerUnit
                - PreratedPricing`
                - HighWatermarkVolumePricing
                - HighWatermarkTieredPricing
              type: string
            ChargeType:
              description: |
                Specifies the type of charge.
              enum:
                - OneTime
                - Recurring
                - Usage
              type: string
            CreatedById:
              description: >
                The automatically generated ID of the Zuora user who created the
                `ProductRatePlanCharge` object.
              maxLength: 32
              type: string
            CreatedDate:
              description: |
                The date when the `ProductRatePlanCharge` object was created.
              format: date-time
              maxLength: 29
              type: string
            DefaultQuantity:
              description: >
                The default quantity of units, such as the number of authors in
                a hosted wiki service. This field is required if you use a
                per-unit pricing model.


                **Character limit**: 16


                **Values**: a valid quantity value.


                **Note**: When `ChargeModel` is `Tiered Pricing` or `Volume
                Pricing`, if this field is not specified, the value will default
                to `0`.
              format: double
              type: number
            DeferredRevenueAccount:
              description: >
                The name of the deferred revenue account for this charge.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              maxLength: 100
              type: string
            Description:
              description: |
                A description of the charge.
              maxLength: 500
              type: string
            DiscountLevel:
              description: >
                Specifies if the discount applies to just the product rate plan,
                the entire subscription, or to any activity in the account.
              enum:
                - rateplan
                - subscription
                - account
              type: string
            EndDateCondition:
              default: SubscriptionEnd
              description: |
                Defines when the charge ends after the charge trigger date.

                **Values**: 
                  - `SubscriptionEnd`: The charge ends on the subscription end date after a specified period based on the trigger date of the charge. 
                  - `FixedPeriod`: The charge ends after a specified period based on the trigger date of the charge. If you set this field to `FixedPeriod`, you must specify the length of the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType` fields. 

                  **Note**: If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.
              enum:
                - SubscriptionEnd
                - FixedPeriod
              type: string
            ExcludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the related invoice items, invoice item
                adjustments, credit memo items, and debit memo items from
                revenue accounting.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.
                  - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            ExcludeItemBookingFromRevenueAccounting:
              description: >
                The flag to exclude the related rate plan charges and order line
                items from revenue accounting.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.
                  - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            Id:
              description: Object identifier.
              type: string
            IncludedUnits:
              description: |
                Specifies the number of units in the base set of units.

                **Character limit**: 16

                **Values**: a positive decimal value
              format: double
              type: number
            LegacyRevenueReporting:
              description: ''
              type: boolean
            ListPriceBase:
              description: |
                The list price base for the product rate plan charge.
              enum:
                - Per Billing Period
                - Per Month
                - Per Week
                - Per Year
                - Per Specific Months
              type: string
            MaxQuantity:
              description: >
                Specifies the maximum number of units for this charge. Use this
                field and the `MinQuantity` field to create a range of units
                allowed in a product rate plan charge.


                **Character limit**: 16


                **Values**: a positive decimal value
              format: double
              type: number
            MinQuantity:
              description: >
                Specifies the minimum number of units for this charge. Use this
                field and the `MaxQuantity` field to create a range of units
                allowed in a product rate plan charge.


                **Character limit**: 16


                **Values**: a positive decimal value
              format: double
              type: number
            Name:
              description: |
                The name of the product rate plan charge.
              maxLength: 100
              type: string
            NumberOfPeriod:
              description: >
                Specifies the number of periods to use when calculating charges
                in an overage smoothing charge model. The valid value is a
                positive whole number.
              format: int64
              type: integer
            OverageCalculationOption:
              description: >
                Determines when to calculate overage charges. If the value of
                the SmoothingMode field is not specified, the value of this
                field is ignored.


                **Values**: 
                  - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.
                  - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.
              enum:
                - EndOfSmoothingPeriod
                - PerBillingPeriod
                - null
              type: string
              nullable: true
            OverageUnusedUnitsCreditOption:
              description: >
                Determines whether to credit the customer with unused units of
                usage.
              enum:
                - NoCredit
                - CreditBySpecificRate
                - null
              type: string
              nullable: true
            PriceChangeOption:
              default: NoChange
              description: >
                Applies an automatic price change when a termed subscription is
                renewed.
              enum:
                - NoChange
                - SpecificPercentageValue
                - UseLatestProductCatalogPricing
                - null
              type: string
              nullable: true
            PriceIncreasePercentage:
              description: >
                Specifies the percentage to increase or decrease the price of a
                termed subscription's renewal. Use this field if you set the
                value to `SpecificPercentageValue`.


                **Character limit**: 16


                **Values**: a decimal value between -100 and 100
              format: double
              type: number
              nullable: true
            ProductRatePlanId:
              description: >
                The ID of the product rate plan associated with this product
                rate plan charge.
              maxLength: 32
              type: string
            ProrationOption:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
                target="_blank">Usage charge proration</a> and <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `135` or higher. Otherwise, an error occurs.


                You can use this field to specify the charge-level proration
                option for a usage charge or recurring charge. The tenant-level
                proration option will be overridden.
                  * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
                  * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
                  * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
                  * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              enum:
                - NoProration
                - TimeBasedProration
                - DefaultFromTenantSetting
                - ChargeFullPeriod
              type: string
            RatingGroup:
              description: >
                A rating group based on which usage records are rated. Only
                applicable to Usage charges.


                Possible values:
                  - `ByBillingPeriod`: The rating is based on all the usages in a billing period.
                  - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. 
                  - `ByUsageRecord`: The rating is based on each usage record.
                  - `ByUsageUpload`: The rating is based on all the  usages in a uploaded usage file (`.xls` or `.csv`).
                  - `ByGroupId`: The rating is based on all the usages in a custom group.

                For more information, see [Usage rating by
                group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group).
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
                - ByGroupId
                - null
              type: string
              nullable: true
            RecognizedRevenueAccount:
              description: >
                The name of the recognized revenue account for this charge.
                  - Required when the Allow Blank Accounting Code setting is No.
                  - Optional when the Allow Blank Accounting Code setting is Yes.

                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              maxLength: 100
              type: string
            RevRecCode:
              description: >
                Associates this product rate plan charge with a specific revenue
                recognition code.
              maxLength: 70
              type: string
              nullable: true
            RevRecTriggerCondition:
              description: |
                Specifies when revenue recognition begins.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              type: string
              nullable: true
            RevenueRecognitionRuleName:
              description: |
                Determines when to recognize the revenue for this charge.
              enum:
                - Recognize upon invoicing
                - Recognize daily over time
              type: string
            SmoothingModel:
              description: >
                Specifies the smoothing model for an overage smoothing charge
                model.
              enum:
                - RollingWindow
                - Rollover
                - null
              type: string
              nullable: true
            SpecificBillingPeriod:
              description: >
                Customizes the number of months or weeks for the charges billing
                period. This field is required if you set the value of the
                BillingPeriod field to `Specific Months` or `Specific Weeks`.

                The valid value is a positive integer.
              format: int64
              type: integer
              nullable: true
            SpecificListPriceBase:
              type: integer
              nullable: true
              description: >
                The number of months for the list price base of the charge. The
                value of this field is `null` if you do not set the value of the
                `ListPriceBase` field to `Per Specific Months`.


                **Notes**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.
                  - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
            TaxCode:
              description: >
                Specifies the tax code for taxation rules. Required when the
                Taxable field is set to `True`.


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              maxLength: 64
              type: string
            TaxMode:
              description: >
                Determines how to define taxation for the charge. Required when
                the Taxable field is set to `True`.


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            Taxable:
              description: >
                Determines whether the charge is taxable. When set to `True`,
                the TaxMode and TaxCode fields are required when creating or
                updating th ProductRatePlanCharge object.


                **Character limit**: 5


                **Values**: `True`, `False`


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              type: boolean
            TriggerEvent:
              description: |
                Specifies when to start billing the customer for the charge.

                **Values**:
                  - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.
                  - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.
                  - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.
              enum:
                - ContractEffective
                - ServiceActivation
                - CustomerAcceptance
              type: string
            UOM:
              description: >
                Specifies the units to measure usage. 


                **Note**: You must specify this field when creating the
                following charge models:
                  - Per Unit Pricing
                  - Volume Pricin
                  - Overage Pricing
                  - Tiered Pricing
                  - Tiered with Overage Pricing
              maxLength: 25
              type: string
              nullable: true
            UpToPeriods:
              description: >
                Specifies the length of the period during which the charge is
                active. If this period ends before the subscription ends, the
                charge ends when this period ends.


                **Character limit**: 5


                **Values**: a whole number between 0 and 65535, exclusive


                **Notes**:
                  - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. 
                  - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.
              format: int64
              type: integer
              nullable: true
            UpToPeriodsType:
              default: Billing Periods
              description: |
                The period type used to define when the charge ends.

                **Notes**: 
                 - You must use this field together with the `UpToPeriods` field to specify the time period.
                 - This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. 
              enum:
                - Billing Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            UpdatedById:
              description: |
                The ID of the last user to update the object.
              maxLength: 32
              type: string
            UpdatedDate:
              description: |
                The date when the object was last updated.
              format: date-time
              maxLength: 29
              type: string
            UseDiscountSpecificAccountingCode:
              description: >
                Determines whether to define a new accounting code for the new
                discount charge.


                **Character limit**: 5


                **Values**: `True`, `False`
              type: boolean
              nullable: true
            UseTenantDefaultForPriceChange:
              description: >
                Applies the tenant-level percentage uplift value for an
                automatic price change to a termed subscription's renewal. 


                **Character limit**: 5


                **Values**: `true`, `false`
              type: boolean
            WeeklyBillCycleDay:
              description: >
                Specifies which day of the week as the bill cycle day (BCD) for
                the charge.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
            IsAllocationEligible:
              description: >
                Indicates whether the charge segment is allocation eligible in
                revenue recognition. The default value is `False`.


                **Values**: `True`, `False`


                **Notes**: 
                  - The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.
              type: boolean
            IsUnbilled:
              description: >
                Specifies how to perform the accounting during revenue
                recognition. The default value is `False`.


                **Values**: `True`, `False`


                **Notes**: 
                  - The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.   
              type: boolean
            ProductCategory:
              description: >
                This field is used to maintain the product category for
                integration with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.
              type: string
            ProductClass:
              description: >
                This field is used to maintain the product class for integration
                with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled. 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.   
              type: string
            ProductFamily:
              description: >
                This field is used to maintain the product family for
                integration with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.
              type: string
            ProductLine:
              description: >
                This field is used to maintain the product line for integration
                with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled. 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.           
              type: string
            ReflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `ReflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `ReflectDiscountInNetAmount` field to `true`, you must also set
                both the `ExcludeItemBookingFromRevenueAccounting` and
                `ExcludeItemBillingFromRevenueAccounting` fields to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `ReflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration customers are not supported with net amount.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `ReflectDiscountInNetAmount` field to
                `true`.
            RevenueRecognitionTiming:
              description: >
                Specifies the type of revenue recognition timing.


                Predefined options are listed as enum values in this API
                Reference. 

                Other options might also be avaliable depending on 

                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled. 
              maxLength: 200
              type: string
              enum:
                - Upon Billing Document Posting Date
                - Upon Order Activation Date
            RevenueAmortizationMethod:
              description: >
                Specifies the type of revenue amortization method.


                Predefined options are listed as enum values in this API
                Reference. 

                Other options might also be avaliable depending on 

                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled. 
              maxLength: 200
              type: string
              enum:
                - Immediate
                - Ratable Using Start And End Dates
            ApplyToBillingPeriodPartially:
              description: >
                Allow the discount duration to be aligned with the billing
                period partially.


                **Note**: You must enable the [Enhanced
                Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
                feature to access this field.
              type: boolean
            Formula:
              description: >
                The price lookup formula defined for the product rate plan
                charge, which is used to identify

                the correct and relevant charge definition based on the context.


                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing" 
                target="_blank">Price lookup in Attribute-based Pricing</a>.



                **Notes**: 
                  - This field is available only if the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing" target="_blank">Attribute-based Pricing</a> feature is enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 138 or higher.
              type: string
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
    ProxyModifyProductRatePlanCharge:
      allOf:
        - properties:
            AccountingCode:
              description: >
                The accounting code for the charge. Accounting codes group
                transactions that contain similar accounting attributes.
              maxLength: 100
              type: string
            ApplyDiscountTo:
              description: >
                Specifies the type of charges that you want a specific discount
                to apply to. All field values are case sensitive and in
                all-caps.
              enum:
                - ONETIME (1)
                - RECURRING (2)
                - USAGE (4)
                - ONETIMERECURRING (3)
                - ONETIMEUSAGE (5)
                - RECURRINGUSAGE (6)
                - ONETIMERECURRINGUSAGE (7)
              type: string
            BillCycleDay:
              description: >
                Sets the bill cycle day (BCD) for the charge. The BCD determines
                which day of the month customer is billed. The BCD value in the
                account can override the BCD in this object.


                **Character limit**: 2 **Values**: a valid BCD integer, 1 - 31
              format: int32
              type: integer
            BillCycleType:
              description: |
                Specifies how to determine the billing day for the charge.

                **Notes**:
                  - If you set this field to `SpecificDayofMonth`, you must specify which day of the month as the billing day for the charge in the BillCycleDay field. 
                  - If you set this field to `SpecificDayofWeek`, you must specify which day of the week as the billing day for the charge in the WeeklyBillCycleDay field. 
                  - By default, `TermStartDay` and `TermEndDay` are only available for prepayment charges. But you can reach out to Zuora Global Support to request enabling it for non-prepaid recurring charges. Meanwhile, note the following rules applies to these options:
                    - The Term End Day option of the Billing Day field must be coupled with the Align to Term End option of the Billing Period Alignment field.
                    - For prepaid charges, the Term Start Day option of the Billing Day field must be coupled with the existing Align to Term Start option of the Billing Period Alignment field.
                    - For non-prepaid recurring charges: If Billing Day is set to Term Start Day, Billing Period Alignment must be Align to Term Start; If Billing Day is set to Term End Day, Billing Period Alignment can be set to other values.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
                - TermStartDay
                - TermEndDay
              type: string
            BillingPeriod:
              description: >
                The billing period for the charge. The start day of the billing
                period is also called the bill cycle day (BCD).


                **Notes**:
                  - Specify the number of months or weeks in the SpecificBillingPeriod field if you set this field to `Specific Months` or `Specific Weeks`.
                  - The `Subscription Term` value is in **Limited Availability**.
              enum:
                - Month
                - Quarter
                - Annual
                - Semi-Annual
                - Specific Months
                - Subscription Term
                - Week
                - Specific Weeks
                - Specific Days
              type: string
            BillingPeriodAlignment:
              description: >
                Aligns charges within the same subscription if multiple charges
                begin on different dates.


                **Note:** The `AlignToTermEnd` value is only available for
                prepayment charges by default. Reach out to Zuora Global Support
                to enable it for non-prepaid recurring charges.
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
                - AlignToTermEnd
              type: string
            BillingTiming:
              description: >
                The billing timing for the charge. You can choose to bill in
                advance or in arrears for recurring charge types. This field is
                not used in one-time or usage based charge types.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              enum:
                - In Advance
                - In Arrears
              type: string
            ChargeFunction:
              description: >
                **Note**: This field is only available if you have the Prepaid
                with Drawdown or Minimum Commitment feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `141` or higher. Otherwise, an error occurs.


                This field defines what type of charge it is:

                * Standard: Normal charge with no Prepayment or Commitment or
                Drawdown.

                * Prepayment: For recurring charges. Unit or currency based
                prepaid charge.

                * CommitmentTrueUp: For recurring charges. Currency based
                minimum commitment charge.

                * Drawdown: For usage charges. Drawdown from prepaid funds.

                * DrawdownAndCreditCommitment: For usage charges. Drawdown from
                prepaid funds and then credit to minimum commitment funds.

                * CreditCommitment: For usage charges. Credit to minimum
                commitment funds.
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            CommitmentType:
              description: >
                **Note**: This field is only available if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
                target="_blank">Prepaid with Drawdown</a> feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `133` or higher. Otherwise, an error occurs. 


                This field defines the type of commitment. A prepaid charge can
                be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge
                can only be `CURRENCY` type. For topup(recurring or one-time)
                charges, this field indicates what type of funds are created. 

                * If UNIT, it will create a fund with given prepaidUom.

                * If CURRENCY, it will create a fund with the currency amount
                calculated in list price.


                For drawdown(usage) charges, this field indicates what type of
                funds are drawdown from that created from topup charges.
              enum:
                - UNIT
                - CURRENCY
              type: string
            ChargeModel:
              description: >
                Determines how to calculate charges. Charge models must be
                individually activated in Zuora Billing administration.


                **Notes:**
                  - The `Delivery Pricing` value is available only if you have the Delivery Pricing charge model enabled.
                  - The `MultiAttributePricing` value is available only if you have the Multi-Attribute Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.       
                  - The `PreratedPerUnit` and  value is available only if you have the Pre-rated Per Unit Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.       
                  - The `PreratedPricing` value is available only if you have the Pre-rated Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.     
                  - The `HighWatermarkVolumePricing`value is available only if you have the High Water Mark Volume Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.       
                  - The `HighWatermarkTieredPricing` value is available only if you have the High Water Mark Tiered Pricing charge model enabled. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.
              enum:
                - Discount-Fixed Amount
                - Discount-Percentage
                - Flat Fee Pricing
                - Per Unit Pricing
                - Overage Pricing
                - Tiered Pricing
                - Tiered with Overage Pricing
                - Volume Pricing
                - Delivery Pricing
                - MultiAttributePricing
                - PreratedPerUnit
                - PreratedPricing`
                - HighWatermarkVolumePricing
                - HighWatermarkTieredPricing
              type: string
            ChargeModelConfiguration:
              $ref: >-
                #/components/schemas/ProxyCreateOrModifyProductRatePlanChargeChargeModelConfiguration
            CreditOption:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The way to calculate credit. See [Credit
                Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
                for more information. 
              enum:
                - TimeBased
                - ConsumptionBased
                - FullCreditBack
              type: string
            DefaultQuantity:
              description: >
                The default quantity of units, such as the number of authors in
                a hosted wiki service. This field is required if you use a
                per-unit pricing model. 


                **Character limit**: 16


                **Values**: a valid quantity value. 


                **Note:** When the `ChargeModel` field is set to `Tiered
                Pricing` or `Volume Pricing`, if this field is not specified,
                the value will default to `0`.
              format: double
              type: number
            DeferredRevenueAccount:
              description: >
                The name of the deferred revenue account for this charge.


                **Note**: `AccountingCode` value is mandatory to update this
                field. Specify the same accounting code name as given in the
                `AccountingCode`. 
              maxLength: 100
              type: string
            DeliverySchedule:
              $ref: '#/components/schemas/ProxyCreateOrModifyDeliverySchedule'
            Description:
              description: |
                A description of the charge.
              maxLength: 500
              type: string
            DiscountLevel:
              description: >
                Specifies if the discount applies to just the product rate plan,
                the entire subscription, or to any activity in the account.
              enum:
                - rateplan
                - subscription
                - account
              type: string
            DrawdownRate:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                The [conversion
                rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
                between Usage UOM and Drawdown UOM for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
                See [Fields related to Prepaid with
                Drawdown](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/ProductRatePlanCharge#Fields_related_to_Prepaid_with_Drawdown)
                for more information.
              type: number
            DrawdownUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                Unit of measurement for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). 
              type: string
            EndDateCondition:
              default: SubscriptionEnd
              description: |
                Defines when the charge ends after the charge trigger date.

                **Values**:
                  - `SubscriptionEnd`: The charge ends on the subscription end date after a specified period based on the trigger date of the charge.  
                  - `FixedPeriod`: The charge ends after a specified period based on the trigger date of the charge. If you set this field to `FixedPeriod`, you must specify the length of the period and a period type by defining the `UpToPeriods` and `UpToPeriodsType` fields. 

                  **Note**: If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.
              enum:
                - SubscriptionEnd
                - FixedPeriod
              type: string
            ExcludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the related invoice items, invoice item
                adjustments, credit memo items, and debit memo items from
                revenue accounting.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.
                  - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            ExcludeItemBookingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the related rate plan charges and order line
                items from revenue accounting.


                **Notes**: 
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `115` or later. Otherwise, an error occurs.
                  - This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            IncludedUnits:
              description: |
                Specifies the number of units in the base set of units.

                **Character limit**: 16

                **Values**: a positive decimal value
              format: double
              type: number
            IsAllocationEligible:
              description: >
                Indicates whether the charge segment is allocation eligible in
                revenue recognition. The default value is `False`.


                **Values**: `True`, `False`


                **Notes**: 
                  - The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.
              type: boolean
            IsPrepaid:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                Indicates whether this charge is a prepayment (topup) charge or
                a drawdown charge. 


                **Values**: `true` or `false`.
              type: boolean
            IsRollover:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                The value is either "True" or "False". It determines whether the
                rollover fields are needed.
              type: boolean
            IsStackedDiscount:
              description: >
                **Note**: This field is only applicable to the Discount -
                Percentage charge model.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 130 or higher. Otherwise, an error occurs.


                This field indicates whether the discount is to be calculated as
                stacked discount. Possible values are as follows:
                  - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.
                  - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.

                For more information, see [Stacked
                discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).      
              type: boolean
            IsUnbilled:
              description: >
                Specifies how to perform the accounting during revenue
                recognition. The default value is `False`.


                **Values**: `True`, `False`


                **Notes**: 
                  - The field is only available if you have the <a href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue" target="_blank">Order to Revenue</a> feature enabled. To enable this field, submit a request at <a href="https://support.zuora.com/" target="_blank">Zuora Global Support</a>.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.
              type: boolean
            LegacyRevenueReporting:
              description: ''
              type: boolean
            ListPriceBase:
              description: |
                The list price base for the product rate plan charge.
              enum:
                - Per Billing Period
                - Per Month
                - Per Week
                - Per Year
                - Per Specific Months
              type: string
            MaxQuantity:
              description: >
                Specifies the maximum number of units for this charge. Use this
                field and the `MinQuantity` field to create a range of units
                allowed in a product rate plan charge.


                **Character limit**: 16


                **Values**: a positive decimal value
              format: double
              type: number
            MinQuantity:
              description: >
                Specifies the minimum number of units for this charge. Use this
                field and the `MaxQuantity` field to create a range of units
                allowed in a product rate plan charge.


                **Character limit**: 16


                **Values**: a positive decimal value
              format: double
              type: number
            Name:
              description: |
                The name of the product rate plan charge.
              maxLength: 100
              type: string
            NumberOfPeriod:
              description: >
                Specifies the number of periods to use when calculating charges
                in an overage smoothing charge model. The valid value must be a
                positive whole number.
              format: int64
              type: integer
            OverageCalculationOption:
              description: >
                Determines when to calculate overage charges. If the value of
                the SmoothingMode field is not specified, the value of this
                field is ignored.


                **Values**: 
                  - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.
                  - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.
              enum:
                - EndOfSmoothingPeriod
                - PerBillingPeriod
                - null
              type: string
              nullable: true
            OverageUnusedUnitsCreditOption:
              description: >
                Determines whether to credit the customer with unused units of
                usage.
              enum:
                - NoCredit
                - CreditBySpecificRate
                - null
              type: string
              nullable: true
            PrepaidQuantity:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The number of units included in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
                Must be a positive number.
              type: number
            PrepaidUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                Unit of measurement for a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              type: string
            PriceChangeOption:
              default: NoChange
              description: >
                Applies an automatic price change when a termed subscription is
                renewed.
              enum:
                - NoChange
                - SpecificPercentageValue
                - UseLatestProductCatalogPricing
                - null
              type: string
              nullable: true
            PriceIncreaseOption:
              description: >
                Applies an automatic price change when a termed subscription is
                renewed.
              enum:
                - FromTenantPercentageValue
                - SpecificPercentageValue
              type: string
            PriceIncreasePercentage:
              description: >
                Specifies the percentage to increase or decrease the price of a
                termed subscription's renewal. Use this field if you set the
                value to `SpecificPercentageValue`.


                **Character limit**: 16


                **Values**: a decimal value between -100 and 100
              format: double
              type: number
              nullable: true
            ProductCategory:
              description: >
                This field is used to maintain the product category for
                integration with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later. 
              type: string
            ProductClass:
              description: >
                This field is used to maintain the product class for integration
                with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.
              type: string
            ProductFamily:
              description: >
                This field is used to maintain the product family for
                integration with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.
              type: string
            ProductLine:
              description: >
                This field is used to maintain the product line for integration
                with Zuora Revenue. 


                **Notes**: 
                  - This field is available only if you have the Additional Revenue Fields property enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 132 or later.              
              type: string
            ProrationOption:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
                target="_blank">Usage charge proration</a> and <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to  `135` or higher. Otherwise, an error occurs.


                You can use this field to specify the charge-level proration
                option for a usage charge or recurring charge. The tenant-level
                proration option will be overridden.
                  * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
                  * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
                  * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
                  * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              enum:
                - NoProration
                - TimeBasedProration
                - DefaultFromTenantSetting
                - ChargeFullPeriod
              type: string
            RevenueRecognitionTiming:
              description: >
                Specifies the type of revenue recognition timing.


                Predefined options are listed as enum values in this API
                Reference. 

                Other options might also be avaliable depending on 

                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 140 or higher. Otherwise, an error occurs.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled. 
              maxLength: 200
              type: string
              enum:
                - Upon Billing Document Posting Date
                - Upon Order Activation Date
            RevenueAmortizationMethod:
              description: >
                Specifies the type of revenue amortization method.


                Predefined options are listed as enum values in this API
                Reference. 

                Other options might also be avaliable depending on 

                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 140 or higher. Otherwise, an error occurs.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled. 
              maxLength: 200
              type: string
              enum:
                - Immediate
                - Ratable Using Start And End Dates
            ProductRatePlanChargeNumber:
              description: >
                The natural key of the product rate plan charge. 


                For existing Product Rate Plan Charge objects that are created
                before this field is introduced, this field will be null. Use
                this field to specify a value for only these objects. Zuora also
                provides a tool to help you automatically backfill this field
                with tenant ID for your existing product catalog. If you want to
                use this backfill tool, contact [Zuora Global
                Support](https://support.zuora.com/).


                **Note**: This field is only available if you set the
                `X-Zuora-WSDL-Version` request header to `133` or later.
              maxLength: 100
              type: string
            ProductRatePlanChargeTierData:
              $ref: >-
                #/components/schemas/ProxyCreateOrModifyProductRatePlanChargeTierData
            ProductRatePlanId:
              description: >
                The ID of the product rate plan associated with this product
                rate plan charge.
              maxLength: 32
              type: string
            RatingGroup:
              default: ByBillingPeriod
              description: |
                Specifies a rating group based on which usage records are rated.

                Possible values:
                  - `ByBillingPeriod`: The rating is based on all the usages in a billing period. 
                  - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. 
                  - `ByUsageRecord`: The rating is based on each usage record.
                  - `ByUsageUpload`: The rating is based on all the  usages in a uploaded usage file (`.xls` or `.csv`).
                  - `ByGroupId`: The rating is based on all the usages in a custom group.

                **Note:** 
                  - The `ByBillingPeriod` value can be applied for all charge models. 
                  - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. 
                  - The `ByGroupId` value is only available if you have the Active Rating feature enabled.
                  - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
                - ByGroupId
                - null
              type: string
              nullable: true
            RecognizedRevenueAccount:
              description: |
                The name of the recognized revenue account for this charge.
                  - Required when the Allow Blank Accounting Code setting is No.
                  - Optional when the Allow Blank Accounting Code setting is Yes.

                  This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). 
              maxLength: 100
              type: string
            RevRecCode:
              description: >
                Associates this product rate plan charge with a specific revenue
                recognition code.
              maxLength: 70
              type: string
              nullable: true
            RevRecTriggerCondition:
              description: |
                Specifies when revenue recognition begins.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
                - null
              type: string
              nullable: true
            RevenueRecognitionRuleName:
              description: |
                Determines when to recognize the revenue for this charge.
              enum:
                - Recognize upon invoicing
                - Recognize daily over time
              type: string
            RolloverApply:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                This field defines the priority of rollover, which is either
                first or last.
              enum:
                - ApplyFirst
                - ApplyLast
              type: string
            RolloverPeriods:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs.


                This field defines the number of rollover periods, it is
                restricted to 3.
              type: number
            SmoothingModel:
              description: >
                Specifies the smoothing model for an overage smoothing charge
                model.
              enum:
                - RollingWindow
                - Rollover
                - null
              type: string
              nullable: true
            SpecificBillingPeriod:
              description: >
                Customizes the number of months or weeks for the charges billing
                period. This field is required if you set the value of the
                BillingPeriod field to `Specific Months` or `Specific Weeks`.

                The valid value is a positive integer.
              format: int64
              type: integer
              nullable: true
            SpecificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `ListPriceBase`
                field to `Per Specific Months`.


                **Notes**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.
                  - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
              format: int32
              maximum: 200
              minimum: 1
              type: integer
              nullable: true
            TaxCode:
              description: >
                Specifies the tax code for taxation rules. Required when the
                Taxable field is set to `True`.


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              maxLength: 64
              type: string
            TaxMode:
              description: >
                Determines how to define taxation for the charge. Required when
                the Taxable field is set to `True`.


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              enum:
                - TaxExclusive
                - TaxInclusive
                - null
              type: string
              nullable: true
            Taxable:
              description: >
                Determines whether the charge is taxable. When set to `True`,
                the TaxMode and TaxCode fields are required when creating or
                updating th ProductRatePlanCharge object.


                **Character limit**: 5


                **Values**: `True`, `False`


                **Note**: This value affects the tax calculation of rate plan
                charges that come from the `ProductRatePlanCharge`.
              type: boolean
            TriggerEvent:
              description: |
                Specifies when to start billing the customer for the charge.

                **Values**:
                  - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.
                  - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.
                  - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.
              enum:
                - ContractEffective
                - ServiceActivation
                - CustomerAcceptance
              type: string
            UOM:
              description: >
                Specifies the units to measure usage. 


                **Note**: You must specify this field when creating the
                following charge models:
                  - Per Unit Pricing
                  - Volume Pricing
                  - Overage Pricing
                  - Tiered Pricing
                  - Tiered with Overage Pricing
              maxLength: 25
              type: string
              nullable: true
            UpToPeriods:
              description: >
                Specifies the length of the period during which the charge is
                active. If this period ends before the subscription ends, the
                charge ends when this period ends.


                **Character limit**: 5


                **Values**: a whole number between 0 and 65535, exclusive


                **Notes**:
                  - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. 
                  - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.
              format: int64
              type: integer
              nullable: true
            UpToPeriodsType:
              default: Billing Periods
              description: |
                The period type used to define when the charge ends.

                **Notes**: 
                 - You must use this field together with the `UpToPeriods` field to specify the time period.
                 - This field is applicable only when the `EndDateCondition` field is set to `FixedPeriod`. 
              enum:
                - Billing Periods
                - Days
                - Weeks
                - Months
                - Years
                - null
              type: string
              nullable: true
            UsageRecordRatingOption:
              default: EndOfBillingPeriod
              description: >
                Determines how Zuora processes usage records for per-unit usage
                charges. 
              enum:
                - EndOfBillingPeriod
                - OnDemand
                - null
              type: string
              nullable: true
            UseDiscountSpecificAccountingCode:
              description: >
                Determines whether to define a new accounting code for the new
                discount charge.


                **Character limit**: 5


                **Values**: `True`, `False`
              type: boolean
              nullable: true
            UseTenantDefaultForPriceChange:
              description: >
                Applies the tenant-level percentage uplift value for an
                automatic price change to a termed subscription's renewal. 


                **Character limit**: 5


                **Values**: `true`, `false`
              type: boolean
            ValidityPeriodType:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 


                The period in which the prepayment units are valid to use as
                defined in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              enum:
                - SUBSCRIPTION_TERM
                - ANNUAL
                - SEMI_ANNUAL
                - QUARTER
                - MONTH
              type: string
            WeeklyBillCycleDay:
              description: >
                Specifies which day of the week as the bill cycle day (BCD) for
                the charge.


                This feature is in **Limited Availability**. If you wish to have
                access to the feature, submit a request at [Zuora Global
                Support](http://support.zuora.com/). 
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
            ApplyToBillingPeriodPartially:
              description: >
                Allow the discount duration to be aligned with the billing
                period partially.


                **Note**: You must enable the [Enhanced
                Discount](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
                feature to access this field.
              type: boolean
            RolloverPeriodLength:
              default: null
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with

                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

                feature enabled.



                To use this field, you must set the `X-Zuora-WSDL-Version`
                request

                header to 137 or higher. Otherwise, an error occurs.



                Use this field when you want to set the rollover fund's period
                length shorter than the prepayment charge's validity period. In
                this case, you must set the `rolloverPeriods` field to 1. For
                example, you can define the rollover fund's period length as 5
                months, shorter than the prepayment charge's validity period: a
                year.
              type: integer
            Formula:
              description: >
                The price lookup formula defined for the product rate plan
                charge, which is used to identify

                the correct and relevant charge definition based on the context.


                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing/Price_lookup_in_Attribute-based_Pricing" 
                target="_blank">Price lookup in Attribute-based Pricing</a>.



                **Notes**: 
                  - This field is available only if the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Attribute-based_pricing" target="_blank">Attribute-based Pricing</a> feature is enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to 138 or higher.
              type: string
          required:
            - BillCycleType
            - BillingPeriod
            - ChargeModel
            - ProductRatePlanChargeTierData
            - ProductRatePlanId
            - TriggerEvent
            - UseDiscountSpecificAccountingCode
          type: object
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectNSFields'
        - $ref: '#/components/schemas/ProductRatePlanChargeObjectCustomFields'
      example:
        Name: One-Time charge
    ProductChargeDefinitionObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Product Charge Definition object. The name of
          each custom field has the form of <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Product Charge Definition object.
      title: productChargeDefinitionFieldsCustom
      type: object
    GETChargeDefinitionPricingTier:
      description: |
        An array of charge pricing tiers.
      items:
        properties:
          currency:
            description: |
              The code corresponding to the currency for the tier's price.
            type: string
          discountAmount:
            description: >
              The specific amount for a fixed discount. The field is applicable
              only for charges based on the Discount-Fixed Amount charge model.
            format: double
            type: number
          discountPercentage:
            description: >
              The percentage of discount for a percentage discount. The field is
              applicable only for charges based on the Discount-Percentage
              charge model.
            format: double
            type: number
          endingUnit:
            description: >
              The end number of a range of units for the tier. The field is
              applicable only for charges based on the Tiered Pricing or Tiered
              with Overage Pricing charge model.
            format: double
            type: number
          overagePrice:
            description: >
              Indicates whether the price is an overage price, which is the
              price when usage surpasses the last defined tier.
            format: double
            type: number
          price:
            description: >
              The price of the tier if the price format is flat fee, or the
              price of each unit in the tier if the price format is per unit.
            format: double
            type: number
          startingUnit:
            description: >
              The starting number of a range of units for the tier. The field is
              applicable only for charges based on the Tiered Pricing or Tiered
              with Overage Pricing charge model.
            format: double
            type: number
        type: object
      title: pricingTiers
      type: array
    GETProductChargeDefinitionPricing:
      properties:
        currency:
          description: |
            The currency for the price.
          type: string
        discountAmount:
          description: >
            The specific amount for a fixed discount. The field is applicable
            only for charges based on the Discount-Fixed Amount charge model.
          format: double
          type: number
        discountPercentage:
          description: >
            The percentage of discount for a percentage discount. The field is
            applicable only for charges based on the Discount-Percentage charge
            model.
          format: double
          type: number
        includedUnits:
          description: >
            The number of units included in this price item. 


            This field is only applicable for charges based on the Overage
            Pricing charge model.
          type: number
        overagePrice:
          description: >
            The overage price of the price item. 


            This field is only applicable for charges based on the Overage
            Pricing or Tiered with Overage Pricing charge model.
          type: number
        price:
          description: >
            The price of this item. 


            This field is only applicable for charges based on the following
            charge models:
              - Flat Fee
              - Per Unit
              - Delivery Pricing
          type: number
        tiers:
          description: >
            Container for the tiers of the price item. 


            This field is only applicable for charges based on the following
            charge models:
              - Tiered Pricing
              - Volume Pricing
              - Tiered with Overage Pricing
          items:
            $ref: '#/components/schemas/GETChargeDefinitionPricingTier'
          type: array
      title: prices
      type: object
    GETProductChargeDefinitionsResponse:
      properties:
        chargeDefinitions:
          description: |
            The list of the product charge definitions that are retrieved.
          items:
            properties:
              applyDiscountTo:
                description: |
                  Indicates which type of charge the discount charge applies to.
                enum:
                  - ONETIME
                  - RECURRING
                  - USAGE
                  - ONETIMERECURRING
                  - ONETIMEUSAGE
                  - RECURRINGUSAGE
                  - ONETIMERECURRINGUSAGE
                  - null
                type: string
                nullable: true
              billingDay:
                description: |
                  The bill cycle type for the charge.
                type: string
              billingPeriod:
                description: |
                  The billing period for the product charge definition.
                type: string
              billingPeriodAlignment:
                description: |
                  The billing period alignment setting for the charge.
                enum:
                  - AlignToCharge
                  - AlignToSubscriptionStart
                  - AlignToTermStart
                  - AlignToTermEnd
                type: string
              billingTiming:
                description: |
                  The billing timing setting for the product charge definition.
                enum:
                  - IN_ADVANCE
                  - IN_ARREARS
                type: string
              chargeModel:
                description: >
                  Determines how to calculate charges. Charge models must be
                  individually activated in Zuora Billing administration.
                enum:
                  - DiscountFixedAmount
                  - DiscountPercentage
                  - FlatFee
                  - PerUnit
                  - Overage
                  - Tiered
                  - TieredWithOverage
                  - Volume
                  - Delivery
                  - MultiAttributePricing
                  - PreratedPerUnit
                  - PreratedPricing
                  - HighWatermarkVolumePricing
                  - HighWatermarkTieredPricing
                type: string
              chargeType:
                description: |
                  Indicates the type of charge.
                enum:
                  - OneTime
                  - Recurring
                  - Usage
                type: string
              customFields:
                $ref: '#/components/schemas/ProductChargeDefinitionObjectCustomFields'
              defaultQuantity:
                description: >
                  The default quantity. 


                  This field is applicable only for one-time and recurring
                  charges.
                type: number
                nullable: true
              deliverySchedule:
                $ref: '#/components/schemas/GETDeliverySchedule'
              description:
                description: |
                  The description for the charge.
                type: string
              discountClass:
                description: >
                  The class that the discount belongs to. The discount class
                  defines the order in which discount product rate plan charges
                  are applied.


                  For more information, see [Manage Discount
                  Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).
                type: string
                nullable: true
              discountLevel:
                description: >
                  The application scope of the discount charge. For example, if
                  the value of this field is `subscription` and the value of the
                  `applyDiscountTo` field is `RECURRING`, the discount charge
                  applies to all recurring charges in the same subscription as
                  the discount charge.
                enum:
                  - rateplan
                  - subscription
                  - account
                  - null
                type: string
                nullable: true
              effectiveEndDate:
                description: |
                  The effective end date of the product charge definition.
                format: date-time
                type: string
              effectiveStartDate:
                description: |
                  The effective start date of the product charge definition.
                format: date-time
                type: string
              endDateCondition:
                description: |
                  The end date condition for this charge.
                enum:
                  - Subscription_End
                  - One_Time
                  - Fixed_Period
                  - Specific_End_Date
                type: string
              excludeItemBillingFromRevenueAccounting:
                type: boolean
                description: >
                  Indicates whether to exclude the related invoice items,
                  invoice item adjustments, credit memo items, and debit memo
                  items from revenue accounting.


                  **Note**: This field is only available if you have the Order
                  to Revenue or Billing - Revenue Integration feature enabled. 
              excludeItemBookingFromRevenueAccounting:
                type: boolean
                description: >
                  Indicates whether to exclude the related rate plan charges and
                  order line items from revenue accounting.


                  **Note**: This field is only available if you have the Order
                  to Revenue or Billing - Revenue Integration feature enabled.
              isAllocationEligible:
                type: boolean
                description: >
                  Indicates whether the charge segment is allocation eligible in
                  revenue recognition. The default value is `false`.


                  **Values**: `true`, `false`


                  **Note**: The field is only available if you have the <a
                  href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                  target="_blank">Order to Revenue</a> feature enabled. To
                  enable this field, submit a request at <a
                  href="https://support.zuora.com/" target="_blank">Zuora Global
                  Support</a>.
              isUnbilled:
                type: boolean
                description: >
                  Specifies how to perform the accounting during revenue
                  recognition. The default value is `false`.


                  **Values**: `true`, `false`


                  **Note**: The field is only available if you have the <a
                  href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                  target="_blank">Order to Revenue</a> feature enabled. To
                  enable this field, submit a request at <a
                  href="https://support.zuora.com/" target="_blank">Zuora Global
                  Support</a>.    
              productCategory:
                type: string
                description: >
                  This field is used to maintain the product category for
                  integration with Zuora Revenue. 


                  **Note**: This field is available only if you have the
                  Additional Revenue Fields property enabled.    
              productClass:
                type: string
                description: >
                  This field is used to maintain the product class for
                  integration with Zuora Revenue. 


                  **Note**: This field is available only if you have the
                  Additional Revenue Fields property enabled.    
              productFamily:
                type: string
                description: >
                  This field is used to maintain the product family for
                  integration with Zuora Revenue. 


                  **Note**: This field is available only if you have the
                  Additional Revenue Fields property enabled.
              productLine:
                type: string
                description: >
                  This field is used to maintain the product line for
                  integration with Zuora Revenue. 


                  **Note**: This field is available only if you have the
                  Additional Revenue Fields property enabled.
              revenueRecognitionTiming:
                description: >
                  Specifies the type of revenue recognition timing.


                  Predefined options are listed as enum values in this API
                  Reference. 

                  Other options might also be avaliable depending on 

                  the <a
                  href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                  target="_blank">revenue recognition policy configuration</a>
                  in the Zuora Billing UI.


                  **Note**: This field is only available if you have the Order
                  to Revenue feature enabled. 
                maxLength: 200
                type: string
                enum:
                  - Upon Billing Document Posting Date
                  - Upon Order Activation Date
              revenueAmortizationMethod:
                description: >
                  Specifies the type of revenue amortization method.


                  Predefined options are listed as enum values in this API
                  Reference. 

                  Other options might also be avaliable depending on 

                  the <a
                  href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                  target="_blank">revenue recognition policy configuration</a>
                  in the Zuora Billing UI.


                  **Note**: This field is only available if you have the Order
                  to Revenue feature enabled. 
                maxLength: 200
                type: string
                enum:
                  - Immediate
                  - Ratable Using Start And End Dates
              numberOfPeriods:
                description: >
                  Specifies the number of periods to use when calculating
                  charges in an overage smoothing charge model.

                  This field is ued when overage smoothing model is
                  `RollingWindow` or `Rollover`.
                format: int64
                type: integer
                nullable: true
              financeInformation:
                description: |
                  Container for finance information of the rate plan charge.
                properties:
                  accountsReceivableAccountingCode:
                    description: |
                      The accounting code for accounts receivable.
                    type: string
                    nullable: true
                  accountsReceivableAccountingCodeType:
                    description: |
                      The type of the accounting code for accounts receivable.
                    type: string
                    nullable: true
                  adjustmentLiabilityAccountingCode:
                    description: >
                      The accounting code for adjustment liability. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  adjustmentLiabilityAccountingCodeType:
                    description: >
                      The type associated with the adjustment liability
                      accounting code. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                    nullable: true
                  adjustmentRevenueAccountingCode:
                    description: >
                      The accounting code for adjustment revenue. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  adjustmentRevenueAccountingCodeType:
                    description: >
                      The type associated with the adjustment revenue accounting
                      code. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                    nullable: true
                  contractAssetAccountingCode:
                    description: >
                      The accounting code for contract asset. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  contractAssetAccountingCodeType:
                    description: >
                      The type associated with the contract asset accounting
                      code. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  contractLiabilityAccountingCode:
                    description: >
                      The accounting code for contract liability. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  contractLiabilityAccountingCodeType:
                    description: >
                      The type associated with the contract liability accounting
                      code. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  contractRecognizedRevenueAccountingCode:
                    description: >
                      The accounting code for contract recognized revenue. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  contractRecognizedRevenueAccountingCodeType:
                    description: >
                      The type associated with the contract recognized revenue
                      accounting code. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  deferredRevenueAccountingCode:
                    description: >
                      The accounting code for deferred revenue, such as Monthly
                      Recurring Liability.
                    type: string
                  deferredRevenueAccountingCodeType:
                    description: >
                      The type associated with the deferred revenue accounting
                      code, such as Deferred Revenue. 
                    type: string
                    nullable: true
                  recognizedRevenueAccountingCode:
                    description: >
                      The accounting code for recognized revenue, such as
                      Monthly Recurring Charges or Overage Charges.
                    type: string
                  recognizedRevenueAccountingCodeType:
                    description: >
                      The type associated with the recognized revenue accounting
                      code, such as Sales Revenue or Sales Discount.
                    type: string
                    nullable: true
                  unbilledReceivablesAccountingCode:
                    description: >
                      The accounting code for unbilled receivables. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                  unbilledReceivablesAccountingCodeType:
                    description: >
                      The type associated with the unbilled receivables
                      accounting code. 


                      **Note**: This field is only available if you have the
                      Zuora Billing - Revenue Integration feature enabled.
                    type: string
                title: financeInformation
                type: object
              isDefault:
                description: >
                  Indicates whether this charge definition is the default one
                  for the charge.
                type: boolean
              isStackedDiscount:
                description: >
                  **Note**: This field is only applicable to the Discount -
                  Percentage charge model.


                  To use this field, you must set the `X-Zuora-WSDL-Version`
                  request header to 130 or higher. Otherwise, an error occurs.


                  This field indicates whether the discount is to be calculated
                  as stacked discount. Possible values are as follows:
                    - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.
                    - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.

                  For more information, see [Stacked
                  discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
                type: boolean
              listPriceBase:
                description: >
                  The list price base. 


                  This field is applicable only for recurring charges.


                  **Note**: The `Per_Year` enum value is available only if you
                  have the <a
                  href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
                  target="_blank">Annual List Price</a> feature enabled.
                enum:
                  - Per_Billing_Period
                  - Per_Month
                  - Per_Week
                  - Per_Year
                type: string
              numberOfPeriod:
                description: >
                  Indicates the number of periods to use when calculating
                  charges in an overage smoothing charge model. The valid value
                  is a positive whole number.
                format: int64
                type: integer
              overageCalculationOption:
                description: >
                  Determines when to calculate overage charges. If the value of
                  the `SmoothingMode` field is not specified, the value of this
                  field is ignored.


                  **Values**: 
                    - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.
                    - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.
                enum:
                  - EndOfSmoothingPeriod
                  - PerBillingPeriod
                  - null
                type: string
                nullable: true
              overageUnusedUnitsCreditOption:
                description: >
                  Determines whether to credit the customer with unused units of
                  usage.
                enum:
                  - NoCredit
                  - CreditBySpecificRate
                  - null
                type: string
                nullable: true
              priceChangeOption:
                default: NoChange
                description: >
                  Applies an automatic price change when a termed subscription
                  is renewed.
                enum:
                  - NoChange
                  - SpecificPercentageValue
                  - UseLatestProductCatalogPricing
                  - null
                type: string
                nullable: true
              priceIncreaseOption:
                description: >
                  Applies an automatic price change when a termed subscription
                  is renewed.
                enum:
                  - FromTenantPercentageValue
                  - SpecificPercentageValue
                type: string
              priceIncreasePercentage:
                description: >
                  Specifies the percentage to increase or decrease the price of
                  a termed subscription's renewal. Use this field if you set the
                  `priceIncreaseOption` value to `SpecificPercentageValue`.


                  **Character limit**: 16


                  **Values**: a decimal value between -100 and 100
                format: double
                type: number
                nullable: true
              prices:
                description: |
                  Container for the prices of the product charge definition.
                items:
                  $ref: '#/components/schemas/GETProductChargeDefinitionPricing'
                type: array
              productChargeDefinitionId:
                description: |
                  The unique ID of the product charge definition.
                type: string
              productChargeDefinitionNumber:
                description: >
                  The unique number (natural key) of the product charge
                  definition.
                type: string
              productDiscountApplyDetails:
                description: >
                  Container for the application details about a discount product
                  rate plan charge. 


                  Only discount product rate plan charges have values for this
                  field.
                items:
                  $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
                type: array
              productRatePlanChargeId:
                description: |
                  The unique ID of the product charge of the charge definition.
                type: string
              productRatePlanChargeNumber:
                description: >
                  The unique number (natural key) of the product charge of the
                  charge definition.
                type: string
                nullable: true
              productRatePlanId:
                description: >
                  The unique ID of the product rate plan that uses this charge
                  definition.
                type: string
                nullable: true
              productRatePlanName:
                description: >
                  Th name of the product rate plan that uses this charge
                  definition.
                type: string
                nullable: true
              productRatePlanNumber:
                description: >
                  The unique number (natural key) of the product rate plan that
                  uses this charge definition.
                type: string
                nullable: true
              ratingGroup:
                default: ByBillingPeriod
                description: |
                  The rating group based on which usage records are rated.

                  Possible values:                
                    - `ByBillingPeriod`: The rating is based on all the usages in a billing period. 
                    - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. 
                    - `ByUsageRecord`: The rating is based on each usage record.
                    - `ByUsageUpload`: The rating is based on all the  usages in a uploaded usage file (`.xls` or `.csv`).
                    - `ByGroupId`: The rating is based on all the usages in a custom group.

                  **Notes:** 
                    - The `ByBillingPeriod` value can be applied for all charge models. 
                    - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for Per Unit, Volume Pricing, and Tiered Pricing charge models. 
                    - The `ByGroupId` value is only available if you have the Active Rating feature enabled.
                    - Use this field only for Usage charges. One-time charges and recurring charges return `NULL`.
                enum:
                  - ByBillingPeriod
                  - ByUsageStartDate
                  - ByUsageRecord
                  - ByUsageUpload
                  - ByGroupId
                  - null
                type: string
                nullable: true
              recognizedRevenueAccount:
                description: |
                  The name of the recognized revenue account for this charge.
                    - Required when the Allow Blank Accounting Code setting is No.
                    - Optional when the Allow Blank Accounting Code setting is Yes.

                    This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
                maxLength: 100
                type: string
              revRecCode:
                description: >
                  Associates this product rate plan charge with a specific
                  revenue recognition code.
                maxLength: 70
                type: string
                nullable: true
              revRecTriggerCondition:
                description: |
                  Indicates when revenue recognition begins.
                enum:
                  - ContractEffectiveDate
                  - ServiceActivationDate
                  - CustomerAcceptanceDate
                  - null
                type: string
                nullable: true
              revenueRecognitionRuleName:
                description: |
                  Determines when to recognize the revenue for this charge.
                enum:
                  - Recognize upon invoicing
                  - Recognize daily over time
                type: string
              smoothingModel:
                description: >
                  Indicates the smoothing model for an overage smoothing charge
                  model.
                enum:
                  - RollingWindow
                  - Rollover
                  - null
                type: string
                nullable: true
              specificBillingPeriod:
                description: >
                  The specific number of billing period for the product charge
                  definition.
                type: number
                nullable: true
              specificListPriceBase:
                description: >
                  The number of months for the list price base of the charge
                  definition.  

                  This field is `null` if the `listPriceBase` field is not set
                  to `Per_Specific_Months`.
                format: int32
                maximum: 200
                minimum: 1
                type: integer
                nullable: true
              taxCode:
                description: >
                  Specifies the tax code for taxation rules.


                  **Note**: This value affects the tax calculation of the rate
                  plan charge.
                maxLength: 64
                type: string
              taxMode:
                description: >
                  Determines how to define taxation for the charge.


                  **Note**: This value affects the tax calculation of the rate
                  plan charge.
                enum:
                  - TaxExclusive
                  - TaxInclusive
                  - null
                type: string
                nullable: true
              taxable:
                description: >
                  Determines whether the charge definition is taxable.


                  **Character limit**: 5


                  **Values**: `true`, `false`


                  **Note**: This value affects the tax calculation of the rate
                  plan charge.
                type: boolean
              term:
                description: >
                  The number of periods of a termed subscription that is
                  eligible for this charge definition. This field is applicable
                  when the `termType` field is set to `TERMED`, 

                  and is to be used together with the `termPeriodType` field.
                type: number
                nullable: true
              termPeriodType:
                description: >
                  The period type for the subscription term that is eligible for
                  this charge definition.
                enum:
                  - Month
                  - Year
                  - Day
                  - Week
                  - null
                type: string
                nullable: true
              termType:
                description: >
                  The type of the subscription that is eligible for this charge
                  definition.
                enum:
                  - TERMED
                  - EVERGREEN
                  - null
                type: string
                nullable: true
              triggerEvent:
                description: >
                  Specifies when to start billing the customer for the charge
                  definition.


                  **Values**:
                    - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.
                    - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.
                    - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.
                enum:
                  - ContractEffective
                  - ServiceActivation
                  - CustomerAcceptance
                type: string
              uom:
                description: >
                  Indicates the unit of measure (UOM) that is configured in
                  **Settings > Billing** for the product rate plan charge.
                type: string
                nullable: true
              upToPeriods:
                description: |
                  The number of up-to periods for this charge.
                type: number
                nullable: true
              upToPeriodsType:
                description: |
                  The up-to-periods type for this charge.
                enum:
                  - Billing_Periods
                  - Days
                  - Weeks
                  - Months
                  - Years
                  - null
                type: string
                nullable: true
              usageRecordRatingOption:
                default: EndOfBillingPeriod
                description: >
                  Determines how Zuora processes usage records for per-unit
                  usage charges.
                enum:
                  - EndOfBillingPeriod
                  - OnDemand
                  - null
                type: string
                nullable: true
              useDiscountSpecificAccountingCode:
                description: >
                  Determines whether to define a new accounting code for the new
                  discount charge.


                  **Character limit**: 5


                  **Values**: `true`, `false`
                type: boolean
                nullable: true
              useTenantDefaultForPriceChange:
                description: >
                  Applies the tenant-level percentage uplift value for an
                  automatic price change to a termed subscription's renewal. 


                  **Character limit**: 5


                  **Values**: `true`, `false`
                type: boolean
            title: chargeDefinitions
            type: object
          type: array
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
      type: object
    POSTChargeDefinitionPricingTier:
      description: |
        An array of charge pricing tier.
      items:
        properties:
          currency:
            description: |
              The code corresponding to the currency for the tier's price.
            type: string
          endingUnit:
            description: >
              The end number of a range of units for the tier. This field is
              required for charges based on the Tiered Pricing or Tiered with
              Overage Pricing charge model.
            format: double
            type: number
          price:
            description: >
              The price of the tier if the price format is flat fee, or the
              price of each unit in the tier if the price format is per unit.
            format: double
            type: number
          priceFormat:
            description: |
              The price format of the tier.
            enum:
              - Flat Fee
              - Per Unit
            type: string
          startingUnit:
            description: >
              The starting number of a range of units for the tier. This field
              is required for charges based on the Tiered Pricing or Tiered with
              Overage Pricing charge model.
            format: double
            type: number
        type: object
      title: pricingTiers
      type: array
    POSTProductChargeDefinitionPricing:
      properties:
        currency:
          description: |
            The currency for the price.
          type: string
        discountAmount:
          description: >
            The specific amount for a fixed discount. The field is applicable
            only for charges based on the Discount-Fixed Amount charge model.
          format: double
          type: number
        discountPercentage:
          description: >
            The percentage of discount for a percentage discount. The field is
            applicable only for charges based on the Discount-Percentage charge
            model.
          format: double
          type: number
        price:
          description: >
            The price of this item. 


            This field is only applicable for charges based on the following
            charge models:
              - Flat Fee
              - Per Unit
              - Delivery Pricing
          type: number
        tiers:
          description: >
            Container for the tiers of the price item. 


            This field is only applicable for charges based on the following
            charge models:
              - Tiered Pricing
              - Volume Pricing

            You must specify all relevant fields of all tiers, including pricing
            information for each currency.

            For each currency, ensure that the tiers appear in ascending order
            of `StartingUnit`.


            For example:


            ```

            [
              {
                "startingUnit": "1",
                "endingUnit": "150",
                "currency": "USD",
                "price": 1.95,
                "priceFormat": "Per Unit"
              },
              {
                "startingUnit": "151",
                "endingUnit": "300",
                "currency": "USD",
                "price": 1.45,
                "priceFormat": "Per Unit"
              },
              {
                "startingUnit": "1",
                "endingUnit": "150",
                "currency": "EUR",
                "price": 1.75,
                "priceFormat": "Per Unit"
              },
              {
                "startingUnit": "151",
                "endingUnit": "300",
                "currency": "EUR",
                "price": 1.30,
                "priceFormat": "Per Unit"
              }
            ]

            ```    
          items:
            $ref: '#/components/schemas/POSTChargeDefinitionPricingTier'
          type: array
      title: prices
      type: object
    POSTChargeDefinitionRequest:
      example:
        productRatePlanChargeId: edcab92612893256dce329d0b377000e
        effectiveStartDate: '2024-01-01 00:00:00'
        effectiveEndDate: '2025-01-01 00:00:00'
        listPriceBase: Per_Billing_Period
        prices:
          - currency: USD
            price: 12
      properties:
        billingPeriod:
          description: |
            The billing period for the product charge definition.
          type: string
        billingTiming:
          description: |
            The billing timing setting for the product charge definition.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          description: >
            Determines how to calculate charges. Charge models must be
            individually activated in Zuora Billing administration.
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Tiered
            - Volume
            - Delivery
          type: string
        defaultQuantity:
          description: |
            The default quantity. 

            This field is applicable only for one-time and recurring charges.
          type: number
          nullable: true
        effectiveEndDate:
          description: |
            The effective end date of the product charge definition.
          format: date-time
          type: string
        effectiveStartDate:
          description: |
            The effective start date of the product charge definition.
          format: date-time
          type: string
        listPriceBase:
          description: >
            The list price base. 


            This field is applicable only for recurring charges.


            **Note**: The `Per_Year` enum value is available only if you have
            the <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
            target="_blank">Annual List Price</a> feature enabled.
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        prices:
          description: |
            Container for the prices of the product charge definition.
          items:
            $ref: '#/components/schemas/POSTProductChargeDefinitionPricing'
          type: array
        productRatePlanChargeId:
          description: |
            The unique ID of the charge of the charge definition.
          type: string
        productRatePlanChargeNumber:
          description: >
            The unique number (natural key) of the charge of the charge
            definition.
          type: string
        productRatePlanId:
          description: >
            The unique ID of the product rate plan that uses this charge
            definition.
          type: string
        productRatePlanNumber:
          description: >
            The unique number (natural key) of the product rate plan that uses
            this charge definition.
          type: string
        specificBillingPeriod:
          description: >
            The specific number of billing periods for the product charge
            definition.
          type: number
          nullable: true
        specificListPriceBase:
          description: >
            The number of months for the list price base of the charge
            definition. 

            This field is `null` if the `listPriceBase` field is not set to
            `Per_Specific_Months`.
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        taxCode:
          description: >
            Specifies the tax code for taxation rules. This field is required
            when the `Taxable` field is set to `True`.


            **Note**: This value affects the tax calculation of the charge.
          maxLength: 64
          type: string
        taxMode:
          description: >
            Determines how to define taxation for the charge. This field is
            required when the `Taxable` field is set to `True`.


            **Note**: This value affects the tax calculation of the charge.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          description: >
            Determines whether the charge definition is taxable. When this field
            is set to `True`, the `TaxMode` and `TaxCode` fields are required.


            **Character limit**: 5


            **Values**: `True`, `False`


            **Note**: This value affects the tax calculation of the charge.
          type: boolean
        term:
          description: >
            The number of periods of a termed subscription that is eligible for
            this charge definition. This field is applicable when the `termType`
            field is set to `TERMED`, 

            and is to be used together with the `termPeriodType` field.
          type: number
          nullable: true
        termPeriodType:
          description: >
            Specifies the period type for the subscription term that is eligible
            for this charge definition.
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          description: >
            The type of the subscription that is eligible for this charge
            definition.
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        uom:
          description: >
            Describes the unit of measure (UOM) configured in **Settings >
            Billing** for the charge.
          type: string
          nullable: true
      title: productChargeDefinitions
      type: object
    POSTChargeDefinitionResponse:
      properties:
        chargeDefinitionId:
          description: |
            The unique ID of the product charge definition.
          type: string
        chargeDefinitionNumber:
          description: |
            The unique number (natural key) of the product charge definition.
          type: string
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
      type: object
    PUTBulkProductChargeDefinitionRequest:
      properties:
        billingPeriod:
          description: >
            The override value of the billingPeriod for the product charge
            definition.
          type: string
        billingTiming:
          description: >
            The override value of the billingTiming for the product charge
            definition.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          description: >
            Determines how to calculate charges. Charge models must be
            individually activated in Zuora Billing administration.
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Tiered
            - Volume
            - Delivery
          type: string
        defaultQuantity:
          description: |
            The default quantity. 

            This field is applicable only for one-time and recurring charges.
          type: number
        listPriceBase:
          description: >
            The list price base. 


            This field is applicable only for recurring charges.


            **Note**: The `Per_Year` enum value is available only if you have
            the <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
            target="_blank">Annual List Price</a> feature enabled.
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        prices:
          description: >
            Container for the new prices to override the existing prices of the
            product charge definition.
          items:
            $ref: '#/components/schemas/POSTProductChargeDefinitionPricing'
          type: array
        productChargeDefinitionKey:
          description: >
            The unique number or ID of the product charge definition to be
            updated.
          type: string
        specificBillingPeriod:
          description: >
            The override value of the specificBillingPeriod for the product
            charge definition.
          type: number
          nullable: true
        specificListPriceBase:
          description: >
            The number of months for the list price base of the charge
            definition. 

            The field is `null` if the `listPriceBase` field is not set to
            `Per_Specific_Months`.
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        taxCode:
          description: >
            Specifies the tax code for taxation rules. This field is equired
            when the `Taxable` field is set to `True`.


            **Note**: This value affects the tax calculation of the charge.
          maxLength: 64
          type: string
        taxMode:
          description: >
            Determines how to define taxation for the charge. This field is
            equired when the `taxable` field is set to `true`.


            **Note**: This value affects the tax calculation of the charge.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          description: >
            Determines whether the charge definition is taxable. When this field
            is set to `true`, the `taxMode` and `taxCode` fields are required.


            **Character limit**: 5


            **Values**: `true`, `false`


            **Note**: This value affects the tax calculation of the charge.
          type: boolean
        term:
          description: >
            The number of periods of a termed subscription that is eligible for
            this charge definition. This field is applicable when the `termType`
            field is set to `TERMED`, 

            and is to be used together with the `termPeriodType` field.
          type: number
          nullable: true
        termPeriodType:
          description: >
            Specifies the period type for the subscription term that is eligible
            for this charge definition.
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          description: >
            The type of the subscription that is eligible for this charge
            definition.
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        uom:
          description: >
            Describes the unit of measure (UOM) configured in **Settings >
            Billing**.


            **Values**: `Each`, `License`, `Seat`, or `null`
          type: string
          nullable: true
      type: object
    PUTProductChargeDefinitionBulkRequest:
      example:
        productChargeDefinitions:
          - productChargeDefinitionKey: CD-00052014
            prices:
              - currency: USD
                price: 22
      properties:
        productChargeDefinitions:
          description: |
            The list of updated product charge definitions.
          items:
            $ref: '#/components/schemas/PUTBulkProductChargeDefinitionRequest'
          type: array
      type: object
    POSTChargeDefinitionRequestBulk:
      example:
        productChargeDefinitions:
          - productRatePlanChargeId: edcab92612893256dce329d0b377000e
            effectiveStartDate: '2024-01-01 00:00:00'
            effectiveEndDate: '2025-01-01 00:00:00'
            listPriceBase: Per_Billing_Period
            prices:
              - currency: USD
                price: 18
      properties:
        productChargeDefinitions:
          description: |
            Container for the array of product charge definition.
          items:
            $ref: '#/components/schemas/POSTChargeDefinitionRequest'
          type: array
      type: object
    POSTChargeDefinitionBulkResponse:
      type: object
      properties:
        summary:
          description: |
            Summary of the results of the bulk operation.
          type: object
          properties:
            successCount:
              description: |
                The number of product charge definitions successfully created.
              type: integer
            failureCount:
              description: |
                The number of product charge definitions that are not created.
              type: integer
            failures:
              description: >
                An array containing the index of each failed charge definition.

                Each index is zero-based, and refers to the position of the
                invalid product charge definition in the bulk payload.
              type: array
              items:
                type: integer
          additionalProperties: false
        results:
          description: |
            The list of newly created product charge definitions or errors.
          type: array
          items:
            type: object
            properties:
              success:
                type: boolean
                description: >-
                  Indicates whether the charge definition is successfully
                  created.
              chargeDefinitionId:
                description: >
                  The unique ID of the product charge definition. 

                  This value is available only if this product charge definition
                  is successfully created.
                type: string
              chargeDefinitionNumber:
                description: >
                  The unique number (natural key) of the product charge
                  definition. 

                  This value is available only if this product charge definition
                  is successfully created.
                type: string
              processId:
                description: >
                  The ID of the process that handles the operation. 

                  This value is available only if this product charge definition
                  is not created.
                type: string
              reasons:
                description: >
                  Array of data containing the error code and reasons for
                  failure. 

                  This value is available only if this product charge definition
                  is not created.
                type: array
                items:
                  type: object
                  properties:
                    message:
                      type: string
                      description: Message explaining the reason for the error.
                    code:
                      type: string
                      description: Specifies the error code associated with the error.
                      example: '400'
            additionalProperties: false
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
      additionalProperties: false
    GETProductChargeDefinitionResponse:
      properties:
        applyDiscountTo:
          description: |
            Indicates which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          type: string
          nullable: true
        billingDay:
          description: |
            The bill cycle type for the charge.
          type: string
        billingPeriod:
          description: |
            The billing period for the product charge definition.
          type: string
        billingPeriodAlignment:
          description: |
            The billing period alignment setting for the charge.
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
          type: string
        billingTiming:
          description: |
            The billing timing setting for the product charge definition.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          description: >
            Determines how to calculate charges. Charge models must be
            individually activated in Zuora Billing administration.
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Overage
            - Tiered
            - TieredWithOverage
            - Volume
            - Delivery
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        chargeType:
          description: |
            Indicates the type of charge.
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        customFields:
          $ref: '#/components/schemas/ProductChargeDefinitionObjectCustomFields'
        defaultQuantity:
          description: |
            The default quantity. 

            This field is applicable only for one-time and recurring charges.
          type: number
          nullable: true
        deliverySchedule:
          $ref: '#/components/schemas/GETDeliverySchedule'
        description:
          description: |
            The description for the charge.
          type: string
        discountClass:
          description: >
            The class that the discount belongs to. The discount class defines
            the order in which discount product rate plan charges are applied.


            For more information, see [Manage Discount
            Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).
          type: string
          nullable: true
        discountLevel:
          description: >
            The application scope of the discount charge. For example, if the
            value of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        effectiveEndDate:
          description: |
            The effective end date of the product charge definition.
          format: date-time
          type: string
        effectiveStartDate:
          description: |
            The effective start date of the product charge definition.
          format: date-time
          type: string
        endDateCondition:
          description: |
            The end date condition for this charge.
          enum:
            - Subscription_End
            - One_Time
            - Fixed_Period
            - Specific_End_Date
          type: string
        financeInformation:
          description: |
            Container for finance information of the rate plan charge.
          properties:
            accountsReceivableAccountingCode:
              description: |
                The accounting code for accounts receivable.
              type: string
              nullable: true
            accountsReceivableAccountingCodeType:
              description: |
                The type of the accounting code for accounts receivable.
              type: string
              nullable: true
            adjustmentLiabilityAccountingCode:
              description: >
                The accounting code for adjustment liability. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            adjustmentLiabilityAccountingCodeType:
              description: >
                The type associated with the adjustment liability accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            adjustmentRevenueAccountingCode:
              description: >
                The accounting code for adjustment revenue. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            adjustmentRevenueAccountingCodeType:
              description: >
                The type associated with the adjustment revenue accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            contractAssetAccountingCode:
              description: >
                The accounting code for contract asset. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            contractAssetAccountingCodeType:
              description: >
                The type associated with the contract asset accounting code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            contractLiabilityAccountingCode:
              description: >
                The accounting code for contract liability. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            contractLiabilityAccountingCodeType:
              description: >
                The type associated with the contract liability accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            contractRecognizedRevenueAccountingCode:
              description: >
                The accounting code for contract recognized revenue. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            contractRecognizedRevenueAccountingCodeType:
              description: >
                The type associated with the contract recognized revenue
                accounting code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for deferred revenue, such as Monthly
                Recurring Liability.
              type: string
            deferredRevenueAccountingCodeType:
              description: >
                The type associated with the deferred revenue accounting code,
                such as Deferred Revenue. 
              type: string
              nullable: true
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.
              type: string
            recognizedRevenueAccountingCodeType:
              description: >
                The type associated with the recognized revenue accounting code,
                such as Sales Revenue or Sales Discount.
              type: string
              nullable: true
            unbilledReceivablesAccountingCode:
              description: >
                The accounting code for unbilled receivables. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
            unbilledReceivablesAccountingCodeType:
              description: >
                The type associated with the unbilled receivables accounting
                code. 


                **Note**: This field is only available if you have the Zuora
                Billing - Revenue Integration feature enabled.
              type: string
          title: financeInformation
          type: object
        isDefault:
          description: >
            Indicates whether this charge definition is the default one for the
            charge.
          type: boolean
        isStackedDiscount:
          description: >
            **Note**: This field is only applicable to the Discount - Percentage
            charge model.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to 130 or higher. Otherwise, an error occurs.


            This field indicates whether the discount is to be calculated as
            stacked discount. Possible values are as follows:
              - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.
              - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.

            For more information, see [Stacked
            discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
          type: boolean
        numberOfPeriods:
          description: >
            Specifies the number of periods to use when calculating charges in
            an overage smoothing charge model.

            This field is ued when overage smoothing model is `RollingWindow` or
            `Rollover`.
          format: int64
          type: integer
          nullable: true
        listPriceBase:
          description: >
            The list price base. 


            This field is applicable only for recurring charges.


            **Note**: The `Per_Year` enum value is available only if you have
            the <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
            target="_blank">Annual List Price</a> feature enabled.
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        numberOfPeriod:
          description: >
            Indicates the number of periods to use when calculating charges in
            an overage smoothing charge model. The valid value is a positive
            whole number.
          format: int64
          type: integer
        overageCalculationOption:
          description: >
            Determines when to calculate overage charges. If the value of the
            `SmoothingMode` field is not specified, the value of this field is
            ignored.


            **Values**: 
              - `EndOfSmoothingPeriod`: This option is used by default. The overage is charged at the end of the smoothing period.
              - `PerBillingPeriod`: The overage is charged on-demand rather than waiting until the end of the smoothing period.
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          type: string
          nullable: true
        overageUnusedUnitsCreditOption:
          description: >
            Determines whether to credit the customer with unused units of
            usage.
          enum:
            - NoCredit
            - CreditBySpecificRate
            - null
          type: string
          nullable: true
        priceChangeOption:
          default: NoChange
          description: >
            Applies an automatic price change when a termed subscription is
            renewed.
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
            - null
          type: string
          nullable: true
        priceIncreaseOption:
          description: >
            Applies an automatic price change when a termed subscription is
            renewed.
          enum:
            - FromTenantPercentageValue
            - SpecificPercentageValue
          type: string
        priceIncreasePercentage:
          description: >
            Specifies the percentage to increase or decrease the price of a
            termed subscription's renewal. Use this field if you set the
            `priceIncreaseOption` value to `SpecificPercentageValue`.


            **Character limit**: 16


            **Values**: a decimal value between -100 and 100
          format: double
          type: number
          nullable: true
        prices:
          description: |
            Container for the prices of the product charge definition.
          items:
            $ref: '#/components/schemas/GETProductChargeDefinitionPricing'
          type: array
        productChargeDefinitionId:
          description: |
            The unique ID of the product charge definition.
          type: string
        productChargeDefinitionNumber:
          description: |
            The unique number (natural key) of the product charge definition.
          type: string
        productDiscountApplyDetails:
          description: >
            Container for the application details about a discount product rate
            plan charge. 


            Only discount product rate plan charges have values for this field.
          items:
            $ref: '#/components/schemas/GETProductDiscountApplyDetailsType'
          type: array
        productRatePlanChargeId:
          description: |
            The unique ID of the product charge of the charge definition.
          type: string
        productRatePlanChargeNumber:
          description: >
            The unique number (natural key) of the product charge of the charge
            definition.
          type: string
          nullable: true
        productRatePlanId:
          description: >
            The unique ID of the product rate plan that uses this charge
            definition.
          type: string
          nullable: true
        productRatePlanName:
          description: |
            Th name of the product rate plan that uses this charge definition.
          type: string
          nullable: true
        productRatePlanNumber:
          description: >
            The unique number (natural key) of the product rate plan that uses
            this charge definition.
          type: string
          nullable: true
        ratingGroup:
          default: ByBillingPeriod
          description: |
            The rating group based on which usage records are rated.

            Possible values:                
              - `ByBillingPeriod`: The rating is based on all the usages in a billing period. 
              - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. 
              - `ByUsageRecord`: The rating is based on each usage record.
              - `ByUsageUpload`: The rating is based on all the  usages in a uploaded usage file (`.xls` or `.csv`).
              - `ByGroupId`: The rating is based on all the usages in a custom group.

            **Notes:** 
              - The `ByBillingPeriod` value can be applied for all charge models. 
              - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for Per Unit, Volume Pricing, and Tiered Pricing charge models. 
              - The `ByGroupId` value is only available if you have the Active Rating feature enabled.
              - Use this field only for Usage charges. One-time charges and recurring charges return `NULL`.
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
            - null
          type: string
          nullable: true
        recognizedRevenueAccount:
          description: |
            The name of the recognized revenue account for this charge.
              - Required when the Allow Blank Accounting Code setting is No.
              - Optional when the Allow Blank Accounting Code setting is Yes.

              This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
          maxLength: 100
          type: string
        revRecCode:
          description: >
            Associates this product rate plan charge with a specific revenue
            recognition code.
          maxLength: 70
          type: string
          nullable: true
        revRecTriggerCondition:
          description: |
            Indicates when revenue recognition begins.
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          type: string
          nullable: true
        revenueRecognitionRuleName:
          description: |
            Determines when to recognize the revenue for this charge.
          enum:
            - Recognize upon invoicing
            - Recognize daily over time
          type: string
        smoothingModel:
          description: |
            Indicates the smoothing model for an overage smoothing charge model.
          enum:
            - RollingWindow
            - Rollover
            - null
          type: string
          nullable: true
        specificBillingPeriod:
          description: >
            The specific number of billing period for the product charge
            definition.
          type: number
          nullable: true
        specificListPriceBase:
          description: >
            The number of months for the list price base of the charge
            definition.  

            This field is `null` if the `listPriceBase` field is not set to
            `Per_Specific_Months`.
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        success:
          description: |
            Indicates whether the request succeeded.
          type: boolean
        taxCode:
          description: >
            Specifies the tax code for taxation rules.


            **Note**: This value affects the tax calculation of the rate plan
            charge.
          maxLength: 64
          type: string
        taxMode:
          description: >
            Determines how to define taxation for the charge.


            **Note**: This value affects the tax calculation of the rate plan
            charge.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          description: >
            Determines whether the charge definition is taxable.


            **Character limit**: 5


            **Values**: `True`, `False`


            **Note**: This value affects the tax calculation of the rate plan
            charge.
          type: boolean
        term:
          description: >
            The number of periods of a termed subscription that is eligible for
            this charge definition. This field is applicable when the `termType`
            field is set to `TERMED`, 

            and is to be used together with the `termPeriodType` field.
          type: number
          nullable: true
        termPeriodType:
          description: >
            The period type for the subscription term that is eligible for this
            charge definition.
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          description: >
            The type of the subscription that is eligible for this charge
            definition.
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        triggerEvent:
          description: >
            Specifies when to start billing the customer for the charge
            definition.


            **Values**:
              - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed.
              - `ServiceActivation` is the date when the services or products for a subscription have been activated and the customers have access.
              - `CustomerAcceptance` is when the customer accepts the services or products for a subscription.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
        uom:
          description: >
            Indicates the unit of measure (UOM) that is configured in **Settings
            > Billing** for the product rate plan charge.
          type: string
          nullable: true
        upToPeriods:
          description: |
            The number of up-to periods for this charge.
          type: number
          nullable: true
        upToPeriodsType:
          description: |
            The up-to-periods type for this charge.
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          default: EndOfBillingPeriod
          description: >
            Determines how Zuora processes usage records for per-unit usage
            charges.
          enum:
            - EndOfBillingPeriod
            - OnDemand
            - null
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          description: >
            Determines whether to define a new accounting code for the new
            discount charge.


            **Character limit**: 5


            **Values**: `true`, `false`
          type: boolean
          nullable: true
        useTenantDefaultForPriceChange:
          description: >
            Applies the tenant-level percentage uplift value for an automatic
            price change to a termed subscription's renewal. 


            **Character limit**: 5


            **Values**: `true`, `false`
          type: boolean
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled. 
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related rate plan charges and order
            line items from revenue accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled.
        isAllocationEligible:
          type: boolean
          description: >
            Indicates whether the charge segment is allocation eligible in
            revenue recognition. The default value is `false`.


            **Values**: `true`, `false`


            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
        isUnbilled:
          type: boolean
          description: >
            Specifies how to perform the accounting during revenue recognition.
            The default value is `false`.


            **Values**: `true`, `false`


            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.   
        productCategory:
          type: string
          description: >
            This field is used to maintain the product category for integration
            with Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.    
        productClass:
          type: string
          description: >
            This field is used to maintain the product class for integration
            with Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.    
        productFamily:
          type: string
          description: >
            This field is used to maintain the product family for integration
            with Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.
        productLine:
          type: string
          description: >
            This field is used to maintain the product line for integration with
            Zuora Revenue. 


            **Note**: This field is available only if you have the Additional
            Revenue Fields property enabled.
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference. 

            Other options might also be avaliable depending on 

            the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference. 

            Other options might also be avaliable depending on 

            the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
      type: object
    PUTProductChargeDefinitionRequest:
      example:
        prices:
          - currency: USD
            price: 20
      properties:
        billingPeriod:
          description: >
            The override value of the billingPeriod for the product charge
            definition.
          type: string
        billingTiming:
          description: >
            The override value of the billingTiming for the product charge
            definition.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
          type: string
        chargeModel:
          description: >
            Determines how to calculate charges. Charge models must be
            individually activated in Zuora Billing administration.
          enum:
            - DiscountFixedAmount
            - DiscountPercentage
            - FlatFee
            - PerUnit
            - Tiered
            - Volume
            - Delivery
          type: string
        defaultQuantity:
          description: |
            The default quantity. 

            This field is applicable only for one-time and recurring charges.
          type: number
          nullable: true
        effectiveEndDate:
          description: |
            The effective end date of the product charge definition.
          format: date-time
          type: string
        effectiveStartDate:
          description: |
            The effective start date of the product charge definition.
          format: date-time
          type: string
        listPriceBase:
          description: >
            The list price base. 


            This field is applicable only for recurring charges.


            **Note**: The `Per_Year` enum value is available only if you have
            the <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
            target="_blank">Annual List Price</a> feature enabled.
          enum:
            - Per_Billing_Period
            - Per_Month
            - Per_Week
            - Per_Year
          type: string
        prices:
          description: >
            Container for the new prices to override the existing prices of the
            product charge definition.
          items:
            $ref: '#/components/schemas/POSTProductChargeDefinitionPricing'
          type: array
        specificBillingPeriod:
          description: >
            The override value of the specificBillingPeriod for the product
            charge definition.
          type: number
          nullable: true
        specificListPriceBase:
          description: >
            The number of months for the list price base of the charge
            definition. 

            The field is `null` if the `listPriceBase` field is not set to
            `Per_Specific_Months`.
          format: int32
          maximum: 200
          minimum: 1
          type: integer
          nullable: true
        taxCode:
          description: >
            Specifies the tax code for taxation rules. This field is equired
            when the `Taxable` field is set to `True`.


            **Note**: This value affects the tax calculation of the charge.
          maxLength: 64
          type: string
        taxMode:
          description: >
            Determines how to define taxation for the charge. This field is
            equired when the `Taxable` field is set to `True`.


            **Note**: This value affects the tax calculation of the charge.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        taxable:
          description: >
            Determines whether the charge definition is taxable. When this field
            is set to `True`, the `TaxMode` and `TaxCode` fields are required.


            **Character limit**: 5


            **Values**: `True`, `False`


            **Note**: This value affects the tax calculation of the charge.
          type: boolean
        term:
          description: >
            The number of periods of a termed subscription that is eligible for
            this charge definition. This field is applicable when the `termType`
            field is set to `TERMED`, 

            and is to be used together with the `termPeriodType` field.
          type: number
          nullable: true
        termPeriodType:
          description: >
            Specifies the period type for the subscription term that is eligible
            for this charge definition.
          enum:
            - Month
            - Year
            - Day
            - Week
            - null
          type: string
          nullable: true
        termType:
          description: >
            The type of the subscription that is eligible for this charge
            definition.
          enum:
            - TERMED
            - EVERGREEN
            - null
          type: string
          nullable: true
        uom:
          description: >
            Describes the unit of measure (UOM) configured in **Settings >
            Billing**.


            **Values**: `Each`, `License`, `Seat`, or `null`
          type: string
          nullable: true
      type: object
    ProxyGetProductRatePlanChargeTier:
      properties:
        CreatedById:
          description: >
            The ID of the Zuora user who created the ProductRatePlanChargeTier
            object.
          maxLength: 32
          type: string
        CreatedDate:
          description: |
            The date when the ProductRatePlanChargeTier object was created.
          format: date-time
          maxLength: 29
          type: string
        Currency:
          description: |
            The valid code corresponding to the currency for the tier's price.
          maxLength: 3
          type: string
        EndingUnit:
          description: |
            The end number of a range of units for the tier.

            **Character limit**: 16

            **Values**: any positive decimal value
          format: double
          type: number
        Id:
          description: Object identifier.
          type: string
        Price:
          description: >
            The price of the tier if the charge is a flat fee, or the price of
            each unit in the tier if the charge model is tiered pricing.


            **Character limit**: 16


            **Values**: a valid currency value
          format: double
          type: number
        PriceFormat:
          description: >
            Indicates if pricing is a flat fee or is per unit. This field is for
            tiered and volume pricing models only.


            **Values**: `FlatFee`, `PerUnit`


            **Note:** The values `Flat Fee` and `Per Unit` (with spaces) is
            valid for create or update calls.
          maxLength: 8
          type: string
        StartingUnit:
          description: |
            The starting number of a range of units for the tier.

            **Character limit**: 16

            **Values**: any positive decimal value
          format: double
          type: number
        Tier:
          description: |
            A unique number that identifies the tier that the price applies to.

            **Character limit**: 20

            **Values**: automatically generated
          format: int32
          type: integer
        UpdatedById:
          description: >
            The ID of the user who last updated the product rate plan charge
            tier.
          maxLength: 32
          type: string
        UpdatedDate:
          description: |
            The date when the product rate plan charge tier was last updated.
          format: date-time
          maxLength: 29
          type: string
      type: object
    ProxyModifyProductRatePlanChargeTier:
      example:
        Price: 1.99
      properties:
        Price:
          description: >
            The price of the tier if the charge is a flat fee, or the price of
            each unit in the tier if the charge model is tiered pricing.
          type: number
          format: double
        PriceFormat:
          description: >
            Indicates if pricing is a flat fee or is per unit. This field is for
            tiered and volume pricing models only.


            **Note:** The values `Flat Fee` and `Per Unit` (with spaces) is
            valid for create or update calls.
          enum:
            - Flat Fee
            - Per Unit
          maxLength: 8
          type: string
        DiscountPercentage:
          description: >
            The percentage of discount for a percentage discount. This field is
            required if the value for `ProductRatePlanCharge.ChargeModel` is
            `Discount-Percentage`.
             

            **Values:** A decimal value between -100 and 100, exclusive
          minimum: -100
          exclusiveMinimum: true
          maximum: 100
          exclusiveMaximum: true
          type: number
          format: double
        DiscountAmount:
          description: >
            The specific amount for a fixed discount. This field is required if
            the value for `ProductRatePlanCharge.ChargeModel` is `Discount-Fixed
            Amount`.


            **Values:** Any positive decimal value.  
          type: number
          format: double
      type: object
    RevproAccountingCodes:
      example:
        adjustmentLiabilityAccount: adjustL-1
        adjustmentRevenueAccount: adjustRev-1
        contractAssetAccount: CA-2
        contractLiabilityAccount: CL-2
        productRatePlanChargeId: 2c92c0f962470b8101624b869fcd45fc
        recognizedRevenueAccount: ContractRevRec-1
        unbilledReceivablesAccount: unbilledR-1
      properties:
        adjustmentLiabilityAccount:
          description: >-
            The name of the account where the Account Type is "Adjustment
            Liability".
          maxLength: 100
          type: string
        adjustmentRevenueAccount:
          description: >-
            The name of the account where the Account Type is "Adjustment
            Revenue".
          maxLength: 100
          type: string
        contractAssetAccount:
          description: The name of the account where the Account Type is "Contract Asset".
          maxLength: 100
          type: string
        contractLiabilityAccount:
          description: >-
            The name of the account where the Account Type is "Contract
            Liability".
          maxLength: 100
          type: string
        productRatePlanChargeId:
          description: The ID of your product rate plan charge.
          type: string
        recognizedRevenueAccount:
          description: >-
            The name of the account where the Account Type is "Recognized
            Revenue".
          maxLength: 100
          type: string
        unbilledReceivablesAccount:
          description: >-
            The name of the account where the Account Type is "Unbilled
            Receivables".
          maxLength: 100
          type: string
      required:
        - productRatePlanChargeId
        - contractAssetAccount
        - contractLiabilityAccount
        - unbilledReceivablesAccount
        - adjustmentLiabilityAccount
        - recognizedRevenueAccount
        - adjustmentRevenueAccount
      type: object
    PUTRevproAccCodeResponse:
      properties:
        success:
          description: ''
          type: boolean
      type: object
    AccountingRequest:
      type: object
      additionalProperties: false
      description: >
        Accounting fields accepted on create/update requests. Field names use
        snake_case.


        **Conditional requirement rules**

        - If **Allow blank Accounting Codes** = **Yes** → Accounting fields are
        **optional**.

        - If **Allow blank Accounting Codes** = **No** and the tenant **has
        Zuora Revenue** → **all Accounting fields except `accounting_code` are
        required**.

        - If **Allow blank Accounting Codes** = **No** and the tenant **does NOT
        have Zuora Revenue** → only `recognized_revenue_account` and
        `deferred_revenue_account` are required.


        These rules apply to **all operations that accept `accounting`** in the
        payload.
      properties:
        accounting_code:
          type: string
          description: >
            An accounting code associated with the charge for reporting/ERP
            mapping. Typically a short code or identifier, not the GL account
            name.
          example: PRPC-REV-001
        accounts_receivable_account:
          type: string
          description: >
            Accounts Receivable (AR) account to book invoices for this charge.
            Must match an existing account in the tenant's chart of accounts.
          example: Accounts Receivable
        accounts_receivable_account_type:
          type: string
          description: >
            The account type associated with `accounts_receivable_account`. Maps
            to the `accountsReceivableAccountType` field in the accounting
            object.
        deferred_revenue_account:
          type: string
          description: >
            Deferred revenue (liability) account to book revenue before
            recognition. Must match an existing account in the tenant's chart of
            accounts.
          example: Deferred Revenue
        deferred_revenue_accounting_type:
          type: string
          description: >
            Accounting method/type applied to deferred revenue. Maps to the
            `deferredRevenueAccountingType` field in the accounting object.
        recognized_revenue_account:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Recognized
            Revenue".
          example: ContractRevRec-1
        recognized_revenue_account_type:
          type: string
          description: >
            The account type associated with `recognized_revenue_account`. Maps
            to the `recognizedRevenueAccountType` field in the accounting
            object.
        adjustment_liability_account:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Adjustment
            Liability".
          example: adjustL-1
        adjustment_liability_account_type:
          type: string
          description: >
            The account type associated with `adjustment_liability_account`.
            Maps to the `adjustmentLiabilityAccountType` field in the accounting
            object.
        adjustment_revenue_account:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Adjustment
            Revenue".
          example: adjustRev-1
        adjustment_revenue_account_type:
          type: string
          description: >
            The account type associated with `adjustment_revenue_account`. Maps
            to the `adjustmentRevenueAccountType` field in the accounting
            object.
        contract_asset_account:
          type: string
          maxLength: 100
          description: The name of the account where the Account Type is "Contract Asset".
          example: CA-2
        contract_asset_account_type:
          type: string
          description: >
            The account type associated with `contract_asset_account`. Maps to
            the `contractAssetAccountType` field in the accounting object.
        contract_liability_account:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Contract
            Liability".
          example: CL-2
        contract_liability_account_type:
          type: string
          description: >
            The account type associated with `contract_liability_account`. Maps
            to the `contractLiabilityAccountType` field in the accounting
            object.
        contract_recognized_revenue_account:
          type: string
          description: >
            Recognized revenue account used specifically for contract-based
            recognition flows. Must match an existing account in the tenant's
            chart of accounts.
          example: Contract Recognized Revenue
        contract_recognized_revenue_account_type:
          type: string
          description: >
            The account type associated with
            `contract_recognized_revenue_account`. Maps to the
            `contractRecognizedRevenueAccountType` field in the accounting
            object.
        unbilled_receivables_account:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Unbilled
            Receivables".
          example: unbilledR-1
        unbilled_receivables_account_type:
          type: string
          description: >
            The account type associated with `unbilled_receivables_account`.
            Maps to the `unbilledReceivablesAccountType` field in the accounting
            object.
      example:
        accounting_code: PRPC-REV-001
        accounts_receivable_account: Accounts Receivable
        adjustment_liability_account: adjustL-1
        adjustment_revenue_account: adjustRev-1
        contract_asset_account: CA-2
        contract_liability_account: CL-2
        contract_recognized_revenue_account: Contract Recognized Revenue
        deferred_revenue_account: Deferred Revenue
        recognized_revenue_account: ContractRevRec-1
        unbilled_receivables_account: unbilledR-1
    UpdateChargeRequest:
      type: object
      required:
        - charge
      properties:
        charge:
          type: object
          additionalProperties: false
          description: >
            Fields to update on the product rate plan charge (PRPC). Only the
            properties

            provided will be considered for update (patch semantics).
            Unsupported updates

            are ignored by the service.
          required:
            - id
          properties:
            id:
              type: string
              description: >-
                Unique identifier of the product rate plan charge (PRPC) to
                update.
              example: 9c4867ed55db43a89731605d5654d4ed
            name:
              type: string
              description: Optional new display name for the charge.
            description:
              type: string
              description: Optional new description for the charge.
            trigger_event:
              type: string
              description: Event that triggers the charge (if update is supported).
              enum:
                - contract_effective
                - service_activation
                - customer_acceptance
            unit_of_measure:
              type: string
              description: >-
                Unit of measure label for the charge, for example, Each, Seat.
                May be read-only in some tenants.
            default_quantity:
              type: number
              description: Default quantity when the charge is added to a product/offer.
            min_quantity:
              type: number
              description: Optional minimum quantity constraint (if supported).
            max_quantity:
              type: number
              description: Optional maximum quantity constraint (if supported)
            list_price_base:
              type: string
              description: >-
                List price basis (e.g., Per_Billing_Period). Typically read-only
                after creation.
            bill_cycle:
              type: object
              description: >-
                Billing period configuration controlling frequency, alignment,
                and timing.
              additionalProperties: false
              properties:
                type:
                  type: string
                  description: >-
                    Source of the default billing period, for example,
                    default_from_customer, specific_day_of_month.
                day_of_month:
                  type: integer
                  description: Day of month to bill when type = `specific_day_of_month`.
                day_of_week:
                  type: string
                  description: Day of week to bill when using weekly modes.
                period:
                  type: string
                  description: >-
                    Billing period, for example, bill_cycle_period_month,
                    bill_cycle_period_quarter.
                specific_period:
                  type: string
                  description: Custom period text when applicable.
                period_alignment:
                  type: string
                  description: >-
                    Alignment behavior, for example, align_to_charge,
                    align_to_term_start.
                timing:
                  type: string
                  description: Indicates whether billing occurs in advance or in arrears.
                  enum:
                    - in_advance
                    - in_arrears
            pricing:
              type: object
              description: >
                Default (charge-level) pricing used when no rate-card row
                matches.

                Structure depends on the charge model:
                  - flat_fee → flat_amounts
                  - per_unit → unit_amounts
                  - volume/tiered → tiers
                  - discount_fixed_amount → discount_amounts
                  - discount_percentage → discount_percentage
              oneOf:
                - title: Flat Fee Pricing
                  type: object
                  required:
                    - flat_amounts
                  properties:
                    flat_amounts:
                      type: object
                      description: Map of currency to flat amount.
                      additionalProperties:
                        type: number
                      example:
                        USD: 100
                - title: Per Unit Pricing
                  type: object
                  required:
                    - unit_amounts
                  properties:
                    unit_amounts:
                      type: object
                      description: Map of currency to per-unit price.
                      additionalProperties:
                        type: number
                      example:
                        USD: 2.5
                - title: Tiered or Volume Pricing
                  type: object
                  required:
                    - tiers
                  properties:
                    tiers:
                      type: array
                      description: >-
                        Tier definitions (volume or tiered) with optional
                        min/max caps.
                      items:
                        type: object
                        required:
                          - tier
                          - from
                          - price_format
                        properties:
                          tier:
                            type: string
                            description: Tier identifier, for example, "1", "2".
                          from:
                            type: number
                            description: Lower bound (inclusive).
                          up_to:
                            type: number
                            nullable: true
                            description: >-
                              Upper bound (inclusive). Omit/null for open-ended
                              last tier.
                          price_format:
                            type: string
                            description: >-
                              For example, price_format_per_unit or
                              price_format_flat_fee.
                          unit_amounts:
                            type: object
                            description: Per-unit price by currency for this tier.
                            additionalProperties:
                              type: number
                            example:
                              USD: 2.5
                          flat_amounts:
                            type: object
                            description: >-
                              Flat amount by currency for this tier (if
                              applicable).
                            additionalProperties:
                              type: number
                            example:
                              USD: 100
                          min_amounts:
                            type: object
                            description: Minimum billed amount by currency for this tier.
                            additionalProperties:
                              type: number
                            example:
                              USD: 6.25
                          max_amounts:
                            type: object
                            description: Maximum billed amount by currency for this tier.
                            additionalProperties:
                              type: number
                            example:
                              USD: 25
                - title: Fixed Amount Discount
                  type: object
                  required:
                    - discount_amounts
                  properties:
                    discount_amounts:
                      type: object
                      description: Map of currency to discount amount.
                      additionalProperties:
                        type: number
                      example:
                        USD: 10
                - title: Percentage Discount
                  type: object
                  required:
                    - discount_percentage
                  properties:
                    discount_percentage:
                      type: number
                      format: double
                      description: Discount percentage, for example, 15 for 15%.
                      example: 15
            rate_cards:
              type: array
              description: >
                Conditional pricing rows (rate cards). Each row defines match
                attributes and a price to apply.

                If multiple rows match, the first match wins. If none match,
                `pricing` is used.
              items:
                type: object
                required:
                  - attributes
                  - pricing
                properties:
                  attributes:
                    type: array
                    minItems: 1
                    description: >
                      Match conditions that must all evaluate to true for the
                      row to apply.

                      Use `between` for ranges or dates.
                    items:
                      type: object
                      required:
                        - name
                      properties:
                        name:
                          type: string
                          description: >-
                            Attribute name, for example, Age, Region,
                            EffectiveDate.
                          example: Age
                        operator:
                          type: string
                          description: Comparison operator.
                          enum:
                            - '>'
                            - '>='
                            - <
                            - <=
                            - '=='
                            - between
                            - between-inclusive
                          example: <=
                        value:
                          description: >
                            Comparison value. For `between`, provide an array of
                            two values.

                            The value type must align with the attribute’s
                            declared type.
                          oneOf:
                            - type: string
                            - type: number
                            - type: boolean
                            - type: array
                              items:
                                oneOf:
                                  - type: string
                                  - type: number
                          example: 12
                  pricing:
                    type: object
                    description: >
                      Price to apply when this row matches. Structure mirrors
                      `pricing` above.
                    oneOf:
                      - title: Flat Fee Pricing
                        type: object
                        required:
                          - flat_amounts
                        properties:
                          flat_amounts:
                            type: object
                            description: Map of currency to flat amount.
                            additionalProperties:
                              type: number
                            example:
                              USD: 100
                      - title: Per Unit Pricing
                        type: object
                        required:
                          - unit_amounts
                        properties:
                          unit_amounts:
                            type: object
                            description: Map of currency to per-unit price.
                            additionalProperties:
                              type: number
                            example:
                              USD: 180
                      - title: Tiered or Volume Pricing
                        type: object
                        required:
                          - tiers
                        properties:
                          tiers:
                            type: array
                            description: >-
                              Tier definitions (volume or tiered) with optional
                              min/max caps.
                            items:
                              type: object
                              required:
                                - tier
                                - from
                                - price_format
                              properties:
                                tier:
                                  type: string
                                  description: Tier identifier, for example, "1", "2".
                                from:
                                  type: number
                                  description: Lower bound (inclusive).
                                up_to:
                                  type: number
                                  nullable: true
                                  description: Upper bound (inclusive).
                                price_format:
                                  type: string
                                  description: For example, price_format_per_unit.
                                unit_amounts:
                                  type: object
                                  description: Per-unit price by currency for this tier.
                                  additionalProperties:
                                    type: number
                                flat_amounts:
                                  type: object
                                  description: >-
                                    Flat amount by currency for this tier (if
                                    applicable).
                                  additionalProperties:
                                    type: number
                                min_amounts:
                                  type: object
                                  description: >-
                                    Minimum billed amount by currency for this
                                    tier.
                                  additionalProperties:
                                    type: number
                                max_amounts:
                                  type: object
                                  description: >-
                                    Maximum billed amount by currency for this
                                    tier.
                                  additionalProperties:
                                    type: number
                      - title: Fixed Amount Discount
                        type: object
                        required:
                          - discount_amounts
                        properties:
                          discount_amounts:
                            type: object
                            description: Map of currency to discount amount.
                            additionalProperties:
                              type: number
                            example:
                              USD: 10
                      - title: Percentage Discount
                        type: object
                        required:
                          - discount_percentage
                        properties:
                          discount_percentage:
                            type: number
                            format: double
                            description: Discount percentage (e.g., 15 for 15%).
                            example: 15
            tax_code:
              type: string
              description: Optional tax code to associate with the charge.
            tax_mode:
              type: string
              description: Tax mode, for example, tax_exclusive, non_taxable, if supported.
            price_change_option:
              type: string
              description: How price changes apply on updates, for example, no_change.
            use_tenant_default_for_price_change:
              type: boolean
              description: If true, tenant defaults govern price change behavior.
            delivery_schedule:
              type: object
              description: Day-of-week delivery configuration (if enabled).
              additionalProperties: true
            prepayment:
              type: object
              description: Prepayment settings (credit option, rollover, validity).
              additionalProperties: true
            prepaid:
              type: boolean
              description: Indicates whether the charge is prepaid.
            overage_options:
              type: object
              description: Overage configuration for usage charges.
              additionalProperties: true
            accounting:
              $ref: '#/components/schemas/AccountingRequest'
            revenue:
              type: object
              description: Revenue recognition settings (rule names, timing).
              additionalProperties: true
            netsuite:
              type: object
              description: NetSuite integration attributes for the charge.
              additionalProperties: true
            custom_fields:
              type: object
              description: Tenant-specific custom field values on the charge.
              additionalProperties: true
            labels:
              type: object
              description: Free-form labels/tags attached to the charge.
              additionalProperties: true
            organization_labels:
              type: array
              description: Organization-level labels associated with the charge.
              items:
                type: object
            ocm_json_by_currency:
              type: object
              description: Offer/OCM metadata keyed by currency (internal use).
              additionalProperties: true
            attributes:
              type: array
              description: Attribute declarations for Dynamic Pricing (name/type/mapping).
              items:
                type: object
                required:
                  - name
                properties:
                  name:
                    type: string
                    description: Attribute name, for example, Region, Age, EffectiveDate.
                  type:
                    type: string
                    description: Attribute data type.
                    enum:
                      - string
                      - integer
                      - double
                      - boolean
                      - date
                      - datetime
                  mapping:
                    type: object
                    description: Optional mapping to resolve values from Zuora objects.
                    required:
                      - object
                      - field
                    properties:
                      object:
                        type: string
                        description: >-
                          Target Zuora object, for example, account,
                          subscription.
                      field:
                        type: string
                        description: Field on the target object, for example, age__c.
    AccountingResponse:
      type: object
      additionalProperties: false
      description: >
        Accounting fields returned by the API. `*Type` fields are derived from
        the tenant's chart of accounts and are read-only.
      properties:
        accountingCode:
          type: string
          description: >
            An accounting code associated with the charge for reporting or ERP
            mapping.

            Typically a short code or identifier, not the GL account name.
          example: PRPC-REV-001
        accountsReceivableAccount:
          type: string
          description: |
            Accounts Receivable (AR) account to book invoices for this charge.
            Must match an existing account in the tenant's chart of accounts.
        accountsReceivableAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the AR account from the chart of
            accounts.

            Examples include "AccountsReceivable".
        adjustmentLiabilityAccount:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Adjustment
            Liability".
          example: adjustL-1
        adjustmentLiabilityAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Adjustment Liability account
            from the chart of accounts.

            Examples include "AdjustmentLiability".
        adjustmentRevenueAccount:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Adjustment
            Revenue".
          example: adjustRev-1
        adjustmentRevenueAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Adjustment Revenue account from
            the chart of accounts.

            Examples include "AdjustmentRevenue".
        contractAssetAccount:
          type: string
          maxLength: 100
          description: The name of the account where the Account Type is "Contract Asset".
          example: CA-2
        contractAssetAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Contract Asset account from the
            chart of accounts.
          example: ContractAsset
        contractLiabilityAccount:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Contract
            Liability".
          example: CL-2
        contractLiabilityAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Contract Liability account from
            the chart of accounts.

            Examples include "ContractLiability".
        contractRecognizedRevenueAccount:
          type: string
          description: >
            Recognized revenue account used specifically for contract-based
            recognition flows.

            Must match an existing account in the tenant's chart of accounts.
        contractRecognizedRevenueAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Contract Recognized Revenue
            account from the chart of accounts.
          example: RecognizedRevenue
        deferredRevenueAccount:
          type: string
          description: >
            Deferred revenue (liability) account to book revenue before
            recognition.

            Must match an existing account in the tenant's chart of accounts.
        deferredRevenueAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Deferred Revenue account from
            the chart of accounts.
          example: DeferredRevenue
        recognizedRevenueAccount:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Recognized
            Revenue".
          example: ContractRevRec-1
        recognizedRevenueAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Recognized Revenue account from
            the chart of accounts.
          example: RecognizedRevenue
        unbilledReceivablesAccount:
          type: string
          maxLength: 100
          description: >-
            The name of the account where the Account Type is "Unbilled
            Receivables".
          example: unbilledR-1
        unbilledReceivablesAccountType:
          type: string
          readOnly: true
          description: >
            System-derived type/category of the Unbilled Receivables account
            from the chart of accounts.
          example: UnbilledReceivables
        productRatePlanChargeId:
          type: string
          description: The ID of your product rate plan charge.
          example: 2c92c0f962470b8101624b869fcd45fc
    CreateChargeResponse:
      type: object
      additionalProperties: false
      properties:
        accounting:
          $ref: '#/components/schemas/AccountingResponse'
        attributes:
          type: array
          description: Attribute metadata associated with Dynamic Pricing for this charge.
          items:
            type: object
            description: Declared attribute used by Dynamic Pricing.
            additionalProperties: true
        billCycle:
          type: object
          properties:
            dayOfMonth:
              type: integer
              description: Specific day of month to bill when type = specific_day_of_month.
            period:
              type: string
              description: |
                Billing period length. 
            periodAlignment:
              type: string
              description: |
                How the billing period start aligns.
            timing:
              type: string
              description: Whether the charge bills before or after the service period.
            type:
              type: string
              description: |
                Bill-cycle mode (inherit defaults or set specific day rules).
        chargeFunction:
          type: string
          description: Internal function/category of the charge used by rating.
        chargeModel:
          type: string
          description: Pricing model that determines how the amount is calculated.
        chargeType:
          type: string
          description: Whether the charge recurs, rates usage, or is a one-time fee.
        createdById:
          type: string
          description: User ID that created the charge record.
        createdTime:
          type: string
          format: date-time
          description: Timestamp when the charge record was created.
        customFields:
          type: object
          additionalProperties: true
          description: Tenant-specific custom field values on the charge.
        deliverySchedule:
          type: object
          description: Day-of-week delivery settings when delivery scheduling is enabled.
          properties:
            frequency:
              type: string
              description: |
                Delivery frequency label for schedule rules.
            friday:
              type: boolean
              description: Deliver on Friday.
            monday:
              type: boolean
              description: Deliver on Monday.
            saturday:
              type: boolean
              description: Deliver on Saturday.
            sunday:
              type: boolean
              description: Deliver on Sunday.
            thursday:
              type: boolean
              description: Deliver on Thursday.
            tuesday:
              type: boolean
              description: Deliver on Tuesday.
            wednesday:
              type: boolean
              description: Deliver on Wednesday.
        discountOptions:
          type: object
          description: How discount charges apply and interact with other discounts.
          properties:
            applyDetails:
              type: array
              items:
                type: object
              description: Per-target discount application details (if populated).
            applyTo:
              type: array
              items:
                type: string
              description: Which components or charges the discount applies to.
            applyToBillingPeriodPartially:
              type: boolean
              description: Whether the discount duration can partially align to a period.
            reflectDiscountInNetAmount:
              type: boolean
              description: Whether discounts reduce the net amount on invoices.
            rollover:
              type: boolean
              description: Whether unused discount can roll over to future periods.
            stackedDiscount:
              type: boolean
              description: Whether this discount stacks with other discounts.
        drawdown:
          type: object
          additionalProperties: true
          description: Prepaid/drawdown configuration when using prepaid with drawdown.
        endDateCondition:
          type: string
          description: |
            Rule for when the charge ends.
        upToPeriodsType:
          type: string
          description: >
            Unit used for the fixed period when `endDateCondition` is
            `fixed_period`, for example, billing periods or days.
        upToPeriods:
          type: integer
          description: >
            Number of periods, in units of `upToPeriodsType`, that the charge
            remains active when `endDateCondition` is `fixed_period`.
        extendedPrice:
          type: object
          additionalProperties: true
          description: Calculated extended price details (model-dependent).
        id:
          type: string
          description: Unique identifier of the product rate plan charge (PRPC).
        isChargeLevelMinCommit:
          type: boolean
          description: Whether a minimum commit is enforced at the charge level.
        isCommitted:
          type: boolean
          description: Indicates if the charge definition is committed/finalized.
        labels:
          type: object
          additionalProperties: true
          description: Free-form labels/tags attached to the charge.
        listPriceBase:
          type: string
          description: >-
            List price basis, for example, Per Billing Period, Per Month, Per
            Year.
        specificListPriceBase:
          description: >
            The number of months for the list price base of the charge. This
            field is used

            when the value of the `ListPriceBase` field to `Per Specific
            Months`.

            The value must be a positive integer between **1** and **120**
            inclusive.



            **Notes**: 
              - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
              - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.
              - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
          type: integer
        mergedRateCards:
          type: array
          items:
            type: object
          description: Effective rate-card rows after merges (if any).
        name:
          type: string
          description: Display name of the charge in the plan.
        negotiatedRateCards:
          type: array
          items:
            type: object
          description: Customer- or deal-specific rate-card rows applied by negotiation.
        netsuite:
          type: object
          description: NetSuite integration attributes mapped for this charge.
          additionalProperties: true
        ocmJsonByCurrency:
          type: object
          additionalProperties: true
          description: Offer/OCM metadata keyed by currency (internal use).
        organizationLabels:
          type: array
          items:
            type: string
          description: Organization-level labels associated with the charge.
        overageOptions:
          type: object
          description: Overage settings for usage charges.
          properties:
            includedUnits:
              type: number
              description: Included units before overage starts.
            unusedUnitsCreditRates:
              type: object
              additionalProperties: true
              description: Credit rates for unused units (by currency).
        prepaid:
          type: boolean
          description: Indicates whether the charge is prepaid.
        prepayment:
          type: object
          description: Prepayment handling and rollover behavior.
          properties:
            creditOption:
              type: string
              description: How prepayment credits are applied (if supported).
            rollover:
              type: boolean
              description: Whether unused prepayment rolls over.
            rolloverApply:
              type: string
              description: Order in which rollover is applied (e.g., apply_last).
            rolloverPeriodLength:
              type: integer
              description: Length of each rollover period.
            rolloverPeriods:
              type: integer
              description: Number of rollover periods allowed.
        priceChangeOption:
          type: string
          description: |
            How price changes are applied across renewals/amendments.
        pricing:
          type: object
          description: Default (charge-level) price configuration by model/currency.
          properties:
            adjustments:
              type: object
              additionalProperties: true
              description: Price adjustments metadata.
            discountAmounts:
              type: object
              additionalProperties:
                type: number
              description: Fixed discount amounts by currency.
            discountPercentages:
              type: object
              additionalProperties:
                type: number
              description: Percentage discount values by currency.
            flatAmounts:
              type: object
              additionalProperties:
                type: number
              description: Flat amounts by currency for flat-fee pricing.
            maxAmounts:
              type: object
              additionalProperties:
                type: number
              description: Maximum caps by currency.
            minAmounts:
              type: object
              additionalProperties:
                type: number
              description: Minimum charges by currency.
            percentages:
              type: object
              additionalProperties:
                type: number
              description: Percentage price values by currency (model-dependent).
            tiers:
              type: array
              items:
                type: object
              description: Tier definitions for tiered/volume pricing.
            unitAmounts:
              type: object
              additionalProperties:
                type: number
              description: Per-unit amounts by currency for per-unit/usage pricing.
        pricingSummary:
          type: array
          items:
            type: string
          description: Human-readable price summary strings, for example, USD100.
        pricingWaterfalls:
          type: object
          additionalProperties: true
          description: Detailed pricing/waterfall breakdown (if available).
        productChargeDefinitions:
          type: array
          items:
            type: object
          description: Underlying charge definitions referenced for pricing lookup.
        productRatePlanChargeNumber:
          type: string
          description: PRPC number.
        productRatePlanId:
          type: string
          description: ID of the plan (PRP) that owns this charge.
        prorationOption:
          type: string
          description: How proration is handled relative to tenant defaults.
        rateCards:
          type: array
          items:
            type: object
          description: Dynamic Pricing rate-card rows configured on the charge.
        revenue:
          type: object
          description: Revenue policy settings for this charge.
          properties:
            excludeItemBillingFromRevenueAccounting:
              type: boolean
              description: If true, item billing is excluded from revenue accounting.
            excludeItemBookingFromRevenueAccounting:
              type: boolean
              description: If true, item booking is excluded from revenue accounting.
            legacyReporting:
              type: boolean
              description: Indicator for legacy revenue reporting behaviors.
            revenueRecognitionRuleName:
              type: string
              description: >-
                Name of the revenue rule to apply, for example, "Recognize upon
                invoicing".
        taxCode:
          type: string
          description: Tax code applied to the charge (for example, a tax category code).
        taxMode:
          type: string
          description: |
            Tax mode for the charge.
        taxable:
          type: boolean
          description: Whether the charge is taxable.
        triggerEvent:
          type: string
          description: |
            Event that triggers the charge.
        unitOfMeasure:
          type: string
          description: Unit of measure used for pricing (for example, Each, Seats).
        updatedById:
          type: string
          description: User ID that last updated the charge record.
        updatedTime:
          type: string
          format: date-time
          description: Timestamp when the charge record was last updated.
        useTenantDefaultForPriceChange:
          type: boolean
          description: Whether tenant defaults govern price change behavior.
      example:
        accounting:
          accountsReceivableAccount: Accounts Receivable
          accountsReceivableAccountType: AccountsReceivable
          deferredRevenueAccount: Accounts Receivable
          deferredRevenueAccountType: AccountsReceivable
          recognizedRevenueAccount: Accounts Receivable
          recognizedRevenueAccountType: AccountsReceivable
        attributes: []
        billCycle:
          dayOfMonth: 5
          period: bill_cycle_period_month
          periodAlignment: align_to_charge
          timing: in_advance
          type: specific_day_of_month
        chargeFunction: charge_function_standard
        chargeModel: flat_fee
        chargeType: recurring
        createdById: 53c162482f054f3ca08e1ec82dccfec9
        createdTime: '2025-10-13T07:46:02.000+00:00'
        customFields: {}
        discountOptions:
          applyDetails: []
          applyTo: []
          applyToBillingPeriodPartially: false
          reflectDiscountInNetAmount: false
          rollover: false
          stackedDiscount: false
        drawdown: {}
        endDateCondition: subscription_end
        upToPeriodsType: billing_periods
        upToPeriods: 0
        extendedPrice: {}
        id: ad95b694d2b8442b84dc8ad26561c7d7
        isChargeLevelMinCommit: false
        isCommitted: false
        labels: {}
        listPriceBase: Per_Billing_Period
        mergedRateCards: []
        name: Flat PRPC 1
        negotiatedRateCards: []
        netsuite: {}
        ocmJsonByCurrency: {}
        organizationLabels: []
        overageOptions:
          includedUnits: 0
          unusedUnitsCreditRates: {}
        prepaid: false
        prepayment:
          rollover: false
          rolloverApply: apply_last
          rolloverPeriodLength: 0
          rolloverPeriods: 0
        priceChangeOption: no_change
        pricing:
          adjustments: {}
          discountAmounts: {}
          discountPercentages: {}
          flatAmounts:
            USD: 100
          maxAmounts: {}
          minAmounts: {}
          percentages: {}
          tiers: []
          unitAmounts: {}
        pricingSummary:
          - USD100
        pricingWaterfalls: {}
        productChargeDefinitions: []
        productRatePlanChargeNumber: PRPC-00000279
        productRatePlanId: ee2d1ce1036c4dd6ae9d6945565ff7a0
        prorationOption: default_from_tenant_setting
        rateCards: []
        revenue:
          excludeItemBillingFromRevenueAccounting: false
          excludeItemBookingFromRevenueAccounting: false
          legacyReporting: false
          revenueRecognitionRuleName: Recognize upon invoicing
        taxCode: TAX_EXEMPT
        taxMode: non_taxable
        taxable: false
        triggerEvent: contract_effective
        unitOfMeasure: Each
        updatedById: 53c162482f054f3ca08e1ec82dccfec9
        updatedTime: '2025-10-13T07:46:02.000+00:00'
        useTenantDefaultForPriceChange: true
    CreateChargeRequest:
      type: object
      required:
        - charge
      properties:
        charge:
          type: object
          description: >
            Product rate plan charge (PRPC) definition including pricing model,
            billing settings, trigger event,

            and attribute-based rate cards for Dynamic Pricing.
          required:
            - charge_model
            - charge_type
            - name
            - unit_of_measure
            - bill_cycle
            - trigger_event
            - product_rate_plan_id
          properties:
            charge_model:
              type: string
              description: |
                Charge model that determines how the charge is calculated.
              enum:
                - flat_fee
                - per_unit
                - overage
                - volume
                - tiered
                - tiered_overage
                - discount_fixed_amount
                - discount_percentage
                - custom_charge_model
                - delivery
                - minimum_commitment_true_up
                - calculated
                - high_water_mark_volume_pricing
                - high_water_mark_tiered_pricing
                - multi_attribute_pricing
                - prerated_pricing
                - prerated_per_unit
            charge_type:
              type: string
              description: |
                Charge category in the catalog.
              enum:
                - one_time
                - recurring
                - usage
            description:
              type: string
              description: Human-readable description of the charge.
            name:
              type: string
              description: Name of the charge as displayed in the product catalog.
            unit_of_measure:
              type: string
              description: >
                Unit of measure (UOM) used to quantify or price the charge (for
                example, Each, Seats, Licenses).
            default_quantity:
              type: number
              format: double
              description: >-
                Default quantity applied when the charge is added, if not
                specified elsewhere.
            end_date_condition:
              type: string
              description: >
                Condition that determines when the charge becomes inactive. Use
                `subscription_end` when the charge should remain active

                until the subscription ends. Duration-based fields such as
                `up_to_periods` and `up_to_periods_type` do not apply when this
                value is used.
              enum:
                - end_date_one_time
                - subscription_end
                - fixed_period
                - specific_end_date
            up_to_periods_type:
              type: string
              description: >
                Granularity used with `end_date_condition = fixed_period` to
                express how long the charge remains active. When
                `end_date_condition = subscription_end`, this field is ignored.
              enum:
                - billing_periods
                - days
                - weeks
                - months
                - years
              example: billing_periods
            up_to_periods:
              type: integer
              format: int32
              description: >
                Number of periods used with `end_date_condition = fixed_period`.
                Combined with `up_to_periods_type` to determine the fixed
                duration of the charge. Ignored when `end_date_condition =
                subscription_end`.
              example: 0
            bill_cycle:
              type: object
              description: >
                Billing period configuration that controls frequency, alignment,
                and timing of billing for this charge.
              required:
                - period
                - period_alignment
                - type
              properties:
                type:
                  type: string
                  description: |
                    Determines how the billing day is selected for this charge.
                  enum:
                    - default_from_customer
                    - specific_day_of_month
                    - subscription_start_day
                    - charge_trigger_day
                    - specific_day_of_week
                    - term_start_day
                    - term_end_day
                  example: default_from_customer
                period:
                  type: string
                  description: |
                    Length of each billing period.
                  enum:
                    - bill_cycle_period_month
                    - bill_cycle_period_quarter
                    - bill_cycle_period_semi_annual
                    - bill_cycle_period_annual
                    - bill_cycle_period_eighteen_months
                    - bill_cycle_period_two_years
                    - bill_cycle_period_three_years
                    - bill_cycle_period_five_years
                    - bill_cycle_period_specific_months
                    - bill_cycle_period_subscription_term
                    - bill_cycle_period_week
                    - bill_cycle_period_specific_weeks
                    - bill_cycle_period_specific_days
                  example: bill_cycle_period_month
                period_alignment:
                  type: string
                  description: |
                    How the billing period start aligns.
                  enum:
                    - align_to_charge
                    - align_to_subscription_start
                    - align_to_term_start
                    - align_to_term_end
                  example: align_to_charge
                timing:
                  type: string
                  description: |
                    When the charge is billed relative to the service period.
                  enum:
                    - in_advance
                    - in_arrears
                  example: in_advance
                day_of_month:
                  type: integer
                  minimum: 1
                  maximum: 31
                  description: Required when `type` is `specific_day_of_month`.
                day_of_week:
                  type: string
                  description: |
                    Used when `type` is `specific_day_of_week`.
                  enum:
                    - sunday
                    - monday
                    - tuesday
                    - wednesday
                    - thursday
                    - friday
                    - saturday
            list_price_base:
              type: string
              description: >
                List price basis for this charge. This is used when interpreting
                list prices and, for some models, in conjunction with
                `specific_list_price_base`.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
                - Per_Validity_Period
              example: Per_Billing_Period
            specific_list_price_base:
              type: number
              format: double
              description: >
                Optional specific value used when `list_price_base` requires an
                explicit quantity (for example, number of months for
                `Per_Specific_Months`).
              example: 0
            trigger_event:
              type: string
              description: |
                Event that makes the charge active on a subscription.
              enum:
                - contract_effective
                - service_activation
                - customer_acceptance
                - specific_date
            product_rate_plan_id:
              type: string
              description: Identifier of the product rate plan that owns this charge.
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required

                if you set the value of the `ListPriceBase` field to `Per
                Specific Months`.

                The value must be a positive integer between **1** and **120**
                inclusive.



                **Notes**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - To use this field, you must set the `X-Zuora-WSDL-Version` request header to `129` or later. Otherwise, an error occurs.
                  - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
              format: int32
              maximum: 120
              minimum: 1
              example: 12
              type: integer
              nullable: true
            formula:
              type: string
              description: >-
                Optional formula applied after rate-card lookup to adjust the
                computed price.
            tax_mode:
              type: string
              description: |
                Tax mode for this charge.
              enum:
                - non_taxable
                - tax_exclusive
                - tax_inclusive
            tax_code:
              type: string
              description: Tax code used for tax calculation on this charge.
            accounting:
              $ref: '#/components/schemas/AccountingRequest'
            revenue:
              type: object
              additionalProperties: true
              description: >
                Revenue recognition configuration, for example,
                `revenue_recognition_rule_name`, triggers, allocation flags.
            custom_fields:
              type: object
              additionalProperties: true
              description: Tenant custom fields on the charge.
            attributes:
              type: array
              description: >
                Declares the attribute metadata used by Dynamic Pricing for this
                charge.

                Each entry defines an attribute that pricing rules can
                reference, along with

                its data type and (optionally) a mapping to a Zuora object field
                used to resolve values at runtime.

                Examples: Region, Age, EffectiveDate.
              items:
                type: object
                required:
                  - name
                properties:
                  name:
                    type: string
                    description: Attribute name, for example, Age, Region, EffectiveDate.
                  type:
                    type: string
                    description: Attribute data type.
                    enum:
                      - String
                      - Integer
                      - Double
                      - Boolean
                      - Date
                      - Datetime
                  mapping:
                    type: object
                    description: >
                      Optional mapping to a Zuora business object field used to
                      automatically resolve

                      the attribute value at runtime.
                    required:
                      - object
                      - field
                    properties:
                      object:
                        type: string
                        description: >-
                          Target Zuora object, for example, account,
                          subscription.
                      field:
                        type: string
                        description: Field on the target object, for example, age__c.
            pricing:
              type: object
              description: >
                Default (charge-level) pricing for the PRPC, used when no
                rate-card row matches.

                The structure depends on the charge_model:
                  - flat_fee → flat_amounts
                  - per_unit → unit_amounts
                  - volume/tiered → tiers
                  - discount_fixed_amount → discount_amounts
                  - discount_percentage → discount_percentage
              oneOf:
                - title: Flat Fee Pricing
                  type: object
                  required:
                    - flat_amounts
                  properties:
                    flat_amounts:
                      type: object
                      description: Map of currency to flat amount.
                      additionalProperties:
                        type: number
                      example:
                        USD: 100
                - title: Per Unit Pricing
                  type: object
                  required:
                    - unit_amounts
                  properties:
                    unit_amounts:
                      type: object
                      description: Map of currency to per-unit price.
                      additionalProperties:
                        type: number
                      example:
                        USD: 2.5
                - title: Tiered or Volume Pricing
                  type: object
                  required:
                    - tiers
                  properties:
                    tiers:
                      type: array
                      description: >-
                        Tier definitions (volume or tiered) with optional
                        min/max caps.
                      items:
                        type: object
                        required:
                          - tier
                          - from
                          - price_format
                        properties:
                          tier:
                            type: string
                            description: Tier identifier (e.g., "1", "2").
                          from:
                            type: number
                            description: Lower bound (inclusive).
                          up_to:
                            type: number
                            nullable: true
                            description: >-
                              Upper bound (inclusive). Omit/null for open-ended
                              last tier.
                          price_format:
                            type: string
                            description: For example, price_format_per_unit.
                          unit_amounts:
                            type: object
                            description: Per-unit price by currency for this tier.
                            additionalProperties:
                              type: number
                            example:
                              USD: 2.5
                          flat_amounts:
                            type: object
                            description: >-
                              Flat amount by currency for this tier (if
                              applicable).
                            additionalProperties:
                              type: number
                            example:
                              USD: 100
                          min_amounts:
                            type: object
                            description: Minimum billed amount by currency for this tier.
                            additionalProperties:
                              type: number
                            example:
                              USD: 6.25
                          max_amounts:
                            type: object
                            description: Maximum billed amount by currency for this tier.
                            additionalProperties:
                              type: number
                            example:
                              USD: 25
                - title: Fixed Amount Discount
                  type: object
                  required:
                    - discount_amounts
                  properties:
                    discount_amounts:
                      type: object
                      description: Map of currency to discount amount.
                      additionalProperties:
                        type: number
                      example:
                        USD: 10
                - title: Percentage Discount
                  type: object
                  required:
                    - discount_percentage
                  properties:
                    discount_percentage:
                      type: number
                      format: double
                      description: Discount percentage (e.g., 15 for 15%).
                      example: 15
            rate_cards:
              type: array
              description: >
                Defines the conditional pricing table (**rate cards**) for the
                PRPC.

                Each rate-card entry specifies:
                  - `attributes`: The match conditions evaluated at runtime.
                  - `pricing`: The price or rate to apply when the conditions match.

                If multiple rows match, Zuora applies the first matching rate
                card.

                If no row matches, the default `pricing` (defined above) is
                used.
              items:
                type: object
                required:
                  - attributes
                  - pricing
                properties:
                  attributes:
                    type: array
                    minItems: 1
                    description: >
                      Defines the set of match conditions that must all evaluate
                      to true

                      for this rate-card row to apply. Each condition
                      corresponds to a declared

                      pricing attribute. Use `between` for range or date-based
                      conditions.
                    items:
                      type: object
                      required:
                        - name
                      properties:
                        name:
                          type: string
                          description: >-
                            Attribute name for the condition (for example, Age,
                            Region, EffectiveDate).
                        operator:
                          type: string
                          description: Comparison operator for the condition.
                          enum:
                            - '>'
                            - '>='
                            - <
                            - <=
                            - '=='
                            - between
                            - between-inclusive
                        value:
                          description: >
                            Comparison value. For `between`, provide an array of
                            two values.

                            The value type must align with the attribute’s
                            declared type.
                          oneOf:
                            - type: string
                            - type: number
                            - type: boolean
                            - type: array
                              items:
                                oneOf:
                                  - type: string
                                  - type: number
                  pricing:
                    type: object
                    description: >
                      Pricing configuration returned when this rate-card row
                      matches.

                      The structure depends on the charge_model:
                        - flat_fee → flat_amounts
                        - per_unit → unit_amounts
                        - volume/tiered → tiers
                        - discount_fixed_amount → discount_amounts
                        - discount_percentage → discount_percentage
                    oneOf:
                      - title: Flat Fee Pricing
                        type: object
                        required:
                          - flat_amounts
                        properties:
                          flat_amounts:
                            type: object
                            description: Map of currency to flat amount.
                            additionalProperties:
                              type: number
                            example:
                              USD: 100
                      - title: Per Unit Pricing
                        type: object
                        required:
                          - unit_amounts
                        properties:
                          unit_amounts:
                            type: object
                            description: Map of currency to per-unit price.
                            additionalProperties:
                              type: number
                            example:
                              USD: 2.5
                      - title: Tiered or Volume Pricing
                        type: object
                        required:
                          - tiers
                        properties:
                          tiers:
                            type: array
                            description: >-
                              Tier definitions (volume or tiered) with optional
                              min/max caps.
                            items:
                              type: object
                              required:
                                - tier
                                - from
                                - price_format
                              properties:
                                tier:
                                  type: string
                                  description: Tier identifier (e.g., "1", "2").
                                from:
                                  type: number
                                  description: Lower bound (inclusive).
                                up_to:
                                  type: number
                                  nullable: true
                                  description: >-
                                    Upper bound (inclusive). Omit/null for
                                    open-ended last tier.
                                price_format:
                                  type: string
                                  description: For example, price_format_per_unit.
                                unit_amounts:
                                  type: object
                                  additionalProperties:
                                    type: number
                                  description: Per-unit price by currency for this tier.
                                flat_amounts:
                                  type: object
                                  additionalProperties:
                                    type: number
                                  description: >-
                                    Flat amount by currency for this tier (if
                                    applicable).
                                min_amounts:
                                  type: object
                                  additionalProperties:
                                    type: number
                                  description: >-
                                    Minimum billed amount by currency for this
                                    tier.
                                max_amounts:
                                  type: object
                                  additionalProperties:
                                    type: number
                                  description: >-
                                    Maximum billed amount by currency for this
                                    tier.
    QueryChargeRequest:
      type: object
      description: >
        Request schema for querying a specific Product Rate Plan Charge (PRPC)
        by key.

        Use this operation to fetch details of a single PRP, optionally
        expanding related charges.
      properties:
        product_rate_plan_key:
          type: string
          description: >
            Unique identifier (key) of the Product Rate Plan (PRP) to query.
            This can be the PRP ID or the PRP number configured in your system.
          example: 11dc762a07064ce496af73ff4cfb5614
        expand:
          type: object
          description: |
            Optional flags to expand related resources in the response.
          properties:
            product_rate_plan_charges:
              type: boolean
              description: >-
                Whether to include Product Rate Plan Charges (PRPCs) in the
                response.
              example: true
        attributes:
          type: array
          description: >
            Optional attribute values to use when evaluating Dynamic Pricing for
            the PRP or its charges.

            All required attributes must be supplied if the PRP or PRPC is
            configured to require them.
          items:
            type: object
            required:
              - name
            properties:
              name:
                type: string
                description: >-
                  Attribute name, for example, Age, Region, EffectiveDate,
                  AccountContext.
                example: Age
              value:
                description: >
                  Attribute value used for price evaluation.  The value can be a
                  string, number, or boolean, depending on the attribute type.  
                   - Enclose the value in quotation marks ("") if it is a **string**, for example, "Liquidity Provider", "Y", "External".  
                   - Do **not** use quotation marks for **numeric** or **boolean** values, for example, 98, 5, true, false.
                example: Liquidity Provider
        evaluation_level:
          type: string
          description: >
            Controls how pricing is evaluated for the charge. Supported values:
            - `LIST_PRICE`: evaluate pricing at the list-price level. -
            `EXTENDED_PRICE`: evaluate pricing at the extended-price level.

            If not specified, the default is `LIST_PRICE`.
          enum:
            - LIST_PRICE
            - EXTENDED_PRICE
          example: LIST_PRICE
    UpdateProductRequest:
      type: object
      description: Request body for updating a product in the Product Catalog.
      properties:
        id:
          type: string
          description: Unique identifier of the product to update.
          example: 8ad088009840d1c2019855e15c993f2f
        name:
          type: string
          description: Product name.
          example: Software Service
        description:
          type: string
          description: Product description.
          example: Software service - basic edition
        category:
          type: string
          description: Product category label, for example, base, add-on.
          example: base
        custom_fields:
          type: object
          description: >
            Custom fields to set on the product. Keys must match configured
            custom field API names.

            Values may be strings, numbers, booleans, or arrays depending on
            field definition.
          additionalProperties: true
          example:
            HelloBay__c: Updated value
            Tags__c:
              - AI Powered
              - Internet Required
        startDate:
          type: string
          format: date
          description: Product effective start date (UTC, YYYY-MM-DD).
          example: '2025-05-11'
        endDate:
          type: string
          format: date
          description: Product effective end date (UTC, YYYY-MM-DD).
          example: '2050-12-10'
      required:
        - id
    UpdateProductResponse:
      type: object
      description: Product record returned after a successful update.
      properties:
        id:
          type: string
          description: Unique identifier of the product.
          example: 00c86e3a0595442c88ed9ef8474b10a7
        name:
          type: string
          description: Product name.
          example: Amadeus
        description:
          type: string
          description: Product description.
          example: Software service - basic edition
        category:
          type: string
          description: Product category label.
          example: base
        productNumber:
          type: string
          description: Product number in the catalog.
          example: PC-00000095
        sku:
          type: string
          description: Product SKU.
          example: SKU-00000122
        startDate:
          type: string
          format: date
          description: Product effective start date (UTC, YYYY-MM-DD).
          example: '2024-01-08'
        endDate:
          type: string
          format: date
          description: Product effective end date (UTC, YYYY-MM-DD).
          example: '2050-12-31'
        state:
          type: string
          description: Current product state.
          example: product_active
        allowFeatureChanges:
          type: boolean
          description: Whether features on this product can be changed.
          example: false
        features:
          type: array
          description: Product features.
          items:
            type: object
            additionalProperties: true
        legacyFeatures:
          type: array
          description: Legacy features associated with this product.
          items:
            type: object
            additionalProperties: true
        contextFilters:
          type: array
          description: Context filters applied to the product.
          items:
            type: object
            additionalProperties: true
        customFields:
          type: object
          description: Custom fields on the product.
          additionalProperties: true
        customObjects:
          type: object
          nullable: true
          description: Custom objects linked to this product.
          additionalProperties: true
        netsuite:
          type: object
          nullable: true
          description: Netsuite integration attributes.
          additionalProperties: true
        organizationLabels:
          type: array
          description: Organization labels for the product.
          items:
            type: string
        productRatePlans:
          type: array
          description: Rate plans (PRPs) defined under the product.
          items:
            type: object
            additionalProperties: true
        createdBy:
          type: string
          description: ID of the user who created the product.
          example: 8a90a2fd8030ea2e018032b11d3a3f06
        createdTime:
          type: string
          format: date-time
          description: Timestamp when the product was created.
          example: '2025-08-06T18:11:35.000-07:00'
        updatedBy:
          type: string
          description: ID of the user who last updated the product.
          example: 53c162482f054f3ca08e1ec82dccfec9
        updatedTime:
          type: string
          format: date-time
          description: Timestamp when the product was last updated.
          example: '2025-10-23T04:55:54.000-07:00'
    CreateProductRequest:
      type: object
      required:
        - name
        - start_date
        - end_date
        - category
        - plans
      properties:
        name:
          type: string
          description: Product name.
          example: New prod
        sku:
          type: string
          description: >-
            The stock keeping unit (SKU) associated with the product or invoice
            item.
          example: SKU-12345
        product_number:
          type: string
          description: >-
            The product number that uniquely identifies the product in the
            product catalog.
          example: PROD-001
        start_date:
          type: string
          format: date
          description: Product effective start date (UTC, YYYY-MM-DD).
          example: '2024-01-01'
        end_date:
          type: string
          format: date
          description: Product effective end date (UTC, YYYY-MM-DD).
          example: '2050-12-31'
        category:
          type: string
          description: |
            Product category.
          enum:
            - base
            - add_on
            - other
          example: base
        plans:
          type: array
          description: Product rate plans to create under the product.
          minItems: 1
          items:
            type: object
            required:
              - name
              - start_date
              - end_date
              - active_currencies
              - charges
            properties:
              name:
                type: string
                description: Rate plan name.
                example: Consumer Bronze Monthly 2
              start_date:
                type: string
                format: date
                description: Rate plan effective start date (UTC, YYYY-MM-DD).
                example: '2024-01-01'
              end_date:
                type: string
                format: date
                description: Rate plan effective end date (UTC, YYYY-MM-DD).
                example: '2050-12-31'
              active_currencies:
                type: array
                description: ISO currency codes enabled for this plan.
                items:
                  type: string
                  minLength: 3
                  maxLength: 3
                example:
                  - USD
              charges:
                type: array
                description: Charges to create under this rate plan.
                minItems: 1
                items:
                  type: object
                  required:
                    - name
                    - charge_type
                    - charge_model
                    - bill_cycle
                    - trigger_event
                    - end_date_condition
                  properties:
                    name:
                      type: string
                      description: Charge name.
                      example: Data Usage Charge
                    charge_type:
                      type: string
                      description: Charge type.
                      enum:
                        - one_time
                        - recurring
                        - usage
                      example: usage
                    charge_model:
                      type: string
                      description: Charge model.
                      enum:
                        - flat_fee
                        - per_unit
                        - overage
                        - volume
                        - tiered
                        - tiered_overage
                        - discount_fixed_amount
                        - discount_percentage
                        - custom_charge_model
                        - delivery
                        - minimum_commitment_true_up
                        - calculated
                        - high_water_mark_volume_pricing
                        - high_water_mark_tiered_pricing
                        - multi_attribute_pricing
                        - prerated_pricing
                        - prerated_per_unit
                      example: per_unit
                    unit_of_measure:
                      type: string
                      description: Unit of measure for per-unit or usage charges.
                      example: Each
                    list_price_base:
                      type: string
                      description: |
                        List price base for the charge.
                      enum:
                        - Per_Billing_Period
                        - Per_Month
                        - Per_Week
                        - Per_Year
                        - Per_Specific_Months
                        - Per_Validity_Period
                      example: Per_Billing_Period
                    default_quantity:
                      type: number
                      description: >-
                        Default quantity for this charge on subscriptions
                        created from the plan.
                      example: 1
                    min_quantity:
                      type: number
                      description: >
                        Minimum quantity allowed for this charge.   Equivalent
                        to the `MinQuantity` field in the legacy v1 Product Rate
                        Plan Charge.
                      example: 1
                    max_quantity:
                      type: number
                      description: >
                        Maximum quantity allowed for this charge.   Equivalent
                        to the `MaxQuantity` field in the legacy v1 Product Rate
                        Plan Charge.
                      example: 999999
                    pricing:
                      type: object
                      description: |
                        Default (standard) pricing defined at the charge level.
                        Provide exactly one structure per the charge model.
                      oneOf:
                        - title: Flat Fee Pricing
                          type: object
                          required:
                            - flat_amounts
                          properties:
                            flat_amounts:
                              type: object
                              description: Map of currency to flat amount.
                              additionalProperties:
                                type: number
                              example:
                                USD: 100
                        - title: Per Unit Pricing
                          type: object
                          required:
                            - unit_amounts
                          properties:
                            unit_amounts:
                              type: object
                              description: Map of currency to per-unit price.
                              additionalProperties:
                                type: number
                              example:
                                USD: 5
                        - title: Tiered or Volume Pricing
                          type: object
                          required:
                            - tiers
                          properties:
                            tiers:
                              type: array
                              description: >-
                                Tier definitions (volume or tiered) with
                                optional min/max caps.
                              items:
                                type: object
                                required:
                                  - tier
                                  - from
                                  - price_format
                                properties:
                                  tier:
                                    type: string
                                    description: Tier identifier (e.g., "1", "2").
                                  from:
                                    type: number
                                    description: Lower bound (inclusive).
                                  up_to:
                                    type: number
                                    nullable: true
                                    description: >-
                                      Upper bound (inclusive). Omit/null for
                                      open-ended last tier.
                                  price_format:
                                    type: string
                                    description: Price format for the tier.
                                    enum:
                                      - price_format_flat_fee
                                      - price_format_per_unit
                                    example: price_format_per_unit
                                  unit_amounts:
                                    type: object
                                    description: Per-unit price by currency for this tier.
                                    additionalProperties:
                                      type: number
                                    example:
                                      USD: 2.5
                                  flat_amounts:
                                    type: object
                                    description: >-
                                      Flat amount by currency for this tier (if
                                      applicable).
                                    additionalProperties:
                                      type: number
                                    example:
                                      USD: 100
                                  min_amounts:
                                    type: object
                                    description: >-
                                      Minimum billed amount by currency for this
                                      tier.
                                    additionalProperties:
                                      type: number
                                    example:
                                      USD: 6.25
                                  max_amounts:
                                    type: object
                                    description: >-
                                      Maximum billed amount by currency for this
                                      tier.
                                    additionalProperties:
                                      type: number
                                    example:
                                      USD: 25
                        - title: Fixed Amount Discount
                          type: object
                          required:
                            - discount_amounts
                          properties:
                            discount_amounts:
                              type: object
                              description: Map of currency to discount amount.
                              additionalProperties:
                                type: number
                              example:
                                USD: 10
                        - title: Percentage Discount
                          type: object
                          required:
                            - discount_percentage
                          properties:
                            discount_percentage:
                              type: number
                              format: double
                              description: Discount percentage (e.g., 15 for 15%).
                              example: 15
                    bill_cycle:
                      type: object
                      description: Billing configuration of the charge.
                      required:
                        - type
                        - period
                        - period_alignment
                      properties:
                        type:
                          type: string
                          description: >
                            Determines how the billing day is selected for this
                            charge.
                          enum:
                            - default_from_customer
                            - specific_day_of_month
                            - subscription_start_day
                            - charge_trigger_day
                            - specific_day_of_week
                            - term_start_day
                            - term_end_day
                          example: default_from_customer
                        period:
                          type: string
                          description: |
                            Length of each billing period. 
                          enum:
                            - bill_cycle_period_month
                            - bill_cycle_period_quarter
                            - bill_cycle_period_semi_annual
                            - bill_cycle_period_annual
                            - bill_cycle_period_eighteen_months
                            - bill_cycle_period_two_years
                            - bill_cycle_period_three_years
                            - bill_cycle_period_five_years
                            - bill_cycle_period_specific_months
                            - bill_cycle_period_subscription_term
                            - bill_cycle_period_week
                            - bill_cycle_period_specific_weeks
                            - bill_cycle_period_specific_days
                          example: bill_cycle_period_month
                        period_alignment:
                          type: string
                          description: |
                            How the billing period start aligns. 
                          enum:
                            - align_to_charge
                            - align_to_subscription_start
                            - align_to_term_start
                            - align_to_term_end
                          example: align_to_charge
                        timing:
                          type: string
                          description: >
                            When the charge is billed relative to the service
                            period.
                          enum:
                            - in_advance
                            - in_arrears
                          example: in_arrears
                        day_of_month:
                          type: integer
                          minimum: 1
                          maximum: 31
                          description: Required if "type" is `specific_day_of_month`.
                          example: 5
                        day_of_week:
                          type: string
                          description: |
                            Used when "type" is `specific_day_of_week`.
                          enum:
                            - sunday
                            - monday
                            - tuesday
                            - wednesday
                            - thursday
                            - friday
                            - saturday
                        specific_period:
                          type: string
                          description: >
                            Optional specific period value when `period` is
                            `bill_cycle_period_specific_months`,
                            `bill_cycle_period_specific_weeks`, or
                            `bill_cycle_period_specific_days`.   Equivalent to
                            `SpecificBillingPeriod` in the legacy v1 API.
                    trigger_event:
                      type: string
                      description: |
                        Event that triggers the charge. 
                      enum:
                        - contract_effective
                        - service_activation
                        - customer_acceptance
                        - specific_date
                      example: contract_effective
                    end_date_condition:
                      type: string
                      description: |
                        Defines when the charge ends. 
                      enum:
                        - subscription_end
                        - end_date_one_time
                        - fixed_period
                        - specific_end_date
                      example: subscription_end
                    up_to_periods_type:
                      type: string
                      description: >
                        Unit of time used when `end_date_condition` =
                        `fixed_period`.

                        Maps to the duration unit (billing periods, days, weeks,
                        months, years).
                      enum:
                        - billing_periods
                        - days
                        - weeks
                        - months
                        - years
                      example: billing_periods
                    up_to_periods:
                      type: integer
                      description: >
                        Number of periods used when `end_date_condition` =
                        `fixed_period`.
                      example: 0
                    overage_options:
                      type: object
                      description: >
                        Configuration for overage smoothing and period-based
                        overage calculation. Equivalent to `NumberOfPeriod` and
                        related fields in the legacy v1 API.
                      properties:
                        number_of_periods:
                          type: number
                          description: >
                            Number of billing periods used for overage smoothing
                            / calculation.
                    price_increase_percentage:
                      type: number
                      format: double
                      description: >
                        Percentage used when `price_change_option` is set to
                        apply a specific percentage price increase. Equivalent
                        to `PriceIncreasePercentage` (v1).
                      example: 5
                    price_change_option:
                      type: string
                      description: >
                        Specifies how price changes are handled for future terms
                        when this product or rate plan is amended. Equivalent to
                        `PriceChangeOption` in the legacy v1 API. Examples
                        include `no_change`, `specific_percentage_value`, or
                        `use_latest_product_catalog_pricing`.
                      enum:
                        - no_change
                        - specific_percentage_value
                        - use_latest_product_catalog_pricing
                      example: no_change
                    use_tenant_default_for_price_change:
                      type: boolean
                      description: >
                        When true, uses the tenant-level default setting for
                        price change behavior instead of the charge-level
                        `price_change_option`.   Equivalent to
                        `UseTenantDefaultForPriceChange` in the legacy v1 API.
                      example: true
                    discount_options:
                      type: object
                      description: >
                        Discount configuration for discount charge models,
                        including "Apply Discount To" and related settings.
                      properties:
                        discount_class:
                          type: string
                          description: >-
                            Discount class to associate with this discount
                            charge.
                        stacked_discount:
                          type: boolean
                          description: >
                            When true, this discount can stack with other
                            discounts.
                        apply_to:
                          type: array
                          description: >
                            Charge types that this discount applies to.  
                            Mirrors the "One-Time / Recurring / Usage"
                            checkboxes in the UI.
                          items:
                            type: string
                            enum:
                              - one_time
                              - recurring
                              - usage
                        discount_level:
                          type: string
                          description: >
                            Level at which the discount applies (for example,
                            subscription-level or account-level discounts).
                          enum:
                            - rate_plan
                            - subscription
                            - account
                        apply_to_billing_period_partially:
                          type: boolean
                          description: >
                            When true, allows the discount to apply to partial
                            billing periods.
                        specific_accounting_codes:
                          type: boolean
                          description: >
                            When true, uses discount-specific accounting codes
                            instead of inheriting from the discounted charges.  
                            Equivalent to `UseDiscountSpecificAccountingCode` in
                            the legacy v1 API.
                        reflect_discount_in_net_amount:
                          type: boolean
                          description: >
                            When true, discount is reflected directly in the net
                            amount (Apply To Charge Net Amount option in the
                            UI).
                        rollover:
                          type: boolean
                          description: >
                            Indicates whether unused discount amounts roll over
                            to the next billing period.
                        apply_details:
                          type: array
                          description: >
                            Explicit list of product charges that this discount
                            applies to when targeting specific charges.
                          items:
                            type: object
                            properties:
                              applied_product_rate_plan_id:
                                type: string
                                description: ID of the target product rate plan.
                              applied_product_rate_plan_charge_id:
                                type: string
                                description: ID of the target product rate plan charge.
                    accounting:
                      $ref: '#/components/schemas/AccountingRequest'
    CreateProductResponse:
      type: object
      description: Product created with optional plans and charges.
      required:
        - id
        - name
        - category
        - startDate
        - endDate
        - state
      properties:
        id:
          type: string
          description: Unique identifier of the product.
          example: 7ec58fadb6f84bc18e59c7529058d941
        name:
          type: string
          description: Product name.
          example: New prod
        category:
          type: string
          description: Product category, for example, base or add-on.
          example: base
        description:
          type: string
          description: Free-form product description.
          example: ''
        productNumber:
          type: string
          description: The product number.
          example: PC-00000105
        sku:
          type: string
          description: Stock keeping unit for the product.
          example: SKU-00000135
        startDate:
          type: string
          format: date
          description: Product effective start date, for example, UTC, YYYY-MM-DD.
          example: '2024-01-01'
        endDate:
          type: string
          format: date
          description: Product effective end date, for example, UTC, YYYY-MM-DD.
          example: '2050-12-31'
        state:
          type: string
          description: Current lifecycle state of the product.
          example: product_active
        allowFeatureChanges:
          type: boolean
          description: Whether feature changes are allowed for this product.
          example: false
        features:
          type: array
          description: List of features associated with the product.
          items:
            type: object
        legacyFeatures:
          type: array
          description: Legacy feature list retained for backward compatibility.
          items:
            type: object
            additionalProperties: true
        contextFilters:
          type: array
          description: Context filter rules that may restrict product availability.
          items:
            type: object
        organizationLabels:
          type: array
          description: Key/value style organizational labels applied to the product.
          items:
            type: object
        customFields:
          type: object
          description: Custom field values on the product.
          additionalProperties: true
        customObjects:
          type: object
          nullable: true
          description: Custom object payloads linked to the product, if any.
          additionalProperties: true
          example: null
        dacTags:
          type: object
          description: Data access control or categorization tags for the product.
          additionalProperties: true
        netsuite:
          type: object
          nullable: true
          description: NetSuite integration metadata (if present).
          additionalProperties: true
          example: null
        createdBy:
          type: string
          description: ID of the user who created the product.
          example: 53c162482f054f3ca08e1ec82dccfec9
        createdTime:
          type: string
          format: date-time
          description: Timestamp when the product was created.
          example: '2025-10-17T04:02:54.621-07:00'
        updatedBy:
          type: string
          description: ID of the user who last updated the product.
          example: 53c162482f054f3ca08e1ec82dccfec9
        updatedTime:
          type: string
          format: date-time
          description: Timestamp when the product was last updated.
          example: '2025-10-17T04:02:54.621-07:00'
        plans:
          type: array
          description: Rate plans (PRPs) defined under this product.
          items:
            type: object
            required:
              - id
              - name
              - startDate
              - endDate
              - activeCurrencies
            properties:
              id:
                type: string
                description: Unique identifier of the product rate plan (PRP).
                example: 572a2efe711b449e80cbef94419bc050
              name:
                type: string
                description: Rate plan display name.
                example: Consumer Bronze Monthly
              displayName:
                type: string
                description: Optional alternate display name for the plan.
                example: ''
              description:
                type: string
                description: Free-form plan description.
                example: ''
              startDate:
                type: string
                format: date
                description: Plan effective start date (UTC, YYYY-MM-DD).
                example: '2024-01-01'
              endDate:
                type: string
                format: date
                description: Plan effective end date (UTC, YYYY-MM-DD).
                example: '2050-12-31'
              state:
                type: string
                description: Current lifecycle state of the plan.
                example: active
              status:
                type: string
                description: Optional status when present in some responses.
                example: ACTIVE
              activeCurrencies:
                type: array
                description: ISO currency codes enabled for this plan.
                items:
                  type: string
                example: USD
              createTime:
                type: string
                format: date-time
                description: Timestamp when the plan was created.
                example: '2025-10-17T04:02:54.655-07:00'
              updateTime:
                type: string
                format: date-time
                description: Timestamp when the plan was last updated.
                example: '2025-10-17T04:02:54.655-07:00'
              createdBy:
                type: string
                description: ID of the user who created the plan.
                example: 53c162482f054f3ca08e1ec82dccfec9
              updatedBy:
                type: string
                description: ID of the user who last updated the plan.
                example: 53c162482f054f3ca08e1ec82dccfec9
              productId:
                type: string
                description: ID of the parent product for this plan.
                example: 7ec58fadb6f84bc18e59c7529058d941
              productRatePlanNumber:
                type: string
                description: The plan number.
                example: PRP-00000198
              attributes:
                type: array
                description: Plan-level attribute metadata.
                items:
                  type: object
              contextFilters:
                type: array
                description: Context filter rules scoped to the plan.
                items:
                  type: object
              entitlements:
                type: array
                description: Entitlements included with the plan.
                items:
                  type: object
              externalIdSourceSystem:
                type: string
                description: Source system identifier for the external plan ID.
                example: ''
              externalRateplanId:
                type: array
                description: External plan identifier(s) from other systems.
                items:
                  type: string
              netsuite:
                type: object
                nullable: true
                description: NetSuite integration metadata (if present).
                additionalProperties: true
                example: null
              organizationLabels:
                type: array
                description: Key/value style organizational labels on the plan.
                items:
                  type: object
              customFields:
                type: object
                description: Custom field values on the plan.
                additionalProperties: true
              productRatePlanCharges:
                type: array
                description: Charges created under this plan.
                items:
                  type: object
                  required:
                    - id
                    - name
                    - chargeModel
                    - chargeType
                    - billCycle
                    - pricing
                  properties:
                    id:
                      type: string
                      description: >-
                        Unique identifier of the product rate plan charge
                        (PRPC).
                      example: 42db6ead399a4521bae91b3af469c074
                    name:
                      type: string
                      description: Charge display name within the plan.
                      example: Flat PRPC
                    chargeModel:
                      type: string
                      description: >-
                        Pricing model that determines how the amount is
                        calculated.
                      example: flat_fee
                    chargeType:
                      type: string
                      description: >-
                        Whether the charge recurs, rates usage, or is a one-time
                        fee.
                      example: recurring
                    chargeFunction:
                      type: string
                      description: Internal function identifier for the charge.
                      example: charge_function_standard
                    productRatePlanChargeNumber:
                      type: string
                      description: The charge number.
                      example: PRPC-00000283
                    productRatePlanId:
                      type: string
                      description: ID of the parent plan for this charge.
                      example: 572a2efe711b449e80cbef94419bc050
                    triggerEvent:
                      type: string
                      description: Event that triggers the charge to become billable.
                      example: contract_effective
                    endDateCondition:
                      type: string
                      description: Condition that determines when the charge ends.
                      example: subscription_end
                    upToPeriodsType:
                      type: string
                      description: >
                        Unit of time used when `endDateCondition` is
                        `fixed_period`, for

                        example, billing periods, days, weeks, months, or years.
                      example: billing_periods
                    upToPeriods:
                      type: integer
                      description: >
                        Number of periods used when `endDateCondition` is
                        `fixed_period`.
                      example: 0
                    listPriceBase:
                      type: string
                      description: Basis used for list pricing (if applicable).
                      example: Per_Billing_Period
                    specificListPriceBase:
                      type: number
                      description: >
                        Optional override for list price base when billing uses
                        a specific period configuration.
                      example: 0
                    billCycle:
                      type: object
                      description: Billing configuration of the charge.
                      properties:
                        type:
                          type: string
                          description: >-
                            Whether the charge inherits account defaults or uses
                            an override.
                          example: specific_day_of_month
                        dayOfMonth:
                          type: integer
                          description: >-
                            Day of month to bill when using a specific day
                            schedule.
                          example: 5
                        period:
                          type: string
                          description: Billing period length (for example, monthly).
                          example: bill_cycle_period_month
                        periodAlignment:
                          type: string
                          description: How the billing period start aligns.
                          example: align_to_charge
                        timing:
                          type: string
                          description: >-
                            When the charge is billed relative to the service
                            period.
                          example: in_advance
                    organizationLabels:
                      type: array
                      description: Key/value style organizational labels on the charge.
                      items:
                        type: object
                    accounting:
                      $ref: '#/components/schemas/AccountingResponse'
                    discountOptions:
                      type: object
                      description: Discount behavior flags configured on the charge.
                      properties:
                        applyDetails:
                          type: array
                          description: List of granular discount application details.
                          items:
                            type: object
                        applyTo:
                          type: array
                          description: Line item categories the discount applies to.
                          items:
                            type: string
                        applyToBillingPeriodPartially:
                          type: boolean
                          description: Whether discount applies to partial billing periods.
                          example: false
                        reflectDiscountInNetAmount:
                          type: boolean
                          description: >-
                            Whether to reflect discounts in the net amount
                            fields.
                          example: false
                        rollover:
                          type: boolean
                          description: Whether unapplied discounts roll over.
                          example: false
                        stackedDiscount:
                          type: boolean
                          description: Whether multiple discounts can stack.
                          example: false
                      additionalProperties: true
                    overageOptions:
                      type: object
                      description: Options governing overage behavior for usage charges.
                      properties:
                        includedUnits:
                          type: number
                          description: Number of units included before overages apply.
                          example: 0
                        unusedUnitsCreditRates:
                          type: object
                          description: Credit rates for unused units by currency.
                          additionalProperties:
                            type: number
                    prepayment:
                      type: object
                      description: Prepayment configuration for the charge (if applicable).
                      properties:
                        rollover:
                          type: boolean
                          description: Whether unused prepaid amounts roll over.
                          example: false
                        rolloverApply:
                          type: string
                          description: How rollover amounts are applied.
                          example: apply_last
                        rolloverPeriodLength:
                          type: integer
                          description: Length of the rollover period.
                          example: 0
                        rolloverPeriods:
                          type: integer
                          description: Number of rollover periods.
                          example: 0
                    prorationOption:
                      type: string
                      description: Proration behavior for partial periods.
                      example: default_from_tenant_setting
                    priceChangeOption:
                      type: string
                      description: How price changes are applied to existing subscriptions.
                      example: no_change
                    taxable:
                      type: boolean
                      description: Whether the charge is taxable.
                      example: false
                    taxMode:
                      type: string
                      description: Tax mode classification (present on some responses).
                      example: non_taxable
                    prepaid:
                      type: boolean
                      description: Whether the charge is prepaid.
                      example: false
                    isCommitted:
                      type: boolean
                      description: Whether the charge is committed.
                      example: false
                    isChargeLevelMinCommit:
                      type: boolean
                      description: >-
                        Whether a minimum commitment is enforced at the charge
                        level.
                      example: false
                    useTenantDefaultForPriceChange:
                      type: boolean
                      description: Whether tenant default settings apply to price changes.
                      example: true
                    labels:
                      type: object
                      description: Arbitrary label metadata for the charge.
                      additionalProperties: true
                    attributes:
                      type: array
                      description: Attribute metadata on the charge (if configured).
                      items:
                        type: object
                    customFields:
                      type: object
                      description: Custom field values on the charge.
                      additionalProperties: true
                    createdById:
                      type: string
                      description: ID of the user who created the charge.
                      example: 53c162482f054f3ca08e1ec82dccfec9
                    createdTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was created.
                      example: '2025-10-17T04:02:54.719-07:00'
                    updatedById:
                      type: string
                      description: ID of the user who last updated the charge.
                      example: 53c162482f054f3ca08e1ec82dccfec9
                    updatedTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was last updated.
                      example: '2025-10-17T04:02:54.719-07:00'
                    pricing:
                      type: object
                      description: Default (charge-level) pricing returned for the charge.
                      properties:
                        adjustments:
                          type: object
                          description: Price adjustments by currency or context.
                          additionalProperties: true
                        discountAmounts:
                          type: object
                          description: Fixed discount amounts by currency.
                          additionalProperties:
                            type: number
                        discountPercentages:
                          type: object
                          description: Discount percentages by currency.
                          additionalProperties:
                            type: number
                        flatAmounts:
                          type: object
                          description: Flat fee amounts by currency.
                          additionalProperties:
                            type: number
                          example:
                            USD: 100
                        maxAmounts:
                          type: object
                          description: Maximum amounts by currency (caps).
                          additionalProperties:
                            type: number
                        minAmounts:
                          type: object
                          description: Minimum amounts by currency (floors).
                          additionalProperties:
                            type: number
                        percentages:
                          type: object
                          description: Percentage values by currency for percentage models.
                          additionalProperties:
                            type: number
                        tiers:
                          type: array
                          description: Tier definitions for tiered/volume pricing.
                          items:
                            type: object
                        unitAmounts:
                          type: object
                          description: >-
                            Per-unit prices by currency for usage/per-unit
                            models.
                          additionalProperties:
                            type: number
                    pricingSummary:
                      type: array
                      description: Textual summary of pricing for display purposes.
                      items:
                        type: string
                    pricingWaterfalls:
                      type: object
                      description: Detailed pricing waterfall data (if available).
                      additionalProperties: true
                    productChargeDefinitions:
                      type: array
                      description: Charge definition metadata linked to this PRPC.
                      items:
                        type: object
                    rateCards:
                      type: array
                      description: Conditional rate card rules configured for the charge.
                      items:
                        type: object
                    revenue:
                      type: object
                      description: Revenue recognition metadata for the charge.
                      properties:
                        excludeItemBillingFromRevenueAccounting:
                          type: boolean
                          description: >-
                            Whether item billing is excluded from revenue
                            accounting.
                          example: false
                        excludeItemBookingFromRevenueAccounting:
                          type: boolean
                          description: >-
                            Whether item booking is excluded from revenue
                            accounting.
                          example: false
                        legacyReporting:
                          type: boolean
                          description: Whether legacy reporting is enabled.
                          example: false
                        revenueRecognitionRuleName:
                          type: string
                          description: Revenue recognition rule applied to this charge.
                          example: Recognize upon invoicing
                    ocmJsonByCurrency:
                      type: object
                      description: Offer/charge metadata keyed by currency.
                      additionalProperties: true
                    drawdown:
                      type: object
                      description: Drawdown configuration data (if applicable).
                      additionalProperties: true
                    extendedPrice:
                      type: object
                      description: Extended price metadata (if present).
                      additionalProperties: true
                    mergedRateCards:
                      type: array
                      description: Merged/compiled rate card entries after evaluation.
                      items:
                        type: object
                    negotiatedRateCards:
                      type: array
                      description: Customer-specific negotiated rate card entries.
                      items:
                        type: object
      additionalProperties: true
    UpdatePlanRequest:
      type: object
      description: Request body for updating a Product Rate Plan (PRP).
      properties:
        id:
          type: string
          description: Unique identifier of the Product Rate Plan to update.
          example: 5758b1d5a589840e0e6855e1c2ce014d
        name:
          type: string
          description: Rate plan name.
          example: Bronze Plan
        description:
          type: string
          description: Rate plan description.
          example: Basic version of our software service
        grade:
          type: integer
          description: Plan grade or display rank used for ordering in catalogs or UIs.
          example: 1
        startDate:
          type: string
          format: date
          description: Rate plan effective start date (UTC, YYYY-MM-DD).
          example: '2025-09-10'
        endDate:
          type: string
          format: date
          description: Rate plan effective end date (UTC, YYYY-MM-DD).
          example: '2043-08-16'
      required:
        - id
    UpdatePlanResponse:
      type: object
      description: Product Rate Plan record returned after a successful update.
      properties:
        id:
          type: string
          description: Unique identifier of the Product Rate Plan (PRP).
          example: 38660706ef2f48cfb5222f7dde491895
        name:
          type: string
          description: Rate plan name.
          example: Bronze Plan
        description:
          type: string
          description: Rate plan description.
          example: Basic version of our software service
        productId:
          type: string
          description: Owning product ID.
          example: 8a90aac8948deebf01949098b7790326
        productRatePlanNumber:
          type: string
          description: Rate plan number.
          example: PRP-00000172
        startDate:
          type: string
          format: date
          description: Rate plan effective start date (UTC, YYYY-MM-DD).
          example: '2025-09-10'
        endDate:
          type: string
          format: date
          description: Rate plan effective end date (UTC, YYYY-MM-DD).
          example: '2027-01-01'
        state:
          type: string
          description: Current rate plan state.
          example: active
        status:
          type: string
          description: Rate plan status.
          example: ACTIVE
        activeCurrencies:
          type: array
          description: Currencies with active pricing.
          items:
            type: string
          example:
            - USD
        displayName:
          type: string
          description: Product rate plan display name.
          example: ''
        attributes:
          type: array
          description: Attribute definitions associated with the plan.
          items:
            type: object
            additionalProperties: true
        contextFilters:
          type: array
          description: Context filters at the plan level.
          items:
            type: object
            additionalProperties: true
        entitlements:
          type: array
          description: Entitlements linked to the plan.
          items:
            type: object
            additionalProperties: true
        externalIdSourceSystem:
          type: string
          description: External ID source system.
          example: ''
        externalRateplanId:
          type: array
          description: External plan identifiers.
          items:
            type: string
        netsuite:
          type: object
          description: Netsuite integration attributes.
          additionalProperties: true
        organizationLabels:
          type: array
          description: Organization labels.
          items:
            type: string
        customFields:
          type: object
          description: Custom fields at the plan level.
          additionalProperties: true
        productRatePlanCharges:
          type: array
          description: Charges (PRPCs) that belong to this product rate plan.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the Product Rate Plan Charge (PRPC).
                example: 99e226fec45943f4b80ed7bcf6d595d7
              name:
                type: string
                description: Charge name.
                example: disc_currency
              chargeType:
                type: string
                description: Charge type.
                example: recurring
              chargeModel:
                type: string
                description: Charge model.
                example: discount_percentage
              listPriceBase:
                type: string
                description: Indicates how list price is interpreted.
                example: Per_Billing_Period
              triggerEvent:
                type: string
                description: Event that triggers the charge.
                example: contract_effective
              billCycle:
                type: object
                description: Billing cycle configuration.
                additionalProperties: true
                example:
                  period: bill_cycle_period_quarter
                  periodAlignment: align_to_term_start
                  type: term_start_day
              pricing:
                type: object
                description: Pricing configuration for the charge.
                additionalProperties: true
                example:
                  discountPercentages:
                    USD: 10
                  tiers: []
              prepayment:
                type: object
                description: Prepayment options for the charge (when applicable).
                additionalProperties: true
              taxMode:
                type: string
                description: Tax mode for this charge, for example, non_taxable or taxable.
                example: non_taxable
              taxable:
                type: boolean
                description: Indicates whether the charge is taxable.
                example: false
              createdById:
                type: string
                description: ID of the user who created the charge.
              createdTime:
                type: string
                format: date-time
                description: Timestamp when the charge was created.
              updatedById:
                type: string
                description: ID of the user who last updated the charge.
              updatedTime:
                type: string
                format: date-time
                description: Timestamp when the charge was last updated.
              accounting:
                type: object
                additionalProperties: true
                description: >-
                  Accounting configuration for the charge (for example, account
                  mappings and posting preferences).
              attributes:
                type: array
                items:
                  type: object
                  additionalProperties: true
                description: >-
                  Attribute definitions bound to this charge (used for dynamic
                  pricing or evaluation).
              customFields:
                type: object
                additionalProperties: true
                description: Custom fields on the charge.
              deliverySchedule:
                type: object
                additionalProperties: true
                description: >-
                  Delivery schedule settings, for example, frequency and
                  applicable days.
              discountOptions:
                type: object
                additionalProperties: true
                description: >-
                  Discount configuration for this charge, including scope,
                  stacking, and net-amount reflection.
              drawdown:
                type: object
                additionalProperties: true
                description: Drawdown configuration for consuming balances or entitlements.
              endDateCondition:
                type: string
                description: >-
                  Defines when the charge ends, for example, subscription_end or
                  after a term.
              extendedPrice:
                type: object
                additionalProperties: true
                description: Calculated extended price details, if applicable.
              isChargeLevelMinCommit:
                type: boolean
                description: >-
                  Indicates whether a minimum commitment is enforced at the
                  charge level.
              isCommitted:
                type: boolean
                description: Indicates whether this charge is part of a committed contract.
              labels:
                type: object
                additionalProperties: true
                description: Key-value metadata labels associated with the charge.
              mergedRateCards:
                type: array
                items:
                  type: object
                  additionalProperties: true
                description: >-
                  Effective rate card entries after merging default and
                  negotiated cards.
              negotiatedRateCards:
                type: array
                items:
                  type: object
                  additionalProperties: true
                description: Customer- or segment-specific negotiated rate card entries.
              ocmJsonByCurrency:
                type: object
                additionalProperties: true
                description: Per-currency pricing/configuration metadata in JSON format.
              organizationLabels:
                type: array
                items:
                  type: string
                description: Organization labels attached to the charge.
              overageOptions:
                type: object
                additionalProperties: true
                description: >-
                  Overage configuration, for example, included units and
                  unused-unit credit rates.
              prepaid:
                type: boolean
                description: Indicates whether the charge is prepaid.
              priceChangeOption:
                type: string
                description: >-
                  How price changes are handled on updates, for example,
                  no_change.
              pricingSummary:
                type: array
                items:
                  type: string
                description: Human-readable pricing summary lines.
              pricingWaterfalls:
                type: object
                additionalProperties: true
                description: >-
                  Pricing source breakdown, for example, base price vs. segment
                  price.
              productChargeDefinitions:
                type: array
                items:
                  type: object
                  additionalProperties: true
                description: >-
                  Charge definition objects that specify pricing and behavioral
                  rules.
              productRatePlanChargeNumber:
                type: string
                description: Charge number (PRPC number) for this charge.
              productRatePlanId:
                type: string
                description: Owning Product Rate Plan ID.
              prorationOption:
                type: string
                description: Proration behavior for this charge.
              rateCards:
                type: array
                items:
                  type: object
                  additionalProperties: true
                description: >-
                  Associated rate card definitions used for dynamic or segmented
                  pricing.
              revenue:
                type: object
                additionalProperties: true
                description: >-
                  Revenue recognition configuration, for example, rules and
                  codes.
              taxCode:
                type: string
                description: Tax code applied to the charge for taxation purposes.
        createTime:
          type: string
          format: date-time
          description: Plan creation time.
          example: '2025-02-24T01:20:44.000+00:00'
        updateTime:
          type: string
          format: date-time
          description: Plan update time.
          example: '2025-10-23T05:16:28.334+00:00'
        createdBy:
          type: string
          description: ID of the user who created the plan.
          example: 8a90a2fd8030ea2e018032b11d3a3f06
        updatedBy:
          type: string
          description: ID of the user who updated the plan.
          example: 53c162482f054f3ca08e1ec82dccfec9
    CreatePlanRequest:
      type: object
      required:
        - product_key
        - name
        - start_date
        - end_date
        - active_currencies
        - charges
      properties:
        product_key:
          type: string
          description: >-
            The unique identifier of the product under which the plan is
            created.
          example: 6b14067136304e64b090daccae6680cb
        name:
          type: string
          description: The name of the rate plan.
          example: New plan
        start_date:
          type: string
          format: date
          description: Plan effective start date (UTC, YYYY-MM-DD).
          example: '2024-01-01'
        end_date:
          type: string
          format: date
          description: Plan effective end date (UTC, YYYY-MM-DD).
          example: '2049-12-31'
        active_currencies:
          type: array
          description: ISO currency codes enabled for this plan.
          minItems: 1
          items:
            type: string
            minLength: 3
            maxLength: 3
          example:
            - USD
        charges:
          type: array
          description: The list of product rate plan charges to create under the plan.
          minItems: 1
          items:
            type: object
            required:
              - name
              - charge_model
              - charge_type
              - bill_cycle
              - trigger_event
              - end_date_condition
              - pricing
            properties:
              name:
                type: string
                description: The name of the charge.
                example: Flat PRPC 1
              charge_model:
                type: string
                description: Charge model that defines how pricing is calculated.
                enum:
                  - flat_fee
                  - per_unit
                  - overage
                  - volume
                  - tiered
                  - tiered_overage
                  - discount_fixed_amount
                  - discount_percentage
                  - custom_charge_model
                  - delivery
                  - minimum_commitment_true_up
                  - calculated
                  - high_water_mark_volume_pricing
                  - high_water_mark_tiered_pricing
                  - multi_attribute_pricing
                  - prerated_pricing
                  - prerated_per_unit
                example: flat_fee
              charge_type:
                type: string
                description: Charge type (recurring, usage, or one-time).
                enum:
                  - one_time
                  - recurring
                  - usage
                example: recurring
              unit_of_measure:
                type: string
                description: Unit of measure for per-unit or usage charges.
                example: Each
              list_price_base:
                type: string
                description: |
                  Optional list price base, if supported by the charge model.
                enum:
                  - Per_Billing_Period
                  - Per_Month
                  - Per_Week
                  - Per_Year
                  - Per_Specific_Months
                  - Per_Validity_Period
                example: Per_Billing_Period
              specific_list_price_base:
                type: number
                format: double
                description: >
                  Optional specific value used when `list_price_base` requires
                  an explicit quantity (for example, number of months for
                  `Per_Specific_Months`).
                example: 0
              pricing:
                type: object
                description: >-
                  Defines the pricing for the charge. Provide exactly one
                  structure per charge model.
                oneOf:
                  - title: Flat Fee Pricing
                    type: object
                    required:
                      - flat_amounts
                    properties:
                      flat_amounts:
                        type: object
                        description: Map of currency to flat amount.
                        additionalProperties:
                          type: number
                        example:
                          USD: 100
                  - title: Per Unit Pricing
                    type: object
                    required:
                      - unit_amounts
                    properties:
                      unit_amounts:
                        type: object
                        description: Map of currency to per-unit price.
                        additionalProperties:
                          type: number
                        example:
                          USD: 5
                  - title: Tiered or Volume Pricing
                    type: object
                    required:
                      - tiers
                    properties:
                      tiers:
                        type: array
                        description: Tier definitions with optional min/max caps.
                        items:
                          type: object
                          required:
                            - tier
                            - from
                            - price_format
                          properties:
                            tier:
                              type: string
                              description: Tier identifier.
                            from:
                              type: number
                              description: Lower bound (inclusive).
                            up_to:
                              type: number
                              nullable: true
                              description: >-
                                Upper bound (inclusive). Null for open-ended
                                last tier.
                            price_format:
                              type: string
                              description: Price format identifier used for the tier.
                              enum:
                                - price_format_flat_fee
                                - price_format_per_unit
                              example: price_format_per_unit
                            unit_amounts:
                              type: object
                              description: Per-unit price by currency for this tier.
                              additionalProperties:
                                type: number
                              example:
                                USD: 2.5
                            flat_amounts:
                              type: object
                              description: >-
                                Flat amount by currency for this tier (if
                                applicable).
                              additionalProperties:
                                type: number
                              example:
                                USD: 100
                            min_amounts:
                              type: object
                              description: Minimum billed amount by currency for this tier.
                              additionalProperties:
                                type: number
                              example:
                                USD: 6.25
                            max_amounts:
                              type: object
                              description: Maximum billed amount by currency for this tier.
                              additionalProperties:
                                type: number
                              example:
                                USD: 25
                  - title: Fixed Amount Discount
                    type: object
                    required:
                      - discount_amounts
                    properties:
                      discount_amounts:
                        type: object
                        description: Map of currency to discount amount.
                        additionalProperties:
                          type: number
                        example:
                          USD: 10
                  - title: Percentage Discount
                    type: object
                    required:
                      - discount_percentage
                    properties:
                      discount_percentage:
                        type: number
                        format: double
                        description: Discount percentage (e.g., 15 for 15%).
                        example: 15
              bill_cycle:
                type: object
                description: Defines how billing occurs for this charge.
                required:
                  - type
                  - period
                  - period_alignment
                properties:
                  type:
                    type: string
                    description: >
                      Determines how the billing day is selected for this
                      charge.
                    enum:
                      - default_from_customer
                      - specific_day_of_month
                      - subscription_start_day
                      - charge_trigger_day
                      - specific_day_of_week
                      - term_start_day
                      - term_end_day
                    example: specific_day_of_month
                  day_of_month:
                    type: integer
                    minimum: 1
                    maximum: 31
                    description: Required "when type is specific_day_of_month".
                    example: 5
                  day_of_week:
                    type: string
                    description: |
                      Used "when type is specific_day_of_week".
                    enum:
                      - sunday
                      - monday
                      - tuesday
                      - wednesday
                      - thursday
                      - friday
                      - saturday
                  period:
                    type: string
                    description: |
                      Billing period length.
                    enum:
                      - bill_cycle_period_month
                      - bill_cycle_period_quarter
                      - bill_cycle_period_semi_annual
                      - bill_cycle_period_annual
                      - bill_cycle_period_eighteen_months
                      - bill_cycle_period_two_years
                      - bill_cycle_period_three_years
                      - bill_cycle_period_five_years
                      - bill_cycle_period_specific_months
                      - bill_cycle_period_subscription_term
                      - bill_cycle_period_week
                      - bill_cycle_period_specific_weeks
                      - bill_cycle_period_specific_days
                    example: bill_cycle_period_month
                  period_alignment:
                    type: string
                    description: |
                      How the billing period start aligns. 
                    enum:
                      - align_to_charge
                      - align_to_subscription_start
                      - align_to_term_start
                      - align_to_term_end
                    example: align_to_charge
                  timing:
                    type: string
                    description: |
                      When the charge is billed relative to the service period.
                    enum:
                      - in_advance
                      - in_arrears
                    example: in_advance
              end_date_condition:
                type: string
                description: |
                  Defines when the charge ends.
                enum:
                  - subscription_end
                  - end_date_one_time
                  - fixed_period
                  - specific_end_date
                example: subscription_end
              up_to_periods_type:
                type: string
                description: >
                  Granularity used with `end_date_condition = fixed_period` to
                  express how long the charge remains active. When
                  `end_date_condition = subscription_end`, this field is
                  ignored.
                enum:
                  - billing_periods
                  - days
                  - weeks
                  - months
                  - years
                example: billing_periods
              up_to_periods:
                type: integer
                format: int32
                description: >
                  Number of periods used with `end_date_condition =
                  fixed_period`. Combined with `up_to_periods_type` to determine
                  the fixed duration of the charge. Ignored when
                  `end_date_condition = subscription_end`.
                example: 0
              trigger_event:
                type: string
                description: |
                  Event that triggers the charge. 
                enum:
                  - contract_effective
                  - service_activation
                  - customer_acceptance
                  - specific_date
                example: contract_effective
              accounting:
                $ref: '#/components/schemas/AccountingRequest'
      example:
        product_key: 6b14067136304e64b090daccae6680cb
        name: New plan
        start_date: '2024-01-01'
        end_date: '2049-12-31'
        active_currencies:
          - USD
        charges:
          - name: Flat PRPC 1
            charge_model: flat_fee
            charge_type: recurring
            pricing:
              flat_amounts:
                USD: 100
            bill_cycle:
              type: specific_day_of_month
              day_of_month: 5
              period_alignment: align_to_charge
              period: bill_cycle_period_month
              timing: in_advance
            end_date_condition: subscription_end
            trigger_event: contract_effective
            accounting:
              accounting_code: PRPC-REV-002
              accounts_receivable_account: Accounts Receivable
              deferred_revenue_account: Deferred Revenue
              recognized_revenue_account: Recognized Revenue
              adjustment_liability_account: adjustL-2
              adjustment_revenue_account: adjustRev-2
              contract_asset_account: CA-3
              contract_liability_account: CL-3
              contract_recognized_revenue_account: Contract Recognized Revenue
              unbilled_receivables_account: unbilledR-2
          - name: Flat PRPC 2
            charge_model: flat_fee
            charge_type: recurring
            pricing:
              flat_amounts:
                USD: 100
            bill_cycle:
              type: specific_day_of_month
              day_of_month: 5
              period_alignment: align_to_charge
              period: bill_cycle_period_month
              timing: in_advance
            end_date_condition: subscription_end
            trigger_event: contract_effective
            accounting:
              accounting_code: PRPC-REV-002
              accounts_receivable_account: Accounts Receivable
              deferred_revenue_account: Deferred Revenue
              recognized_revenue_account: Recognized Revenue
              adjustment_liability_account: adjustL-2
              adjustment_revenue_account: adjustRev-2
              contract_asset_account: CA-3
              contract_liability_account: CL-3
              contract_recognized_revenue_account: Contract Recognized Revenue
              unbilled_receivables_account: unbilledR-2
    CreatePlanResponse:
      type: object
      required:
        - id
        - name
        - startDate
        - endDate
        - activeCurrencies
      properties:
        id:
          type: string
          description: The unique identifier of the created plan (product rate plan).
          example: ee2d1ce1036c4dd6ae9d6945565ff7a0
        name:
          type: string
          description: Plan display name.
          example: New plan
        displayName:
          type: string
          description: The display name of the plan.
          example: ''
        description:
          type: string
          description: Free-form plan description.
          example: ''
        state:
          type: string
          description: Current lifecycle state of the plan.
          example: active
        startDate:
          type: string
          format: date
          description: Plan effective start date (UTC, YYYY-MM-DD).
          example: '2024-01-01'
        endDate:
          type: string
          format: date
          description: Plan effective end date (UTC, YYYY-MM-DD).
          example: '2049-12-31'
        activeCurrencies:
          type: array
          description: ISO currency codes enabled for the plan.
          items:
            type: string
          example:
            - USD
        createTime:
          type: string
          format: date-time
          description: Timestamp when the plan was created.
          example: '2025-10-13T07:46:02.314-07:00'
        updateTime:
          type: string
          format: date-time
          description: Timestamp when the plan was last updated.
          example: '2025-10-13T07:46:02.314-07:00'
        createdBy:
          type: string
          description: User ID that created the plan.
          example: 53c162482f054f3ca08e1ec82dccfec9
        updatedBy:
          type: string
          description: User ID that last updated the plan.
          example: 53c162482f054f3ca08e1ec82dccfec9
        productId:
          type: string
          description: The product ID (key) this plan belongs to.
          example: 7228c9e6fd814e3a9e59bcdf0117e34f
        productRatePlanNumber:
          type: string
          description: Plan number
          example: PRP-00000195
        customFields:
          type: object
          description: Custom field values on the plan.
          additionalProperties: true
        attributes:
          type: array
          description: Attribute metadata defined at the plan level (if any).
          items:
            type: object
        contextFilters:
          type: array
          description: Contextual filters used to limit plan applicability.
          items:
            type: object
        entitlements:
          type: array
          description: Entitlements included with the plan.
          items:
            type: object
        externalIdSourceSystem:
          type: string
          description: Source system identifier for external integrations.
          example: ''
        externalRateplanId:
          type: array
          description: External rate plan identifiers, if any.
          items:
            type: string
        organizationLabels:
          type: array
          description: Organization-level labels associated with the plan.
          items:
            type: object
        netsuite:
          type: object
          nullable: true
          description: NetSuite integration metadata (if present).
          example: null
        productRatePlanCharges:
          type: array
          description: Charges created under this plan.
          items:
            type: object
            required:
              - id
              - name
              - chargeModel
              - chargeType
              - pricing
              - billCycle
            properties:
              id:
                type: string
                description: Unique identifier of the product rate plan charge (PRPC).
                example: ad95b694d2b8442b84dc8ad26561c7d7
              name:
                type: string
                description: Charge display name within the plan.
                example: Flat PRPC 1
              chargeModel:
                type: string
                description: Pricing model that determines how the amount is calculated.
                example: flat_fee
              chargeType:
                type: string
                description: Whether the charge recurs, rates usage, or is a one-time fee.
                example: recurring
              chargeFunction:
                type: string
                description: Internal function identifier for the charge.
                example: charge_function_standard
              productRatePlanChargeNumber:
                type: string
                description: PRPC number
                example: PRPC-00000279
              triggerEvent:
                type: string
                description: Event that triggers the charge to start billing.
                example: contract_effective
              endDateCondition:
                type: string
                description: Rule for when the charge ends, for example, subscription_end.
                example: subscription_end
              upToPeriodsType:
                type: string
                description: Unit applied when charge ends after a fixed duration.
                example: billing_periods
              upToPeriods:
                type: number
                description: Number of periods defining fixed charge duration.
                example: 0
              listPriceBase:
                type: string
                description: List price basis, for example, Per_Billing_Period.
                example: Per_Billing_Period
              specificListPriceBase:
                type: number
                description: >
                  Optional override for list price base when billing uses a
                  specific period configuration.
                example: 0
              billCycle:
                type: object
                description: How and when this charge bills within each billing period.
                properties:
                  type:
                    type: string
                    description: >-
                      Bill-cycle mode (inherit defaults or set specific day
                      rules).
                    example: specific_day_of_month
                  dayOfMonth:
                    type: integer
                    description: Specific bill day when type = specific_day_of_month.
                    example: 5
                  period:
                    type: string
                    description: >-
                      Billing period length, for example,
                      bill_cycle_period_month.
                    example: bill_cycle_period_month
                  periodAlignment:
                    type: string
                    description: >-
                      How the billing period start aligns, for example,
                      align_to_charge.
                    example: align_to_charge
                  timing:
                    type: string
                    description: >-
                      Whether the charge bills before or after the service
                      period.
                    example: in_advance
              accounting:
                $ref: '#/components/schemas/AccountingResponse'
              pricing:
                type: object
                description: Default (charge-level) price configuration by model/currency.
                properties:
                  flatAmounts:
                    type: object
                    additionalProperties:
                      type: number
                    description: Flat amounts by currency for flat-fee pricing.
                    example:
                      USD: 100
                  unitAmounts:
                    type: object
                    additionalProperties:
                      type: number
                    description: Per-unit amounts by currency for per-unit/usage pricing.
                  tiers:
                    type: array
                    items:
                      type: object
                    description: Tier definitions for tiered/volume pricing.
                  discountAmounts:
                    type: object
                    additionalProperties:
                      type: number
                    description: Fixed discount amounts by currency.
                  discountPercentages:
                    type: object
                    additionalProperties:
                      type: number
                    description: Percentage discount values by currency.
                  minAmounts:
                    type: object
                    additionalProperties:
                      type: number
                    description: Minimum charge amounts by currency.
                  maxAmounts:
                    type: object
                    additionalProperties:
                      type: number
                    description: Maximum charge amounts by currency.
                  percentages:
                    type: object
                    additionalProperties:
                      type: number
                    description: Percentage price values by currency (model-dependent).
              priceChangeOption:
                type: string
                description: How price changes are applied across renewals/amendments.
                example: no_change
              prorationOption:
                type: string
                description: How proration is handled relative to tenant defaults.
                example: default_from_tenant_setting
              taxable:
                type: boolean
                description: Whether the charge is taxable.
                example: false
              discountOptions:
                type: object
                description: How discount charges apply and interact with other discounts.
                properties:
                  stackedDiscount:
                    type: boolean
                    description: Whether this discount stacks with other discounts.
                    example: false
                  applyToBillingPeriodPartially:
                    type: boolean
                    description: >-
                      Whether the discount can partially align to a billing
                      period.
                    example: false
                  reflectDiscountInNetAmount:
                    type: boolean
                    description: Whether discounts reduce the net amount on invoices.
                    example: false
                  rollover:
                    type: boolean
                    description: Whether unused discount can roll over to future periods.
                    example: false
              attributes:
                type: array
                description: Attribute metadata for this charge.
                items:
                  type: object
              createdById:
                type: string
                description: User ID that created the charge record.
                example: 53c162482f054f3ca08e1ec82dccfec9
              createdTime:
                type: string
                format: date-time
                description: Timestamp when the charge record was created.
                example: '2025-10-13T07:46:02.375-07:00'
              updatedById:
                type: string
                description: User ID that last updated the charge record.
                example: 53c162482f054f3ca08e1ec82dccfec9
              updatedTime:
                type: string
                format: date-time
                description: Timestamp when the charge record was last updated.
                example: '2025-10-13T07:46:02.375-07:00'
              labels:
                type: object
                additionalProperties: true
                description: Free-form labels/tags attached to the charge.
              mergedRateCards:
                type: array
                items:
                  type: object
                description: Effective rate-card rows after merges (if any).
              negotiatedRateCards:
                type: array
                items:
                  type: object
                description: Customer- or deal-specific rate-card rows.
              ocmJsonByCurrency:
                type: object
                additionalProperties: true
                description: Offer/OCM metadata keyed by currency (internal use).
              productChargeDefinitions:
                type: array
                items:
                  type: object
                description: Underlying charge definitions referenced for pricing.
              rateCards:
                type: array
                items:
                  type: object
                description: Dynamic Pricing rate-card rows configured on the charge.
              pricingSummary:
                type: array
                items:
                  type: object
                description: Structured price summary breakdown (if returned).
              pricingWaterfalls:
                type: object
                additionalProperties: true
                description: Detailed pricing/waterfall breakdown (if returned).
              overageOptions:
                type: object
                description: Overage settings for usage charges.
                properties:
                  includedUnits:
                    type: number
                    description: Included units before overage starts.
                    example: 0
                  unusedUnitsCreditRates:
                    type: object
                    additionalProperties:
                      type: number
                    description: Credit rates for unused units (by currency).
              prepaid:
                type: boolean
                description: Indicates whether the charge is prepaid.
                example: false
              prepayment:
                type: object
                description: Prepayment handling and rollover behavior.
                properties:
                  rollover:
                    type: boolean
                    description: Whether unused prepayment rolls over.
                    example: false
                  rolloverApply:
                    type: string
                    description: Order in which rollover is applied.
                    example: apply_last
                  rolloverPeriodLength:
                    type: integer
                    description: Length of each rollover period.
                    example: 0
                  rolloverPeriods:
                    type: integer
                    description: Number of rollover periods allowed.
                    example: 0
              isChargeLevelMinCommit:
                type: boolean
                description: Whether a minimum commit is enforced at the charge level.
                example: false
              isCommitted:
                type: boolean
                description: Indicates if the charge definition is committed/finalized.
                example: false
              useTenantDefaultForPriceChange:
                type: boolean
                description: Whether tenant defaults govern price change behavior.
                example: true
              revenue:
                type: object
                description: Revenue policy settings for this charge.
                properties:
                  excludeItemBillingFromRevenueAccounting:
                    type: boolean
                    description: If true, item billing is excluded from revenue accounting.
                    example: false
                  excludeItemBookingFromRevenueAccounting:
                    type: boolean
                    description: If true, item booking is excluded from revenue accounting.
                    example: false
                  legacyReporting:
                    type: boolean
                    description: Indicator for legacy revenue reporting behaviors.
                    example: false
                  revenueRecognitionRuleName:
                    type: string
                    description: Name of the revenue recognition rule applied.
                    example: Recognize upon invoicing
            additionalProperties: true
      additionalProperties: true
    ListPlansRequest:
      type: object
      description: Request body for retrieving Product Rate Plans from the Product Catalog.
      properties:
        filters:
          type: array
          description: |
            Filter conditions for querying product rate plans.  
            Each filter defines a field, operator, and value.
          items:
            type: object
            required:
              - field
              - operator
              - value
            properties:
              field:
                type: string
                description: >-
                  Field name to filter by, such as `prp_id`, `product_id`, or
                  `name`.
                example: prp_id
              operator:
                type: string
                description: >
                  Comparison operator for the filter condition. Supported
                  values:

                  - `EQ`  (equals)

                  - `NE`  (not equals)

                  - `IN`  (in a list of values)

                  - `LIKE` (partial match)

                  - `GT`  (greater than)

                  - `GTE` (greater than or equal)

                  - `LT`  (less than)

                  - `LTE` (less than or equal)

                  - `SW`  (starts with)

                  - `EW`  (ends with)
                enum:
                  - EQ
                  - NE
                  - IN
                  - LIKE
                  - GT
                  - GTE
                  - LT
                  - LTE
                  - SW
                  - EW
                example: EQ
              value:
                type: string
                description: Value to match for the specified field.
                example: 38660706ef2f48cfb5222f7dde491895
        expand:
          type: object
          description: Expand related entities in the response.
          properties:
            product_rate_plan_charges:
              type: boolean
              description: Whether to include associated Product Rate Plan Charges (PRPCs).
              example: true
      required:
        - filters
    ListPlansResponse:
      type: object
      description: Response body containing a list of Product Rate Plans.
      properties:
        values:
          type: array
          description: List of Product Rate Plans returned by the query.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the Product Rate Plan.
                example: 38660706ef2f48cfb5222f7dde491895
              name:
                type: string
                description: Product Rate Plan name.
                example: Bronze Plan
              description:
                type: string
                description: Product Rate Plan description.
                example: Basic version of our software service
              productId:
                type: string
                description: Identifier of the product this plan belongs to.
                example: 8a90aac8948deebf01949098b7790326
              startDate:
                type: string
                format: date
                description: Effective start date of the plan (UTC, YYYY-MM-DD).
                example: '2025-09-10'
              endDate:
                type: string
                format: date
                description: Effective end date of the plan (UTC, YYYY-MM-DD).
                example: '2027-01-01'
              state:
                type: string
                description: Current plan state.
                example: active
              status:
                type: string
                description: Status of the plan.
                example: ACTIVE
              activeCurrencies:
                type: array
                items:
                  type: string
                description: Currencies supported by this plan.
                example:
                  - USD
              accounting:
                $ref: '#/components/schemas/AccountingResponse'
              productRatePlanNumber:
                type: string
                description: Product Rate Plan number.
                example: PRP-00000172
              productRatePlanCharges:
                type: array
                description: >-
                  List of Product Rate Plan Charges (PRPCs) belonging to the
                  plan.
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier of the Product Rate Plan Charge.
                      example: fe9b0e764dca4178a11c0e471e5dc0d8
                    name:
                      type: string
                      description: Charge name.
                      example: prepay_currency
                    chargeType:
                      type: string
                      description: Charge type (recurring, one_time, or usage).
                      example: recurring
                    chargeModel:
                      type: string
                      description: Charge model (flat_fee, per_unit, tiered, etc.).
                      example: flat_fee
                    listPriceBase:
                      type: string
                      description: Indicates how list price is interpreted.
                      example: Per_Billing_Period
                    specificListPriceBase:
                      type: number
                      description: >
                        Optional override for list price base when billing uses
                        a specific period configuration.
                      example: 0
                    triggerEvent:
                      type: string
                      description: Event that triggers the charge.
                      example: contract_effective
                    unitOfMeasure:
                      type: string
                      description: Unit of measure used for pricing (for example, Each).
                      example: Each
                    defaultQuantity:
                      type: number
                      description: Default quantity applied for the charge.
                      example: 1
                    endDateCondition:
                      type: string
                      description: Condition that determines when the charge ends.
                      example: subscription_end
                    upToPeriodsType:
                      type: string
                      description: Unit applied when charge ends after a fixed duration.
                      example: billing_periods
                    upToPeriods:
                      type: number
                      description: Number of periods defining fixed charge duration.
                      example: 0
                    billCycle:
                      type: object
                      description: Billing cycle configuration.
                      additionalProperties: true
                      example:
                        period: bill_cycle_period_quarter
                        periodAlignment: align_to_term_start
                        timing: in_advance
                        type: term_start_day
                    pricing:
                      type: object
                      description: Pricing configuration for the charge.
                      additionalProperties: true
                      example:
                        flatAmounts:
                          USD: 30
                        tiers: []
                    pricingSummary:
                      type: array
                      items:
                        type: string
                      description: Human-readable pricing summary lines.
                      example:
                        - USD30
                    taxMode:
                      type: string
                      description: Tax mode for this charge.
                      example: non_taxable
                    taxable:
                      type: boolean
                      description: Indicates whether the charge is taxable.
                      example: false
                    createdById:
                      type: string
                      description: ID of the user who created the charge.
                      example: 8a90a2fd8030ea2e018032b11d3a3f06
                    createdTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was created.
                      example: '2025-02-24T01:21:23.000+00:00'
                    updatedById:
                      type: string
                      description: ID of the user who last updated the charge.
                      example: 8a90a2fd8030ea2e018032b11d3a3f06
                    updatedTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was last updated.
                      example: '2025-02-24T01:21:23.000+00:00'
    GetProductByKeyResponse:
      type: object
      description: Response body returned when retrieving a product by product key.
      properties:
        allowFeatureChanges:
          type: boolean
          example: false
        category:
          type: string
          description: Product category, for example `base` or `add_on`.
          example: base
        contextFilters:
          type: array
          items:
            type: object
        createdBy:
          type: string
          description: ID of the user who created the product.
          example: 53c162482f054f3ca08e1ec82dccfec9
        createdTime:
          type: string
          format: date-time
          example: '2025-10-13T07:44:55.000-07:00'
        customFields:
          type: object
          description: Custom field values keyed by API name.
          additionalProperties: true
        customObjects:
          type: object
          nullable: true
          description: Custom object references related to this product.
          example: null
        dacTag:
          type: object
          description: Internal DAC tag associated with the product.
          properties:
            id:
              type: string
              description: DAC tag identifier.
              example: 1234567890abcdef
            name:
              type: string
              description: DAC tag name.
              example: Example DAC Tag
        endDate:
          type: string
          format: date
          description: Product effective end date.
          example: '2050-12-31'
        features:
          type: array
          items:
            type: object
        id:
          type: string
          description: Unique identifier of the product.
          example: 7228c9e6fd814e3a9e59bcdf0117e34f
        legacyFeatures:
          type: array
          description: Legacy, customer-defined feature objects retained for compatibility.
          items:
            type: object
            additionalProperties: true
        name:
          type: string
          description: Product name.
          example: New prod
        netsuite:
          type: object
          nullable: true
          description: NetSuite integration metadata if applicable.
          example: null
        organizationLabels:
          type: array
          items:
            type: object
        productNumber:
          type: string
          description: System-generated product number.
          example: PC-00000103
        productRatePlans:
          type: array
          description: List of rate plans under this product.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the Product Rate Plan.
                example: 38660706ef2f48cfb5222f7dde491895
              createdBy:
                type: string
                description: ID of the user who created the rate plan.
                example: 53c162482f054f3ca08e1ec82dccfec9
              createTime:
                type: string
                format: date-time
                description: Timestamp when the rate plan was created.
                example: '2025-02-24T01:21:23.000+00:00'
              updatedBy:
                type: string
                description: ID of the user who last updated the rate plan.
                example: 53c162482f054f3ca08e1ec82dccfec9
              updateTime:
                type: string
                format: date-time
                description: Timestamp when the rate plan was last updated.
                example: '2025-02-24T01:21:23.000+00:00'
              name:
                type: string
                description: Product Rate Plan name.
                example: Bronze Plan
              displayName:
                type: string
                description: Product Rate Plan display name.
                example: Bronze Plan
              description:
                type: string
                description: Product Rate Plan description.
                example: Basic version of our software service
              productId:
                type: string
                description: Identifier of the product this plan belongs to.
                example: 7228c9e6fd814e3a9e59bcdf0117e34f
              startDate:
                type: string
                format: date
                description: Effective start date of the plan (UTC, YYYY-MM-DD).
                example: '2025-09-10'
              endDate:
                type: string
                format: date
                description: Effective end date of the plan (UTC, YYYY-MM-DD).
                example: '2027-01-01'
              state:
                type: string
                description: Current plan state.
                example: active
              status:
                type: string
                description: Status of the plan.
                example: ACTIVE
              activeCurrencies:
                type: array
                items:
                  type: string
                description: Currencies supported by this plan.
                example:
                  - USD
              productRatePlanNumber:
                type: string
                description: Product Rate Plan number.
                example: PRP-00000172
              productRatePlanCharges:
                type: array
                description: >-
                  List of Product Rate Plan Charges (PRPCs) belonging to the
                  plan.
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier of the Product Rate Plan Charge.
                      example: fe9b0e764dca4178a11c0e471e5dc0d8
                    productRatePlanChargeNumber:
                      type: string
                      description: System-generated number of the Product Rate Plan Charge.
                      example: PRPC-00000279
                    name:
                      type: string
                      description: Charge name.
                      example: prepay_currency
                    description:
                      type: string
                      description: Charge description.
                      example: Prepaid recurring software fee
                    chargeType:
                      type: string
                      description: Charge type (recurring, one_time, or usage).
                      example: recurring
                    chargeModel:
                      type: string
                      description: Charge model (flat_fee, per_unit, tiered, etc.).
                      example: flat_fee
                    listPriceBase:
                      type: string
                      description: Indicates how list price is interpreted.
                      example: Per_Billing_Period
                    specificListPriceBase:
                      type: integer
                      description: >-
                        Specifies the number of periods for list price when
                        listPriceBase is period-based.
                      example: 1
                    triggerEvent:
                      type: string
                      description: Event that triggers the charge.
                      example: contract_effective
                    endDateCondition:
                      type: string
                      description: Condition that determines when the charge ends.
                      example: subscription_end
                    upToPeriodsType:
                      type: string
                      description: >-
                        Type of period used with `upToPeriods` to control charge
                        duration.
                      example: billing_periods
                    upToPeriods:
                      type: integer
                      description: >-
                        Number of periods after which the charge ends, based on
                        `upToPeriodsType`.
                      example: 1
                    billCycle:
                      type: object
                      description: Billing cycle configuration.
                      additionalProperties: true
                      example:
                        period: bill_cycle_period_quarter
                        periodAlignment: align_to_term_start
                        timing: in_advance
                        type: term_start_day
                    pricing:
                      type: object
                      description: Pricing configuration for the charge.
                      additionalProperties: true
                      example:
                        flatAmounts:
                          USD: 30
                        tiers: []
                    pricingSummary:
                      type: array
                      items:
                        type: string
                      description: Human-readable pricing summary lines.
                      example:
                        - USD30
                    taxMode:
                      type: string
                      description: Tax mode for this charge.
                      example: non_taxable
                    taxable:
                      type: boolean
                      description: Indicates whether the charge is taxable.
                      example: false
                    createdById:
                      type: string
                      description: ID of the user who created the charge.
                      example: 53c162482f054f3ca08e1ec82dccfec9
                    createdTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was created.
                      example: '2025-02-24T01:21:23.000+00:00'
                    updatedById:
                      type: string
                      description: ID of the user who last updated the charge.
                      example: 53c162482f054f3ca08e1ec82dccfec9
                    updatedTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was last updated.
                      example: '2025-02-24T01:21:23.000+00:00'
        sku:
          type: string
          description: Stock keeping unit for the product.
          example: SKU-00000133
        startDate:
          type: string
          format: date
          description: Product effective start date.
          example: '2024-01-01'
        state:
          type: string
          description: Current product state.
          example: product_active
        updatedBy:
          type: string
          description: ID of the user who last updated the product.
          example: 53c162482f054f3ca08e1ec82dccfec9
        updatedTime:
          type: string
          format: date-time
          description: Timestamp of the last update.
          example: '2025-10-13T07:44:55.000-07:00'
      example:
        allowFeatureChanges: false
        category: base
        contextFilters: []
        createdBy: 53c162482f054f3ca08e1ec82dccfec9
        createdTime: '2025-10-13T07:44:55.000-07:00'
        customFields: {}
        customObjects: null
        dacTag:
          id: 1234567890abcdef
          name: Example DAC Tag
        endDate: '2050-12-31'
        features: []
        id: 7228c9e6fd814e3a9e59bcdf0117e34f
        legacyFeatures: []
        name: New prod
        netsuite: null
        organizationLabels: []
        productNumber: PC-00000103
        productRatePlans:
          - id: 38660706ef2f48cfb5222f7dde491895
            createdBy: 53c162482f054f3ca08e1ec82dccfec9
            createTime: '2025-02-24T01:21:23.000+00:00'
            updatedBy: 53c162482f054f3ca08e1ec82dccfec9
            updateTime: '2025-02-24T01:21:23.000+00:00'
            name: Bronze Plan
            displayName: Bronze Plan
            description: Basic version of our software service
            productId: 7228c9e6fd814e3a9e59bcdf0117e34f
            startDate: '2025-09-10'
            endDate: '2027-01-01'
            state: active
            status: ACTIVE
            activeCurrencies:
              - USD
            productRatePlanNumber: PRP-00000172
            productRatePlanCharges:
              - id: fe9b0e764dca4178a11c0e471e5dc0d8
                productRatePlanChargeNumber: PRPC-00000279
                name: prepay_currency
                description: Prepaid recurring software fee
                chargeType: recurring
                chargeModel: flat_fee
                listPriceBase: Per_Billing_Period
                specificListPriceBase: 1
                triggerEvent: contract_effective
                endDateCondition: subscription_end
                upToPeriodsType: billing_periods
                upToPeriods: 1
                billCycle:
                  period: bill_cycle_period_quarter
                  periodAlignment: align_to_term_start
                  timing: in_advance
                  type: term_start_day
                pricing:
                  flatAmounts:
                    USD: 30
                  tiers: []
                pricingSummary:
                  - USD30
                taxMode: non_taxable
                taxable: false
                createdById: 53c162482f054f3ca08e1ec82dccfec9
                createdTime: '2025-02-24T01:21:23.000+00:00'
                updatedById: 53c162482f054f3ca08e1ec82dccfec9
                updatedTime: '2025-02-24T01:21:23.000+00:00'
        sku: SKU-00000133
        startDate: '2024-01-01'
        state: product_active
        updatedBy: 53c162482f054f3ca08e1ec82dccfec9
        updatedTime: '2025-10-13T07:44:55.000-07:00'
    CreateProductListLegacyRequest:
      type: object
      description: Request body for querying legacy products in the Product Catalog.
      properties:
        filters:
          type: array
          description: >
            Filter conditions for querying legacy products. 

            Each filter defines a field, an operator, and a value to match
            against.

            Common filter fields include `id`, `name`, `product_number`, or
            `category`.
          items:
            type: object
            required:
              - field
              - operator
              - value
            properties:
              field:
                type: string
                description: |
                  Field name to filter by. 
                example: id
                enum:
                  - id
                  - name
                  - product_number
                  - category
              operator:
                type: string
                description: |
                  Comparison operator for the filter condition. 
                  Supported values:
                    - `EQ`  (equals)
                    - `NE`  (not equals)
                    - `LT`  (less than)
                    - `GT`  (greater than)
                    - `SW`  (starts with)
                    - `EW`  (ends with)
                    - `IN`  (in list of values)
                    - `LIKE` (partial match)
                example: EQ
                enum:
                  - EQ
                  - NE
                  - LT
                  - GT
                  - SW
                  - IN
                  - EW
                  - LIKE
              value:
                type: string
                description: |
                  Value to match for the specified field.
                  The data type depends on the field being filtered.
                example: 8a90850b963680cb01963ad92a7a46e0
        expand:
          type: object
          description: >
            Defines whether to include related entities such as Product Rate
            Plans (PRPs) and 

            Product Rate Plan Charges (PRPCs) in the response. Each key
            corresponds to an entity type that can be expanded.
          properties:
            product_rate_plans:
              type: boolean
              description: >-
                When true, includes Product Rate Plans (PRPs) under each
                product.
              example: true
            product_rate_plan_charges:
              type: boolean
              description: >-
                When true, includes Product Rate Plan Charges (PRPCs) for each
                rate plan.
              example: true
      example:
        filters:
          - field: id
            operator: EQ
            value: 8a90850b963680cb01963ad92a7a46e0
        expand:
          product_rate_plans: true
          product_rate_plan_charges: true
    CreateProductListLegacyResponse:
      type: object
      description: Response body returned after querying legacy products.
      properties:
        values:
          type: array
          description: List of legacy products matching the query.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the product.
                example: 1a951a549f464e93bea1bfe7b8ffce1f
              name:
                type: string
                description: Product name.
                example: ABP demo product
              description:
                type: string
                description: Product description.
                example: ''
              category:
                type: string
                description: Product category label.
                example: Add On Services
              productNumber:
                type: string
                description: Product number in the catalog.
                example: PC-00011567
              sku:
                type: string
                description: Product SKU.
                example: SKU-00011727
              effectiveStartDate:
                type: string
                format: date
                description: Date when the product becomes effective in the catalog.
                example: '2025-05-01'
              effectiveEndDate:
                type: string
                format: date
                description: Date when the product is no longer effective in the catalog.
                example: '2025-05-31'
              state:
                type: string
                description: Current product state.
                example: active
              allowFeatureChanges:
                type: boolean
                description: Whether features on this product can be changed.
                example: false
              contextFilters:
                type: array
                description: Context filters applied to the product.
                items:
                  type: object
                  additionalProperties: true
              features:
                type: array
                description: Product features.
                items:
                  type: object
                  additionalProperties: true
              legacyFeatures:
                type: array
                description: Legacy features associated with this product.
                items:
                  type: object
                  additionalProperties: true
              customFields:
                type: object
                description: Custom fields on the product.
                additionalProperties: true
                example:
                  DecimalNumber__c: 1.12
                  test5bool__c: true
              customObjects:
                type: object
                nullable: true
                description: Custom objects linked to this product.
                additionalProperties: true
              netsuite:
                type: object
                description: Netsuite integration attributes.
                additionalProperties: true
              organizationLabels:
                type: array
                description: Organization labels for the product.
                items:
                  type: string
              createdBy:
                type: string
                description: ID of the user who created the product.
                example: 34aa321aa7cd46d19bebcf9c090af7a0
              createdTime:
                type: string
                format: date-time
                description: Timestamp when the product was created.
                example: '2025-05-01T19:32:51.000+00:00'
              updatedBy:
                type: string
                description: ID of the user who last updated the product.
                example: 34aa321aa7cd46d19bebcf9c090af7a0
              updatedTime:
                type: string
                format: date-time
                description: Timestamp when the product was last updated.
                example: '2025-05-12T08:19:44.000+00:00'
              productRatePlans:
                type: array
                description: Product rate plans (PRPs) of the product.
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Unique identifier of the Product Rate Plan.
                      example: c3a52dd029704b7e89274c9e7e8fd99c
                    name:
                      type: string
                      description: Rate plan name.
                      example: Demo Rate Plan
                    description:
                      type: string
                      description: Rate plan description.
                      example: ''
                    displayName:
                      type: string
                      description: Rate plan display name.
                      example: ''
                    state:
                      type: string
                      description: Current rate plan state.
                      example: active
                    effectiveStartDate:
                      type: string
                      format: date
                      description: Effective start date of the rate plan.
                      example: '2025-05-01'
                    effectiveEndDate:
                      type: string
                      format: date
                      description: Effective end date of the rate plan.
                      example: '2025-05-31'
                    activeCurrencies:
                      type: array
                      description: Currencies with active pricing.
                      items:
                        type: string
                      example:
                        - USD
                    productId:
                      type: string
                      description: Owning product ID.
                      example: 1a951a549f464e93bea1bfe7b8ffce1f
                    productRatePlanNumber:
                      type: string
                      description: Rate plan number.
                      example: PRP-00012518
                    attributes:
                      type: array
                      description: Attribute definitions associated with the plan.
                      items:
                        type: object
                        additionalProperties: true
                    contextFilters:
                      type: array
                      description: Context filters at the plan level.
                      items:
                        type: object
                        additionalProperties: true
                    customFields:
                      type: object
                      description: Custom fields at the plan level.
                      additionalProperties: true
                    entitlements:
                      type: array
                      description: Entitlements linked to the plan.
                      items:
                        type: object
                        additionalProperties: true
                    externalIdSourceSystem:
                      type: string
                      description: External ID source system.
                      example: ''
                    externalManagedPlanIds:
                      type: array
                      items:
                        type: string
                      description: External plan identifiers.
                    netsuite:
                      type: object
                      additionalProperties: true
                      description: Netsuite integration attributes.
                    organizationLabels:
                      type: array
                      items:
                        type: string
                      description: Organization labels.
                    createTime:
                      type: string
                      format: date-time
                      description: Plan creation time.
                      example: '2025-05-01T19:33:11.000+00:00'
                    createdBy:
                      type: string
                      description: ID of the user who created the plan.
                    updateTime:
                      type: string
                      format: date-time
                      description: Plan update time.
                    updatedBy:
                      type: string
                      description: ID of the user who updated the plan.
                    productRatePlanCharges:
                      type: array
                      description: Charges (PRPCs) that belong to this product rate plan.
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            description: Unique identifier of the Product Rate Plan Charge.
                            example: ebcd93dc77b34d20912dbfae5881acff
                          name:
                            type: string
                            description: Charge name.
                            example: Charge with state 2
                          model:
                            type: string
                            description: Charge model.
                            example: PerUnit
                          uom:
                            type: string
                            description: Unit of measure.
                            example: Each
                          billingDay:
                            type: string
                            description: Billing day behavior.
                          billingPeriod:
                            type: string
                            description: Billing period (e.g., Month).
                            example: Month
                          billingPeriodAlignment:
                            type: string
                            description: Alignment for billing period.
                            example: AlignToCharge
                          billingTiming:
                            type: string
                            description: Billing timing (IN_ADVANCE or IN_ARREARS).
                            example: IN_ADVANCE
                          listPriceBase:
                            type: string
                            description: How list price is interpreted.
                            example: Per_Billing_Period
                          defaultQuantity:
                            type: number
                            description: Default quantity for the charge.
                            example: 10
                          includedUnits:
                            type: number
                            description: Included units for usage or dimensional pricing.
                            example: 0
                          isDimensionalPrice:
                            type: boolean
                            description: Indicates if the charge uses dimensional pricing.
                            example: true
                          triggerEvent:
                            type: string
                            description: Event that triggers the charge.
                            example: ContractEffective
                          productRatePlanId:
                            type: string
                            description: Owning PRP ID.
                            example: c3a52dd029704b7e89274c9e7e8fd99c
                          productRatePlanChargeNumber:
                            type: string
                            description: Charge number.
                            example: PRPC-00017066
                          attributes:
                            type: array
                            description: Dynamic pricing attributes bound to the charge.
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Attribute name
                                  example: State
                                type:
                                  type: string
                                  description: Attribute type
                                  example: String
                                mapping:
                                  type: object
                                  description: Source mapping for attribute values.
                                  properties:
                                    object:
                                      type: string
                                      description: Source object
                                      example: account
                                    field:
                                      type: string
                                      description: Source field
                                      example: state__c
                          pricing:
                            type: array
                            description: Currency pricing entries.
                            items:
                              type: object
                              properties:
                                currency:
                                  type: string
                                  description: ISO currency code
                                  example: USD
                                price:
                                  type: number
                                  format: double
                                  description: Price for the currency
                                  example: 101
                                tiers:
                                  type: array
                                  items:
                                    type: object
                                  description: Tier definitions (if applicable).
                          pricingSummary:
                            type: array
                            description: Human-readable pricing summary.
                            items:
                              type: string
                            example:
                              - USD101/Each
                          pricingWaterfalls:
                            type: object
                            description: Price sources such as base and segment prices.
                            additionalProperties: true
                          revenue:
                            type: object
                            description: Revenue recognition settings.
                            additionalProperties: true
                          netsuite:
                            type: object
                            description: Netsuite integration settings.
                            additionalProperties: true
                          customFields:
                            type: object
                            description: Custom fields on the charge.
                            additionalProperties: true
                          accounting:
                            type: object
                            additionalProperties: true
                            description: Accounting configuration.
                          applyToBillingPeriodPartially:
                            type: boolean
                            description: >-
                              Indicates whether the charge is applied to partial
                              billing periods.
                          creditOption:
                            type: string
                            description: >-
                              Specifies how credits are handled for this charge,
                              for example, credit_option.
                          deliverySchedule:
                            type: object
                            additionalProperties: true
                            description: >-
                              Defines the delivery frequency and applicable days
                              for the charge.
                          discountRollover:
                            type: boolean
                            description: >-
                              Indicates whether unused discounts roll over to
                              the next billing period.
                          endDateCondition:
                            type: string
                            description: >-
                              Defines when the charge ends, such as at the
                              subscription end or after a fixed term.
                          extendedPrice:
                            type: object
                            additionalProperties: true
                            description: >-
                              Contains calculated extended pricing details for
                              the charge, if applicable.
                          isCommitted:
                            type: boolean
                            description: >-
                              Indicates whether this charge is part of a
                              committed contract.
                          isPrepaid:
                            type: boolean
                            description: Specifies whether the charge is prepaid.
                          isRollover:
                            type: boolean
                            description: >-
                              Indicates whether unused units or balances roll
                              over to subsequent periods.
                          isStackedDiscount:
                            type: boolean
                            description: >-
                              Indicates whether this charge supports multiple
                              stacked discounts.
                          labels:
                            type: object
                            additionalProperties: true
                            description: >-
                              Stores additional key-value metadata labels
                              associated with the charge.
                          ocmJsonByCurrency:
                            type: object
                            additionalProperties: true
                            description: >-
                              Contains pricing or configuration metadata per
                              currency in JSON format.
                          priceChangeOption:
                            type: string
                            description: >-
                              Defines how price changes are handled when the
                              product or rate plan changes.
                          productChargeDefinitions:
                            type: array
                            description: >-
                              List of charge-level definition objects that
                              specify pricing and behavior for the charge.
                            items:
                              type: object
                              additionalProperties: true
                          productDiscountApplyDetails:
                            type: array
                            description: >-
                              Details of how discounts are applied to this
                              charge.
                            items:
                              type: object
                              additionalProperties: true
                          rateCards:
                            type: array
                            description: >-
                              Associated rate card definitions used for dynamic
                              or segmented pricing.
                            items:
                              type: object
                              additionalProperties: true
                          reflectDiscountInNetAmount:
                            type: boolean
                            description: >-
                              Indicates whether discounts are reflected directly
                              in the net amount of the charge.
                          rolloverApply:
                            type: string
                            description: >-
                              Defines how rolled-over balances or discounts are
                              applied.
                          rolloverPeriodLength:
                            type: number
                            description: >-
                              Length of each rollover period, in the unit
                              specified by the product configuration.
                          rolloverPeriods:
                            type: number
                            description: >-
                              Total number of rollover periods allowed for this
                              charge.
                          taxCode:
                            type: string
                            description: >-
                              Tax code applied to the charge for taxation
                              purposes.
                          taxMode:
                            type: string
                            description: >-
                              Tax mode for this charge, for example, NonTaxable
                              or Taxable.
                          taxable:
                            type: boolean
                            description: Indicates whether the charge is taxable.
                          type:
                            type: string
                            description: >-
                              The charge type, for example, Recurring, OneTime,
                              or Usage.
                          updatedById:
                            type: string
                            description: ID of the user who last updated the charge.
                          updatedTime:
                            type: string
                            format: date-time
                            description: Timestamp when the charge was last updated.
                          createdById:
                            type: string
                            description: ID of the user who created the charge.
                          createdTime:
                            type: string
                            format: date-time
                            description: Timestamp when the charge was created.
    UpdateTierRequest:
      type: object
      description: Request body to update a Product Rate Plan Charge Tier.
      properties:
        id:
          type: string
          description: >
            **Product Rate Plan Charge Tier ID**
            (`productRatePlanChargeTierId`).  

            This is the unique identifier of the tier row under a Product Rate
            Plan Charge.  

            This identifier is **not surfaced by the new Commerce APIs** and is
            typically retrieved via **Zuora Data Query (DQ)** or by using the
            legacy v1 Object API equivalence:

            `/v1/object/product-rate-plan-charge-tier/{id}` <a
            href="https://developer.zuora.com/v1-api-reference/api/operation/Object_PUTProductRatePlanChargeTier/">CRUD:
            Update a product rate plan charge tier</a>
          example: 8fe232784e7946f9aa79cfc8aad30bd9
        price:
          type: number
          format: double
          description: Tier price to apply for the specified currency/quantity range.
          example: 450
      required:
        - id
        - price
    UpdateTierResponse:
      type: object
      description: Product Rate Plan Charge Tier record returned after a successful update.
      properties:
        id:
          type: string
          description: Product Rate Plan Charge Tier ID.
          example: 8fe232784e7946f9aa79cfc8aad30bd9
        currency:
          type: string
          description: ISO currency code for this tier.
          example: USD
        price:
          type: number
          format: double
          description: Price configured for this tier.
          example: 450
        startingUnit:
          type: number
          description: The inclusive starting unit for this tier’s range.
          example: 0
        endingUnit:
          type: number
          description: >-
            The inclusive ending unit for this tier’s range. `0` can represent
            open-ended depending on tenant configuration.
          example: 0
        tier:
          type: string
          description: Display order or label of the tier within the charge.
          example: '1'
        isOveragePrice:
          type: boolean
          description: Indicates whether this tier represents an overage price row.
          example: false
        priceFormat:
          type: string
          description: >-
            Price format applied to this tier (for example,
            `price_format_flat_fee`).
          example: price_format_flat_fee
        createdById:
          type: string
          description: ID of the user who created the tier.
          example: 190758cda21c41138233263a951580b3
        createdTime:
          type: string
          format: date-time
          description: Timestamp when the tier was created.
          example: '2025-10-15T19:07:25.000+00:00'
        updatedById:
          type: string
          description: ID of the user who last updated the tier.
          example: 190758cda21c41138233263a951580b3
        updatedTime:
          type: string
          format: date-time
          description: Timestamp when the tier was last updated.
          example: '2025-10-15T20:47:58.000+00:00'
      required:
        - id
        - currency
        - price
        - startingUnit
        - endingUnit
    PurchaseOptionRequest:
      type: object
      properties:
        filters:
          type: array
          description: >
            Defines the filtering criteria for querying purchase options or
            product rate plans.

            Each filter includes a target field, an operator, and a value.
          items:
            type: object
            required:
              - field
              - operator
              - value
            properties:
              field:
                type: string
                description: |
                  Name of the field to filter by.
                  Supported fields include:
                    - `prp_id`: Product Rate Plan ID.
                    - `product_id`: Product ID.
                example: prp_id
              operator:
                type: string
                description: |
                  Comparison operator. Supported values:
                  - `EQ`  (equals)
                  - `NE`  (not equals)
                  - `LT`  (less than)
                  - `GT`  (greater than)
                  - `SW`  (starts with)
                  - `EW`  (ends with)
                  - `IN`  (in list)
                  - `LIKE` (partial match)
                enum:
                  - EQ
                  - NE
                  - LT
                  - GT
                  - SW
                  - IN
                  - EW
                  - LIKE
                example: EQ
              value:
                type: object
                description: |
                  Specifies the value to compare against.
                  Only one of the following value types should be provided.
                properties:
                  string_value:
                    type: string
                    description: String value for string-based comparisons.
                    example: 8a90f5088799c8ed01879cb4b47a3b1a
                  number_value:
                    type: number
                    format: double
                    description: Numeric value for numeric comparisons.
                  boolean_value:
                    type: boolean
                    description: Boolean value for logical comparisons.
        expand:
          type: object
          description: |
            Optional flags to include related entities in the query results.
          properties:
            product_rate_plan_charges:
              type: boolean
              description: >
                When `true`, expands the response to include Product Rate Plan
                Charges (PRPCs)

                associated with the queried Product Rate Plans. Expanded PRPCs
                include full

                charge configuration, including pricing, billing settings, and
                end date

                configuration fields such as `endDateCondition`,
                `upToPeriodsType`, and `upToPeriods`.
              example: true
        product_rate_plan_charge_key:
          type: string
          description: >
            Optional identifier for a specific Product Rate Plan Charge (PRPC)
            to query.

            Can be either a PRPC ID or a PRPC number/key.
          example: ad95b694d2b8442b84dc8ad26561c7d7
        attributes:
          type: array
          description: >
            Optional attributes used for evaluating Dynamic Pricing.

            Required when the queried PRPC is configured to depend on contextual
            attributes.
          items:
            type: object
            required:
              - name
            properties:
              name:
                type: string
                description: >-
                  Name of the pricing attribute (e.g., `Region`, `Age`,
                  `EffectiveDate`).
                example: Region
              string_value:
                type: string
                description: String-based attribute value.
              number_value:
                type: number
                format: double
                description: Numeric attribute value.
              boolean_value:
                type: boolean
                description: Boolean attribute value.
              date_value:
                type: string
                format: date
                description: Date value in `YYYY-MM-DD` format.
              datetime_value:
                type: string
                format: date-time
                description: Datetime value in ISO 8601 format.
    PurchaseOptionResponse:
      type: object
      description: >
        Response object containing Product Rate Plan (PRP) and Product Rate Plan
        Charge (PRPC) details 

        that match the request filters. Each returned PRP includes all
        associated charge configurations,

        pricing details, and relevant metadata.
      properties:
        error:
          type: object
          nullable: true
          description: Error information, if the request fails. Returns `null` on success.
        productRatePlans:
          type: array
          description: >
            List of Product Rate Plans (PRPs) that match the filter criteria.

            Each PRP includes associated product, pricing, and charge
            configuration details.
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the Product Rate Plan (PRP).
                example: 8a90f5088799c8ed01879cb4b47a3b1a
              name:
                type: string
                description: Display name of the Product Rate Plan.
                example: New Rate Plan
              description:
                type: string
                description: Description of the Product Rate Plan.
              startDate:
                type: string
                format: date
                description: Effective start date of the Product Rate Plan.
              endDate:
                type: string
                format: date
                description: Effective end date of the Product Rate Plan.
              state:
                type: string
                description: >-
                  Current state of the Product Rate Plan (for example,
                  `active`).
                example: active
              productRatePlanNumber:
                type: string
                description: Unique reference number of the Product Rate Plan.
                example: PRP-00000001
              productId:
                type: string
                description: ID of the Product associated with this rate plan.
                example: 8a90f5088799c8ed01879cb481d83b18
              product:
                type: object
                description: Metadata and configuration details for the associated Product.
                properties:
                  id:
                    type: string
                    description: Unique Product ID.
                  name:
                    type: string
                    description: Product name.
                  productNumber:
                    type: string
                    description: Unique product reference number.
                  category:
                    type: string
                    description: Product category, such as `base` or `addon`.
                  sku:
                    type: string
                    description: Stock-keeping unit (SKU) identifier for the Product.
                  state:
                    type: string
                    description: >-
                      Current state of the Product (for example,
                      `product_active`).
                  customFields:
                    type: object
                    additionalProperties: true
                    description: Custom field values defined for the Product.
              productRatePlanCharges:
                type: array
                description: >
                  List of Product Rate Plan Charges (PRPCs) defined under this
                  rate plan.

                  Each charge defines pricing, billing, taxation, and accounting
                  details.
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: >-
                        Unique identifier of the Product Rate Plan Charge
                        (PRPC).
                      example: 8a90876c8799b81801879cb516f8400b
                    name:
                      type: string
                      description: Display name of the charge.
                      example: New Component
                    chargeType:
                      type: string
                      description: >-
                        Type of charge (for example, `recurring`, `usage`,
                        `one_time`).
                    chargeModel:
                      type: string
                      description: >-
                        Pricing model applied to the charge (for example,
                        `flat_fee`, `tiered`).
                    pricing:
                      type: object
                      description: >
                        Pricing configuration for the charge by currency.

                        Includes flat, unit, or tier-based amounts depending on
                        the model.
                      properties:
                        flatAmounts:
                          type: object
                          additionalProperties:
                            type: number
                          description: Flat amount per billing period by currency.
                          example:
                            USD: 100
                        minAmounts:
                          type: object
                          additionalProperties:
                            type: number
                          description: Minimum charge thresholds by currency.
                        maxAmounts:
                          type: object
                          additionalProperties:
                            type: number
                          description: Maximum charge thresholds by currency.
                        unitAmounts:
                          type: object
                          additionalProperties:
                            type: number
                          description: Per-unit charge amounts by currency.
                        tiers:
                          type: array
                          items:
                            type: object
                          description: >-
                            Tier-level pricing definitions for tiered or volume
                            models.
                    billCycle:
                      type: object
                      description: Billing configuration for this charge.
                      properties:
                        period:
                          type: string
                          description: Billing period, such as `month` or `year`.
                        periodAlignment:
                          type: string
                          description: >-
                            How the billing period aligns (for example,
                            `align_to_charge`).
                        timing:
                          type: string
                          description: >-
                            Whether the charge bills `in_advance` or
                            `in_arrears`.
                    taxMode:
                      type: string
                      description: >-
                        Whether tax is included (`tax_inclusive`) or excluded
                        (`tax_exclusive`).
                    taxable:
                      type: boolean
                      description: Indicates if the charge is taxable.
                    revenue:
                      type: object
                      description: Revenue recognition configuration for this charge.
                      properties:
                        revenueRecognitionRuleName:
                          type: string
                          description: >-
                            Name of the revenue recognition rule (for example,
                            “Recognize upon invoicing”).
                    accounting:
                      $ref: '#/components/schemas/AccountingResponse'
                    customFields:
                      type: object
                      additionalProperties: true
                      description: Tenant-specific custom fields for the PRPC.
                    pricingSummary:
                      type: array
                      description: Human-readable price summary for quick display.
                      items:
                        type: string
                        example: USD100
                    triggerEvent:
                      type: string
                      description: >-
                        Event that triggers the charge (for example,
                        `contract_effective`).
                    endDateCondition:
                      type: string
                      description: >
                        Condition that determines when the charge ends, for
                        example `subscription_end`,

                        `fixed_period`, or `specific_end_date`.
                    upToPeriodsType:
                      type: string
                      description: >
                        Unit of time used when `endDateCondition` is
                        duration-based (for example, `billing_periods`).
                    upToPeriods:
                      type: integer
                      description: >
                        Duration value used together with `upToPeriodsType` when
                        `endDateCondition` is `fixed_period`.
                    listPriceBase:
                      type: string
                      description: Indicates how list price is interpreted.
                      example: Per_Billing_Period
                    specificListPriceBase:
                      type: number
                      description: >
                        Optional override for list price base when billing uses
                        a specific period configuration.
                      example: 0
                    updatedTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was last updated.
                    createdTime:
                      type: string
                      format: date-time
                      description: Timestamp when the charge was created.
      example:
        error: null
        productRatePlans:
          - id: 8a90f5088799c8ed01879cb4b47a3b1a
            name: New Rate Plan
            state: active
            productId: 8a90f5088799c8ed01879cb481d83b18
            productRatePlanCharges:
              - id: 8a90876c8799b81801879cb516f8400b
                name: New Component
                chargeType: recurring
                chargeModel: flat_fee
                pricing:
                  flatAmounts:
                    USD: 100
                pricingSummary:
                  - USD100
                taxMode: tax_exclusive
                taxable: true
                triggerEvent: contract_effective
                endDateCondition: subscription_end
                upToPeriodsType: billing_periods
                upToPeriods: 0
                createdTime: '2023-04-19T20:28:46.000+00:00'
                updatedTime: '2023-04-19T20:28:46.000+00:00'
    ContactObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Contact object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Contact object.
      title: contactFieldsCustom
      type: object
    POSTAccountTypeBillToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            city:
              description: |
                City
              type: string
              maxLength: 100
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the sold-to contact to
                calculate tax. A bill-to contact may be used if no sold-to
                contact is provided.
              type: string
            county:
              description: |
                May optionally be used by Zuora Tax to calculate county tax.
              type: string
              maxLength: 100
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              format: email
              maxLength: 80
            state:
              description: >
                State must be a valid subregion (state or province) name or
                code. For more information, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                target="_blank">View subregions of a specific country or
                region</a>. If using Zuora Tax, be aware that Zuora tax requires
                a state (in the US) or province (in Canada) in this field for
                the sold-to contact to calculate tax, and that a bill-to contact
                may be used if no sold-to contact is provided.
              type: string
              maxLength: 100
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              type: string
              maxLength: 100
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: >
        Container for bill-to contact information for this account. If you do
        not provide a sold-to contact, the bill-to contact is copied to sold-to
        contact. Once the sold-to contact is created, changes to billToContact
        will not affect soldToContact and vice versa.
      title: Contact
    PaymentMethodObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the payment method. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a payment method object.
      title: paymentMethodFieldsCustom
      type: object
    POSTAccountTypeCreditCard:
      allOf:
        - properties:
            cardHolderInfo:
              description: |
                Container for cardholder information.
              properties:
                addressLine1:
                  description: |
                    First address line, 255 characters or less.
                  type: string
                addressLine2:
                  description: |
                    Second address line, 255 characters or less.
                  type: string
                cardHolderName:
                  description: >
                    The card holder's full name as it appears on the card, e.g.,
                    "John J Smith", 50 characters or less.
                  type: string
                city:
                  description: >
                    City, 40 characters or less.

                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: >
                    Country; must be a valid country name or abbreviation.

                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                email:
                  description: |
                    Card holder's email address, 80 characters or less.
                  type: string
                phone:
                  description: |
                    Phone number, 40 characters or less.
                  type: string
                state:
                  description: >
                    State; must be a valid subregion (state or province) name or
                    code. For more information, see <a
                    href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                    target="_blank">View subregions of a specific country or
                    region</a>.
                  type: string
                zipCode:
                  description: |
                    Zip code, 20 characters or less.
                  type: string
              required:
                - addressLine1
                - cardHolderName
                - city
                - country
                - state
                - zipCode
            cardNumber:
              description: >
                Card number, up to 16 characters. Once created, this field can't
                be updated or queried, and is only available in masked format
                (e.g., XXXX-XXXX-XXXX-1234).
              type: string
            cardType:
              description: >
                The type of the credit card.


                Possible values  include `Visa`, `MasterCard`,
                `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more
                information about credit card types supported by different
                payment gateways, see [Supported Payment
                Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
              type: string
            expirationMonth:
              description: |
                Two-digit expiration month (01-12).
              type: string
            expirationYear:
              description: |
                Four-digit expiration year.
              type: string
            securityCode:
              description: >
                The CVV or CVV2 security code of the card. To ensure PCI
                compliance, this value is not stored and cannot be queried.
              type: string
          required:
            - cardHolderInfo
            - cardNumber
            - cardType
            - expirationMonth
            - expirationYear
          type: object
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      description: >
        **Note:** This field has been deprecated, and is currently available
        only for backward compatibility. Use the `paymentMethod` field instead
        to create a payment method associated with this account.


        Container for information on a credit card to associate with this
        account. 

        If the `autoPay` field is set to `true`, you must provide one of the
        `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId` field,
        but not multiple.
      title: creditCard
    EinvoiceObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the eInvoiceProfile object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://knowledgecenter.zuora.com/Zuora_Platform/Extensibility/Custom_Fields/Manage_custom_fields_with_the_Object_Manager"
          target="_blank">Manage custom fields</a> for more information.
      description: |
        Container for custom fields of an EinvoiceProfile object.
      title: eInvoiceProfileCustomFields
      type: object
    PostAccountEInvoiceProfile:
      allOf:
        - properties:
            businessCategory:
              description: |
                The high-level category of the business.
              type: string
              enum:
                - B2B
                - B2C
                - B2G
            businessName:
              description: >
                The full official name that the Buyer is registered with the
                relevant legal authority.
              maxLength: 255
              type: string
            businessNumber:
              description: >
                The unique identifier number of the legal entity or person that
                you do business with.


                For example, you must use a GSTIN for India.
              type: string
            businessNumberSchemeId:
              description: >
                The identification scheme identifier that an official registrar
                issues to identify the Buyer as a legal entity or person.
              type: string
            enabled:
              description: >
                Whether to enable the e-invoicing profile for the customer
                account.


                If the following conditions are met, all billing documents for
                one account can be submitted to an e-invoicing service provider
                to be generated in electronic format:

                - The account must be configured to generate e-invoice files for
                billing documents.

                - The billing document must be in Posted status.

                - A business region must be created for the billing country
                contact, and be linked to an e-invoicing service provider.
              type: boolean
            endpointId:
              description: >
                The Buyer's electronic address, to which the application-level
                response to the billing document might be delivered.
              type: string
            endpointSchemeId:
              description: >
                The identification scheme identifier of the Buyer’s electronic
                address.
              type: string
            taxRegisterNumber:
              description: >
                The Buyer's VAT identifier (also known as the Buyer's VAT
                identification number) or the local identification (defined by
                the Buyer’s address) of the Buyer for tax purposes, or a
                reference that enables the Buyer to state the registered tax
                status.
              type: string
          type: object
        - $ref: '#/components/schemas/EinvoiceObjectCustomFields'
      description: >
        Container for e-invoicing profile information for this account.


        **Note**: This field is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      title: einvoiceProfile
    CreatePaymentMethodCardholderInfo:
      description: "Container for cardholder information. The nested\_`cardHolderName`\_field is required.\n"
      properties:
        addressLine1:
          description: |
            First address line, 255 characters or less.
          type: string
        addressLine2:
          description: |
            Second address line, 255 characters or less.
          type: string
        cardHolderName:
          description: >-
            The card holder's full name as it appears on the card, e.g., "John J
            Smith", 50 characters or less. The value must consist only of
            US-ASCII  characters and must not include special characters.
          type: string
        city:
          description: >
            City, 40 characters or less.

            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          type: string
        country:
          description: >
            Country, must be a valid country name or abbreviation.

            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          type: string
        email:
          description: |
            Card holder's email address, 80 characters or less.
          type: string
        phone:
          description: |
            Phone number, 40 characters or less.
          type: string
        state:
          description: >
            State; must be a valid subregion (state or province) name or code.
            For more information, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
            target="_blank">View subregions of a specific country or region</a>.
          type: string
        zipCode:
          description: |
            Zip code, 20 characters or less.
          type: string
      required:
        - cardHolderName
      title: cardHolderInfo
      type: object
      example:
        cardHolderName: Amy Lawrence
        addressLine1: 101 Redwood Shores Parkway
        city: Redwood City
        state: CA
        zipCode: 94065
        country: USA
        phone: (888) 976-9056
    PaymentMethodCommonFields:
      properties:
        accountKey:
          description: >
            The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6`
            or the customer account number such as `A02855638`. 


            To create an orphan payment method that is not associated with any
            customer account, you can skip this field.  As soon as the account
            information is available, associate the payment method with an
            account through the [Update a payment
            method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) 
            operation.
          type: string
        authGateway:
          description: >
            Internal ID of the payment gateway that Zuora will use to authorize
            the payments that are made with the payment method.


            If you do not set this field, Zuora will use one of the following
            payment gateways instead:


            * The default payment gateway of the customer account that owns the
            payment method, if the `accountKey` field is set.

            * The default payment gateway of your Zuora tenant, if the
            `accountKey` field is not set.


            If <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
            target="_blank">Payment Gateway Routing</a> is enabled: 
              - If this field is not specified, gateway routing rules will be invoked.
              - If this field is specified, the specified gateway will be used to process the payment.

            If Payment Gateway Routing is disabled:
              - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. 
              - If this field is specified, the specified gateway will be used to process the payment.
          type: string
        currencyCode:
          description: |
            The currency used for payment method authorization.
          type: string
          example: USD
        gatewayOptions:
          description: >
            The field used to pass gateway-specific parameters and parameter
            values. The fields supported by gateways vary. For more information,
            see the Overview topic of each gateway integration in [Zuora
            Knowledge
            Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


            Zuora sends all the information that you specified to the gateway.
            If you specify any unsupported gateway option parameters, they will
            be ignored without error prompts.
          properties:
            key:
              description: |
                The name of a gateway-specific parameter.
              type: string
            value:
              description: |
                The value of the gateway-specific parameter.
              type: string
          type: object
          example:
            shopperInteraction: POS
            shopperEmail: testemail@test.com
        ipAddress:
          description: >
            The IPv4 or IPv6 information of the user when the payment method is
            created or updated. Some gateways use this field for fraud
            prevention. If this field is passed to Zuora, Zuora directly passes
            it to gateways. 


            If the IP address length is beyond 45 characters, a validation error
            occurs.


            For validating SEPA payment methods on Stripe v2, this field is
            required.
          type: string
        makeDefault:
          default: false
          description: >
            Specifies whether the payment method will be the default payment
            method of the customer account that owns the payment method. Only
            applicable if the `accountKey` field is set.


            When you set this field to `true`, make sure the payment method is
            supported by the default payment gateway.
          type: boolean
        skipValidation:
          default: false
          description: >
            Specify whether to skip the validation of the information through
            the payment gateway. For example, when migrating your payment
            methods, you can set this field to `true` to skip the validation. 
          type: boolean
        type:
          description: >
            Type of the payment method. The following types of the payment
            methods are supported:

              * `CreditCard`

              * `CreditCardReferenceTransaction`

              * `ACH`

              * `SEPA`

              * `Betalingsservice`

              * `Autogiro`

              * `Bacs`

              * `Becs`

              * `Becsnz`

              * `PAD`

              * `PayPalCP`

              * `PayPalEC`

              * `PayPalNativeEC`

              * `PayPalAdaptive`

              * `AdyenApplePay`

              * `AdyenGooglePay`

              * `GooglePay`

              * `AmazonPay`


            To view the schema and example applicable to a specific payment
            method type, select the corresponding option from the following
            list.
          type: string
          enum:
            - CreditCard
            - CreditCardReferenceTransaction
            - ACH
            - SEPA
            - Betalingsservice
            - Autogiro
            - Bacs
            - Becs
            - Becsnz
            - PAD
            - PayPalCP
            - PayPalEC
            - PayPalNativeEC
            - PayPalAdaptive
            - AdyenApplePay
            - AdyenGooglePay
            - GooglePay
            - AmazonPay
      type: object
    CreatePaymentMethodCreditCard:
      allOf:
        - type: object
          properties:
            type:
              type: string
            cardHolderInfo:
              $ref: '#/components/schemas/CreatePaymentMethodCardholderInfo'
            cardMaskNumber:
              description: >
                The masked card number.


                Currently, this field is only supported on certain integrations.
                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              type: string
            cardNumber:
              description: |
                Credit card number.
              type: string
            cardType:
              description: >
                The type of the credit card.

                Possible values include `Visa`, `MasterCard`, `AmericanExpress`,
                `Discover`, `JCB`, and `Diners`. For more information about
                credit card types supported by different payment gateways, see
                <a
                href="https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways"
                target="_blank">Supported Payment Gateways</a>.
              type: string
            checkDuplicated:
              description: >
                Indicates whether the duplication check is performed when you
                create a new credit card payment method. The default value is
                `false`.


                With this field set to `true`, Zuora will check all active
                payment methods associated with the same billing account to
                ensure that no duplicate credit card payment methods are
                created. An error is returned if a duplicate payment method is
                found.
                        
                The following fields are used for the duplication check:
                  - `cardHolderName`
                  - `expirationMonth`
                  - `expirationYear`
                  - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example, `************1234`.

                **This field is being deprecated.**  To achieve the same
                purpose, use the `processingOptions` > `checkDuplicated` field
                of the payment method object.
              type: boolean
            expirationMonth:
              description: |
                One or two digit expiration month (1-12) of the credit card.
              type: integer
            expirationYear:
              description: |
                Four-digit expiration year of the credit card.
              type: integer
            identityNumber:
              description: >
                The identity number of the cardholder. This field is required
                for Credit Card payment methods in certain countries such as
                Brazil.
              type: string
            mitConsentAgreementRef:
              description: >
                Specifies your reference for the stored credential consent
                agreement that you have established with the customer. Only
                applicable if you set the `mitProfileAction` field.
              maxLength: 128
              type: string
            mitConsentAgreementSrc:
              description: >
                Required if you set the `mitProfileAction` field. Specifies how
                the consent agreement has been established with the customer.
                The allowed value is `External`. If you do not specify the
                `mitProfileAction` field, Zuora will automatically create a
                stored credential profile for the payment method, with the
                default value `External` set to this field.
              enum:
                - External
              type: string
            mitNetworkTransactionId:
              description: >
                Specifies the ID of a network transaction. Only applicable if
                you set the `mitProfileAction` field to `Persist`.
              maxLength: 128
              type: string
            mitProfileAction:
              description: >
                Specifies how Zuora creates and activates the stored credential
                profile.


                - `Activate` - Use this value if you are creating the stored
                credential profile after receiving the customer's consent.

                  Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.
                  
                  If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.


                - `Persist` - Use this value if the stored credential profile
                represents a stored credential profile in an external system.
                The status of the payment method's stored credential profile
                will be `Active`.


                If you do not specify this field, Zuora will automatically
                create a stored credential profile for the payment method, with
                the default value `Activate` set to this field.
              enum:
                - Activate
                - Persist
              type: string
            mitProfileAgreedOn:
              description: >
                The date on which the profile is agreed. The date format is
                `yyyy-mm-dd`.
              format: date
              type: string
            mitProfileType:
              description: >
                Required if you set the `mitProfileAction` field. Indicates the
                type of the stored credential profile to process recurring or
                unsecheduled transactions. If you do not specify the
                `mitProfileAction` field, Zuora will automatically create a
                stored credential profile for the payment method, with the
                default value `Recurring` set to this field.
              enum:
                - Recurring
                - Unscheduled
              type: string
            screeningAmount:
              description: >
                For <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Chase_Orbital_Payment_Gateway"
                target="_blank">Chase Paymentech Orbital Gateway</a>
                integrations, if the Safetech Fraud service is enabled, use this
                field to pass in the amount used for fraud screening for Credit
                Card validation transactions.


                Two-decimal amount is supported.


                If the `screeningAmount` field is not specified, the
                authorization amount is used for fraud screening.
              format: decimal
              type: number
            securityCode:
              description: >
                CVV or CVV2 security code of the credit card.


                To ensure PCI compliance, this value is not stored and cannot be
                queried.
              type: string
            tokens:
              description: >
                To create tokenized payment methods, pass in the existing token
                information through the fields in this container.


                Currently, this field is only supported on certain integrations.
                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              properties:
                gatewayType:
                  description: >
                    The type of the payment gateway to generate the tokens. This
                    field is

                    case-sensitive.
                  type: string
                secondTokenId:
                  description: |
                    Pass in the second token of the payment method.
                  type: string
                thirdTokenId:
                  description: |
                    Pass in the third token of the payment method.
                  type: string
                tokenId:
                  description: |
                    Pass in the first token of the payment method.
                  type: string
              required:
                - gatewayType
                - tokenId
              type: object
            tokenize:
              default: false
              description: >
                Specify `true` to tokenize the payment method with the card
                information.


                Currently, this field is only supported on certain
                integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              type: boolean
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              type: object
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - cardHolderInfo
        - cardNumber
        - cardType
        - expirationMonth
        - expirationYear
      example:
        accountKey: 8ad09be48db5aba7018db604776d4854
        type: CreditCard
        cardType: Visa
        cardNumber: '4111111111111111'
        expirationMonth: 12
        expirationYear: 2028
        cardHolderInfo:
          cardHolderName: Amy Lawrence
    CreatePaymentMethodCCReferenceTransaction:
      allOf:
        - type: object
          properties:
            type:
              type: string
            creditCardMaskNumber:
              description: >
                The masked credit card number, such as `*********1112`.

                This field is specific for the CC Reference Transaction payment
                method. It is an optional field that you can use to distinguish
                different CC Reference Transaction payment methods.

                Though there are no special restrictions on the input string, it
                is highly recommended to specify a card number that is masked.
              maxLength: 19
              type: string
            secondTokenId:
              description: >
                A gateway unique identifier that replaces sensitive payment
                method data. 


                `secondTokenId` is conditionally required only when `tokenId` is
                being used to represent a gateway customer profile.
                `secondTokenId` is used in the CC Reference Transaction payment
                method.
              type: string
            tokenId:
              description: >
                A gateway unique identifier that replaces sensitive payment
                method data or represents a gateway's unique customer profile.


                When `tokenId` is used to represent a customer profile,
                `secondTokenId` is conditionally required for representing the
                underlying tokenized payment method.


                The values for the `tokenId` and `secondTokenId` fields differ
                for gateways. For more information, see the Knowledge Center
                article specific to each gateway that supports the CC Reference
                Transaction payment method.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      type: object
      required:
        - type
        - tokenId
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        tokenId: A9xCTM0A3D7g0OOiYnwxJMjkZ6Nn8yMDusVbnhvH
        secondTokenId: B4D339HPV3KHQQ65
        creditCardMaskNumber: '************1111'
        type: CreditCardReferenceTransaction
    CreatePaymentMethodACH:
      allOf:
        - properties:
            type:
              type: string
            addressLine1:
              description: |
                First address line, 255 characters or less.
              type: string
            addressLine2:
              description: |
                Second address line, 255 characters or less.
              type: string
            bankABACode:
              description: >
                The nine-digit routing number or ABA number used by banks. This
                field is

                only required if the `type` field is set to `ACH`.
              type: string
            bankAccountMaskNumber:
              description: >
                The masked account number such as ****1234.


                Currently, this field is only supported on certain
                integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              type: string
            bankAccountName:
              description: >
                The name of the account holder, which can be either a person or
                a company.



                For ACH payment methods on the BlueSnap integration, see
                [Overview of

                BlueSnap gateway

                integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction)

                for more information about how Zuora splits the string in this
                field into

                two parts and passes them to BlueSnap's `firstName` and
                `lastName` fields.
              maxLength: 70
              type: string
            bankAccountNumber:
              description: >
                The bank account number associated with the ACH payment.


                For the creation of tokenized ACH payment methods, this field is
                optional. Currently, ACH tokenization is supported on selected
                payment gateway integrations.  

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              maxLength: 30
              type: string
            bankAccountType:
              description: >
                The type of bank account associated with the ACH payment.



                When creating an ACH payment method on Adyen, this field is
                required by

                Zuora but it is not required by Adyen. To create the ACH payment
                method

                successfully, specify a real value for this field if you can. If
                it is not

                possible to get the real value for it, specify any of the
                allowed values

                as a dummy value, `Checking` preferably.
              enum:
                - BusinessChecking
                - Checking
                - Saving
              type: string
            bankName:
              description: >
                The name of the bank where the ACH payment account is held.



                When creating an ACH payment method on Adyen, this field is
                required by

                Zuora but it is not required by Adyen. To create the ACH payment
                method

                successfully, specify a real value for this field if you can. If
                it is not

                possible to get the real value for it, specify a dummy value.
              maxLength: 70
              type: string
            city:
              description: >
                City, 40 characters or less.



                It is recommended to provide the city and country information
                when

                creating a payment method. The information will be used to
                process

                payments. If the information is not provided during payment
                method

                creation, the city and country data will be missing during
                payment

                processing.
                    
              type: string
            country:
              description: >
                Country, must be a valid country name or abbreviation.



                See <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"

                target="_blank">View countries or regions</a>

                for the list of supported country names and abbreviations.



                It is recommended to provide the city and country information
                when

                creating a payment method. The information will be used to
                process

                payments. If the information is not provided during payment
                method

                creation, the city and country data will be missing during
                payment

                processing.
              type: string
            phone:
              description: |
                Phone number, 40 characters or less.
              type: string
            state:
              description: >
                State, must be a valid subregion (state or province) name or
                code. For more information, see <a

                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"

                target="_blank">View subregions of a specific country or
                region</a>.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
            tokens:
              description: >
                To create tokenized payment methods, pass in the existing token
                information through the fields in this container.



                Currently, this field is only supported on certain
                integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              properties:
                gatewayType:
                  description: >
                    The type of the payment gateway to generate the tokens. This
                    field is

                    case-sensitive.
                  type: string
                secondTokenId:
                  description: |
                    Pass in the second token of the payment method.
                  type: string
                thirdTokenId:
                  description: |
                    Pass in the third token of the payment method.
                  type: string
                tokenId:
                  description: |
                    Pass in the first token of the payment method.
                  type: string
              type: object
              required:
                - gatewayType
                - tokenId
            tokenize:
              default: false
              description: >
                Specify `true` to tokenize the payment method with the account
                information.


                Currently, this field is only supported on certain
                integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              type: boolean
          type: object
          title: AchPaymentMethod
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - bankABACode
        - bankAccountName
        - bankAccountNumber
        - bankAccountType
        - bankName
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        bankABACode: '999999999'
        bankAccountName: TestName
        bankAccountNumber: '999999999'
        bankAccountType: Checking
        bankName: TestBank
        addressLine1: Test Address line1
        addressLine2: Test Address line2
        phone: '1234567890'
        city: testCity
        country: USA
        state: Alaska
        zipCode: '123456'
        processingOptions:
          checkDuplicated: true
        type: ACH
    CreatePaymentMethodSEPA:
      allOf:
        - properties:
            type:
              type: string
            IBAN:
              description: >
                The International Bank Account Number. 


                This field is required if the `type` field is set to `SEPA`. 

                However, for the creation of tokenized SEPA payment methods,
                this field is optional. 

                Currently, SEPA tokenization is supported on selected payment
                gateway integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              type: string
            accountHolderInfo:
              description: >
                The container for the account holder information. The nested
                `accountHolderName` field is required. 

                However, for the creation of tokenized SEPA payment methods,
                this field is optional. 

                Currently, SEPA tokenization is supported on selected payment
                gateway integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              properties:
                accountHolderName:
                  description: |
                    The full name of the bank account holder.
                  maxLength: 60
                  type: string
                addressLine1:
                  description: >
                    The first line of the address for the account holder.


                    This field is required for SEPA Direct Debit payment methods
                    on Stripe v2 for [certain
                    countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
                  type: string
                addressLine2:
                  description: |
                    The second line of the address for the account holder. 
                  type: string
                city:
                  description: >
                    The city where the account holder stays.


                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: >
                    The country where the account holder stays.


                    This field is required for SEPA payment methods on Stripe v2
                    for [certain
                    countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
                  type: string
                email:
                  description: |
                    The email address of the account holder.
                  type: string
                firstName:
                  description: |
                    The first name of the account holder.
                  type: string
                lastName:
                  description: |
                    The last name of the account holder.
                  type: string
                phone:
                  description: |
                    The phone number of the account holder.
                  type: string
                state:
                  description: |
                    The state where the account holder stays.
                  type: string
                zipCode:
                  description: |
                    The zip code for the address of the account holder.
                  type: string
              type: object
              required:
                - accountHolderName
            accountMaskNumber:
              description: >
                The masked account number such as ****1234.


                When creating tokenized SEPA payment methods, this
                `accountMaskNumber` field is required if the `tokens` field is
                provided. 

                Currently, SEPA tokenization is supported on selected payment
                gateway integrations.

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              type: string
            businessIdentificationCode:
              description: |
                The BIC code used for SEPA.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            tokenize:
              default: false
              description: >
                When creating a SEPA payment method on Adyen Integration v2.0,
                use this

                field to specify whether to tokenize the payment method with
                IBAN. If

                `tokenize` is `true`, `IBAN` is required. If the `tokens` field
                is provided, this `tokenize` field is not required. For more
                information about how to create tokenized SEPA payment methods
                on

                Adyen, see <a

                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/D_Tokenize_SEPA_payment_methods_on_Adyen_Integration_v2.0"

                target="_blank">Tokenize SEPA payment methods on Adyen
                Integration

                v2.0</a>.
              type: boolean
            tokens:
              description: >
                To create tokenized payment methods, pass in the existing token
                information through the fields in this container.


                Currently, SEPA tokenization is supported on selected payment
                gateway integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              properties:
                gatewayType:
                  description: >
                    The type of the payment gateway to generate the tokens. This
                    field is

                    case-sensitive.
                  enum:
                    - Adyen
                    - Stripe
                  type: string
                secondTokenId:
                  description: |
                    Pass in the second token of the payment method.
                  type: string
                thirdTokenId:
                  description: |
                    Pass in the third token of the payment method.
                  type: string
                tokenId:
                  description: |
                    Pass in the first token of the payment method.
                  type: string
              type: object
              required:
                - gatewayType
                - tokenId
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - IBAN
        - accountHolderInfo
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        IBAN: FR1420041010050500013M02606
        accountHolderInfo:
          accountHolderName: TestName
        processingOptions:
          checkDuplicated: true
        type: SEPA
    CreatePaymentMethodBetalingsservice:
      allOf:
        - properties:
            type:
              type: string
            accountHolderInfo:
              description: >
                The container for the account holder information. The nested
                `accountHolderName` field is required.
              properties:
                accountHolderName:
                  description: |
                    Required.

                    The full name of the bank account holder.
                  maxLength: 60
                  type: string
                addressLine1:
                  description: |
                    The first line of the address for the account holder.
                  type: string
                addressLine2:
                  description: |
                    The second line of the address for the account holder. 
                  type: string
                city:
                  description: >
                    The city where the account holder stays.


                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: |
                    The country where the account holder stays.
                  type: string
                email:
                  description: |
                    The email address of the account holder.
                  type: string
                firstName:
                  description: |
                    The first name of the account holder.
                  type: string
                lastName:
                  description: |
                    The last name of the account holder.
                  type: string
                phone:
                  description: |
                    The phone number of the account holder.
                  type: string
                state:
                  description: |
                    The state where the account holder stays.
                  type: string
                zipCode:
                  description: |
                    The zip code for the address of the account holder.
                  type: string
              type: object
            accountNumber:
              description: |
                The number of the customer's bank account.
              type: string
            accountMaskNumber:
              description: |
                The masked account number such as ****1234.
              type: string
            bankCode:
              description: >
                The sort code or number that identifies the bank. This is also
                known as the sort code.
              type: string
            identityNumber:
              description: |
                The identity number used for Bank Transfer.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - accountNumber
        - identityNumber
        - bankCode
        - accountHolderInfo
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        accountNumber: '3179681'
        identityNumber: '0101701234'
        bankCode: '345'
        accountHolderInfo:
          accountHolderName: TestName
        processingOptions:
          checkDuplicated: true
        type: Betalingsservice
    CreatePaymentMethodAutogiro:
      allOf:
        - properties:
            type:
              type: string
            accountHolderInfo:
              description: >
                The container for the account holder information. The nested
                `accountHolderName` field is required.
              properties:
                accountHolderName:
                  description: |
                    Required.

                    The full name of the bank account holder.
                  maxLength: 60
                  type: string
                addressLine1:
                  description: |
                    The first line of the address for the account holder.
                  type: string
                addressLine2:
                  description: |
                    The second line of the address for the account holder. 
                  type: string
                city:
                  description: >
                    The city where the account holder stays.


                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: |
                    The country where the account holder stays.
                  type: string
                email:
                  description: |
                    The email address of the account holder.
                  type: string
                firstName:
                  description: |
                    The first name of the account holder.
                  type: string
                lastName:
                  description: |
                    The last name of the account holder.
                  type: string
                phone:
                  description: |
                    The phone number of the account holder.
                  type: string
                state:
                  description: |
                    The state where the account holder stays.
                  type: string
                zipCode:
                  description: |
                    The zip code for the address of the account holder.
                  type: string
              type: object
            accountNumber:
              description: |
                The number of the customer's bank account.
              type: string
            accountMaskNumber:
              description: |
                The masked account number such as ****1234.
              type: string
            branchCode:
              description: |
                The branch code of the bank used for direct debit.
              type: string
            identityNumber:
              description: |
                The identity number used for Bank Transfer.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
          type: object
          title: AutogiroPaymentMethod
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - accountNumber
        - identityNumber
        - branchCode
        - accountHolderInfo
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        accountNumber: '0000003'
        identityNumber: '198112289874'
        branchCode: '5491'
        accountHolderInfo:
          accountHolderName: TestName
        processingOptions:
          checkDuplicated: true
        type: Autogiro
    CreatePaymentMethodBacs:
      allOf:
        - properties:
            type:
              type: string
            accountHolderInfo:
              description: >
                The container for the account holder information. The nested
                `accountHolderName` field is required.
              properties:
                accountHolderName:
                  description: |
                    Required.

                    The full name of the bank account holder.
                  maxLength: 60
                  type: string
                addressLine1:
                  description: |
                    The first line of the address for the account holder.
                  type: string
                addressLine2:
                  description: |
                    The second line of the address for the account holder. 
                  type: string
                city:
                  description: >
                    The city where the account holder stays.


                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: |
                    The country where the account holder stays.
                  type: string
                email:
                  description: |
                    The email address of the account holder.
                  type: string
                firstName:
                  description: |
                    The first name of the account holder.
                  type: string
                lastName:
                  description: |
                    The last name of the account holder.
                  type: string
                phone:
                  description: |
                    The phone number of the account holder.
                  type: string
                state:
                  description: |
                    The state where the account holder stays.
                  type: string
                zipCode:
                  description: |
                    The zip code for the address of the account holder.
                  type: string
              type: object
            accountNumber:
              description: |
                The number of the customer's bank account.
              type: string
            accountMaskNumber:
              description: >
                The masked account number such as ****1234.

                When creating BACS payment methods on Stripe, if the `tokens`
                field is provided, this `accountMaskNumber` field is required.
                For more information, see  <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration"
                target="_blank">Overview of Stripe payment gateway
                integration</a>.
              type: string
            bankCode:
              description: >
                The sort code or number that identifies the bank. This is also
                known as the sort code.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            tokenize:
              default: false
              description: >
                When creating a BACS payment method on Adyen v2.0, set this
                field to `true` to support processing BACS recurring payments.
                For more information about other requirements for processing
                BACS recurring payments, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Adyen_Integration_v2.0/A_Overview_of_Adyen_Integration_v2.0#Direct_Debit_UK_(BACS)"
                target="_blank">Overview of Adyen Integration v2.0</a>.
              type: boolean
            tokens:
              description: >
                To create tokenized BACS payment methods on Stripe v2, pass in
                the existing token information through the fields in this
                container.

                For more information, see  <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration"
                target="_blank">Overview of Stripe payment gateway
                integration</a>.
              properties:
                gatewayType:
                  description: >
                    Required. 


                    The type of the payment gateway to generate the tokens. This
                    field is case-sensitive.
                  enum:
                    - Stripe
                  type: string
                secondTokenId:
                  description: >
                    Pass in the second token of the payment method. For more
                    information, see  <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration"
                    target="_blank">Overview of Stripe payment gateway
                    integration</a>.
                  type: string
                thirdTokenId:
                  description: |
                    Pass in the third token of the payment method.
                  type: string
                tokenId:
                  description: >
                    Required. 


                    Pass in the first token of the payment method. For more
                    information, see  <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration"
                    target="_blank">Overview of Stripe payment gateway
                    integration</a>.
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
          type: object
          title: BacsPaymentMethod
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - accountNumber
        - bankCode
        - accountHolderInfo
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        accountNumber: '55779911'
        bankCode: '200000'
        accountHolderInfo:
          accountHolderName: TestName
        processingOptions:
          checkDuplicated: true
        type: Bacs
    CreatePaymentMethodBecs:
      allOf:
        - properties:
            type:
              type: string
            accountHolderInfo:
              description: >
                The container for the account holder information. The nested
                `accountHolderName` field is required.
              properties:
                accountHolderName:
                  description: |
                    Required.

                    The full name of the bank account holder.
                  maxLength: 60
                  type: string
                addressLine1:
                  description: |
                    The first line of the address for the account holder.
                  type: string
                addressLine2:
                  description: |
                    The second line of the address for the account holder. 
                  type: string
                city:
                  description: >
                    The city where the account holder stays.


                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: |
                    The country where the account holder stays.
                  type: string
                email:
                  description: |
                    The email address of the account holder.
                  type: string
                firstName:
                  description: |
                    The first name of the account holder.
                  type: string
                lastName:
                  description: |
                    The last name of the account holder.
                  type: string
                phone:
                  description: |
                    The phone number of the account holder.
                  type: string
                state:
                  description: |
                    The state where the account holder stays.
                  type: string
                zipCode:
                  description: |
                    The zip code for the address of the account holder.
                  type: string
              type: object
            accountNumber:
              description: |
                The number of the customer's bank account.
              type: string
            accountMaskNumber:
              description: |
                The masked account number such as ****1234.
              type: string
            branchCode:
              description: |
                The branch code of the bank used for direct debit.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - accountNumber
        - branchCode
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        accountNumber: '012345678'
        branchCode: 082-082
        accountHolderInfo:
          accountHolderName: TestName
        processingOptions:
          checkDuplicated: true
        type: Becs
    CreatePaymentMethodBecsnz:
      allOf:
        - properties:
            type:
              type: string
            accountHolderInfo:
              description: >
                The container for the account holder information. The nested
                `accountHolderName` field is required.
              properties:
                accountHolderName:
                  description: |
                    Required.

                    The full name of the bank account holder.
                  maxLength: 60
                  type: string
                addressLine1:
                  description: |
                    The first line of the address for the account holder.
                  type: string
                addressLine2:
                  description: |
                    The second line of the address for the account holder. 
                  type: string
                city:
                  description: >
                    The city where the account holder stays.


                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: |
                    The country where the account holder stays.
                  type: string
                email:
                  description: |
                    The email address of the account holder.
                  type: string
                firstName:
                  description: |
                    The first name of the account holder.
                  type: string
                lastName:
                  description: |
                    The last name of the account holder.
                  type: string
                phone:
                  description: |
                    The phone number of the account holder.
                  type: string
                state:
                  description: |
                    The state where the account holder stays.
                  type: string
                zipCode:
                  description: |
                    The zip code for the address of the account holder.
                  type: string
              type: object
            accountNumber:
              description: |
                The number of the customer's bank account.
              type: string
            accountMaskNumber:
              description: |
                The masked account number such as ****1234.
              type: string
            branchCode:
              description: |
                The branch code of the bank used for direct debit.
              type: string
            bankCode:
              description: >
                The sort code or number that identifies the bank. This is also
                known as the sort code.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - accountNumber
        - bankCode
        - branchCode
        - accountHolderInfo
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        accountNumber: 0003869-00
        accountHolderInfo:
          accountHolderName: TestName
        branchCode: '3113'
        bankCode: '12'
        processingOptions:
          checkDuplicated: true
        type: Becsnz
    CreatePaymentMethodPAD:
      allOf:
        - properties:
            type:
              type: string
            accountHolderInfo:
              description: >
                The container for the account holder information. The nested
                `accountHolderName` field is required.
              properties:
                accountHolderName:
                  description: |
                    Required.

                    The full name of the bank account holder.
                  maxLength: 60
                  type: string
                addressLine1:
                  description: |
                    The first line of the address for the account holder.
                  type: string
                addressLine2:
                  description: |
                    The second line of the address for the account holder. 
                  type: string
                city:
                  description: >
                    The city where the account holder stays.


                    It is recommended to provide the city and country
                    information when creating a payment method. The information
                    will be used to process payments. If the information is not
                    provided during payment method creation, the city and
                    country data will be missing during payment processing.
                  type: string
                country:
                  description: |
                    The country where the account holder stays.
                  type: string
                email:
                  description: |
                    The email address of the account holder.
                  type: string
                firstName:
                  description: |
                    The first name of the account holder.
                  type: string
                lastName:
                  description: |
                    The last name of the account holder.
                  type: string
                phone:
                  description: |
                    The phone number of the account holder.
                  type: string
                state:
                  description: |
                    The state where the account holder stays.
                  type: string
                zipCode:
                  description: |
                    The zip code for the address of the account holder.
                  type: string
              type: object
            accountNumber:
              description: |
                The number of the customer's bank account.
              type: string
            accountMaskNumber:
              description: |
                The masked account number such as ****1234.
              type: string
            branchCode:
              description: |
                The branch code of the bank used for direct debit.
              type: string
            bankCode:
              description: >
                The sort code or number that identifies the bank. This is also
                known as the sort code.
              type: string
            mandateInfo:
              description: |
                The container of the mandate information for the payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method.


                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - accountNumber
        - bankCode
        - branchCode
        - accountHolderInfo
      example:
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        accountNumber: '0000000'
        accountHolderInfo:
          accountHolderName: TestName
        branchCode: '00006'
        bankCode: '0003'
        processingOptions:
          checkDuplicated: true
        type: PAD
    CreatePMPayPalCP:
      allOf:
        - properties:
            type:
              type: string
            BAID:
              description: |
                ID of a PayPal billing agreement.
              type: string
              example: I-1TJ3GAGG82Y9
            email:
              description: |
                Email address associated with the payment method.
              type: string
            tokens:
              description: >
                To create tokenized payment methods, pass in the existing token
                information through the fields in this container.


                Currently, this field is only supported on certain integrations.
                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              properties:
                gatewayType:
                  description: >
                    The type of the payment gateway to generate the tokens. This
                    field is

                    case-sensitive.
                  type: string
                secondTokenId:
                  description: |
                    Pass in the second token of the payment method.
                  type: string
                thirdTokenId:
                  description: |
                    Pass in the third token of the payment method.
                  type: string
                tokenId:
                  description: |
                    Pass in the first token of the payment method.
                  type: string
              required:
                - gatewayType
                - tokenId
              type: object
            tokenize:
              default: false
              description: >
                Specify `true` to tokenize the payment method.


                Currently, this field is only supported on certain
                integrations. 

                See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B3_Create_tokenized_payment_methods_with_existing_tokens_or_account_information"
                target="_blank">this article</a> for more information.
              type: boolean
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - BAID
        - email
      example:
        BAID: I-1TJ3GAGG82Y9
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        email: customer@example.com
        type: PayPalCP
    CreatePMPayPalEC:
      allOf:
        - properties:
            type:
              type: string
            BAID:
              description: |
                ID of a PayPal billing agreement.
              type: string
              example: I-1TJ3GAGG82Y9
            email:
              description: |
                Email address associated with the payment method.
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - BAID
        - email
      example:
        BAID: I-1TJ3GAGG82Y9
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        email: customer@example.com
        type: PayPalEC
    CreatePMPayPalNativeEC:
      allOf:
        - properties:
            type:
              type: string
            BAID:
              description: |
                ID of a PayPal billing agreement. 
                example: I-1TJ3GAGG82Y9
              type: string
            email:
              description: |
                Email address associated with the payment method.
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - BAID
      example:
        BAID: I-1TJ3GAGG82Y9
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        email: customer@example.com
        type: PayPalNativeEC
    CreatePaymentMethodPayPalAdaptive:
      allOf:
        - properties:
            type:
              type: string
            preapprovalKey:
              description: |
                The PayPal preapproval key.
              type: string
            email:
              description: |
                Email address associated with the payment method.
              type: string
              format: email
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
      required:
        - type
        - preapprovalKey
        - email
      example:
        preapprovalKey: PA-3X000000LS390262X
        accountKey: 8a90d6128d45df2b018d4b90681c05x0
        email: customer@example.com
        type: PayPalAdaptive
    CreatePaymentMethodApplePayAdyen:
      allOf:
        - properties:
            type:
              type: string
            applePaymentData:
              description: >
                This field is specific for setting up Apple Pay for Adyen to
                include payload with Apple Pay token or Apple payment data. This
                information should be stringified. For more information, see
                [Set up Adyen Apple
                Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay).
              type: string
            email:
              type: string
              format: email
              description: >
                Email address associated with the payment method. This field is
                specific for setting up Apple Pay on Adyen v2.0. This field will
                be passed to Adyen as `shopperEmail`.
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
      required:
        - type
        - applePaymentData
      example:
        accountKey: 2c92c0f97911f46a0179147510484b90
        type: AdyenApplePay
        email: testemail@test.com
        applePaymentData: >-
          {"data":"hM8GTBX0UVhoKmJ/DkneZfwLlH/utWfEueshybbTpuzlf5i1IwO1kvW32SlFW7TmyvU98gf2Pp1FeyFCh7F2atmstxQdonkeJgpIUV7eWW1wUNaOeND28J8YQsEkDhC3sMgOJoju7FHcXNwveq5fk94StFZozRSi08oAjTnTJko5F32aY/JNWr19GiwWBHZe2jkokryt0TEWKO5hm5oTxeLs1LBOoC2ezaR+p2jQb4ISN2aCgCNiX8605w5eYWk7UCTK3Axf/EuJT4vHe75OKghEmcQLxvFzTtEw33ly6Nj2RJX3+I5TbYLXOfiAO0XnsWdhguDrKogtI44HMFqlNCdt79G71tXwCwbXz0VJywEh1d57tbU5Y5f6pw8TrjjeAMt9sa2pHuHmMGDf","signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5DCCA4ugAwIBAgIIWdihvKr0480wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTIxMDQyMDE5MzcwMFoXDTI2MDQxOTE5MzY1OVowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMA4GA1UdDwEB/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0cAMEQCIHShsyTbQklDDdMnTFB0xICNmh9IDjqFxcE2JWYyX7yjAiBpNpBTq/ULWlL59gBNxYqtbFCn1ghoN5DgpzrQHkrZgTCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYswggGHAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIIWdihvKr0480wDQYJYIZIAWUDBAIBBQCggZUwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMjEwNjAzMTgzNzExWjAqBgkqhkiG9w0BCTQxHTAbMA0GCWCGSAFlAwQCAQUAoQoGCCqGSM49BAMCMC8GCSqGSIb3DQEJBDEiBCCiDFBojwOJgYgEzWaGdLTMez4XiDpYJd34PswTPVdt+DAKBggqhkjOPQQDAgRGMEQCIHAWYyr/s28rtd/khGapLi1jCg3iXwgUfL2l4XadiKq3AiBHuronD982WBP3x0Tzc51rXwMEVpL+GDPme9Ydn2MF2gAAAAAAAA==",
          "header": {
          "publicKeyHash":"vJeh5XAkv8SGX2JHswEbnCUPn01YHcQ6imAp+gP300w=",
          "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEVx9kP/eFM6MrP5sXKuzHT7f9Uhsc0Rox0FKvRpHIiqQ05EXYPsgBJZCEjOYlkviC2jDSvV6tEC8Kfq/z/GhrFA==",
          "transactionId":"7fd9ede5ea8c1d7a8985346c241a8933190a1acb408448c52ac27f7862f674ff"
          }, "version":"EC_v1" }
    CreatePaymentMethodGooglePayAdyen:
      allOf:
        - properties:
            type:
              type: string
            googlePaymentToken:
              description: >
                This field is specific for setting up Google Pay for Adyen 
                gateway integrations to specify the stringified Google Pay
                token. For more information, see [Set up Adyen Google
                Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay).
              type: string
            email:
              description: >
                Email address associated with the payment method. This field is
                specific for setting up Google Pay on Adyen v2.0. This field
                will be passed to Adyen as `shopperEmail`.
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
      required:
        - type
        - googlePaymentToken
      example:
        accountKey: 2c92c0f97911f46a0179147510484b90
        type: AdyenGooglePay
        email: testemail@test.com
        googlePaymentToken: >-
          {"signature":"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\u003d","protocolVersion":"ECv1","signedMessage":"{\"encryptedMessage\":\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\",\"ephemeralPublicKey\":\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\u003d\",\"tag\":\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\u003d\"}"}
    CreatePaymentMethodGooglePayChase:
      allOf:
        - properties:
            type:
              type: string
            googlePaymentToken:
              description: >
                This field is specific for setting up Google Pay on Chase
                gateway integrations to specify the stringified Google Pay
                token. For more information, see [Set up Google Pay on
                Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase).
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
      required:
        - type
        - googlePaymentToken
      example:
        accountKey: 2c92c0f97911f46a0179147510484b90
        type: GooglePay
        googlePaymentToken: >-
          {"signature":"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\u003d","protocolVersion":"ECv1","signedMessage":"{\"encryptedMessage\":\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\",\"ephemeralPublicKey\":\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\u003d\",\"tag\":\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\u003d\"}"}
    CreatePaymentMethodAmazonPay:
      allOf:
        - properties:
            type:
              type: string
            amazonPayToken:
              description: >
                This field is specific for setting up Amazon Pay gateway
                integrations to specify the stringified Amazon Pay token.
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentMethodCommonFields'
      required:
        - type
        - amazonPayToken
      example:
        amazonPayToken: C03-0739300-4671639
        amazonPayRegion: JP
        accountKey: 2c92c0f97911f46a0179147510484b90
    POSTPaymentMethodRequest:
      type: object
      discriminator:
        propertyName: type
        mapping:
          CreditCard: '#/components/schemas/CreatePaymentMethodCreditCard'
          CreditCardReferenceTransaction: '#/components/schemas/CreatePaymentMethodCCReferenceTransaction'
          ACH: '#/components/schemas/CreatePaymentMethodACH'
          SEPA: '#/components/schemas/CreatePaymentMethodSEPA'
          Betalingsservice: '#/components/schemas/CreatePaymentMethodBetalingsservice'
          Autogiro: '#/components/schemas/CreatePaymentMethodAutogiro'
          Bacs: '#/components/schemas/CreatePaymentMethodBacs'
          Becs: '#/components/schemas/CreatePaymentMethodBecs'
          Becsnz: '#/components/schemas/CreatePaymentMethodBecsnz'
          PAD: '#/components/schemas/CreatePaymentMethodPAD'
          PayPalCP: '#/components/schemas/CreatePMPayPalCP'
          PayPalEC: '#/components/schemas/CreatePMPayPalEC'
          PayPalNativeEC: '#/components/schemas/CreatePMPayPalNativeEC'
          PayPalAdaptive: '#/components/schemas/CreatePaymentMethodPayPalAdaptive'
          AdyenApplePay: '#/components/schemas/CreatePaymentMethodApplePayAdyen'
          AdyenGooglePay: '#/components/schemas/CreatePaymentMethodGooglePayAdyen'
          GooglePay: '#/components/schemas/CreatePaymentMethodGooglePayChase'
          AmazonPay: '#/components/schemas/CreatePaymentMethodAmazonPay'
      oneOf:
        - $ref: '#/components/schemas/CreatePaymentMethodCreditCard'
        - $ref: '#/components/schemas/CreatePaymentMethodCCReferenceTransaction'
        - $ref: '#/components/schemas/CreatePaymentMethodACH'
        - $ref: '#/components/schemas/CreatePaymentMethodSEPA'
        - $ref: '#/components/schemas/CreatePaymentMethodBetalingsservice'
        - $ref: '#/components/schemas/CreatePaymentMethodAutogiro'
        - $ref: '#/components/schemas/CreatePaymentMethodBacs'
        - $ref: '#/components/schemas/CreatePaymentMethodBecs'
        - $ref: '#/components/schemas/CreatePaymentMethodBecsnz'
        - $ref: '#/components/schemas/CreatePaymentMethodPAD'
        - $ref: '#/components/schemas/CreatePMPayPalNativeEC'
        - $ref: '#/components/schemas/CreatePMPayPalCP'
        - $ref: '#/components/schemas/CreatePMPayPalEC'
        - $ref: '#/components/schemas/CreatePaymentMethodPayPalAdaptive'
        - $ref: '#/components/schemas/CreatePaymentMethodApplePayAdyen'
        - $ref: '#/components/schemas/CreatePaymentMethodGooglePayChase'
        - $ref: '#/components/schemas/CreatePaymentMethodAmazonPay'
      required:
        - type
      description: Payment method information associated with an account.
    CreateAccountShipToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            city:
              description: |
                City
              type: string
              maxLength: 100
            country:
              description: |
                Country; must be a valid country name or abbreviation.
              type: string
            county:
              description: |
                May optionally be used by Zuora Tax to calculate county tax.
              type: string
              maxLength: 100
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              format: email
              maxLength: 80
            state:
              description: >
                State must be a valid subregion (state or province) name or
                code. For more information, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                target="_blank">View subregions of a specific country or
                region</a>.
              type: string
              maxLength: 100
            taxRegion:
              description: >
                100 characters or less.

                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              type: string
              maxLength: 100
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: >
        Container for optional ship-to contact; uses the same field structure as
        the `billToContact` field. If this field is not specified and the
        `shipToSameAsBillTo` field is `false`, the ship-to contact of the
        account is empty.
      title: ShipToContact
    POSTAccountTypeSoldToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            city:
              description: |
                City
              type: string
              maxLength: 100
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the sold-to contact to
                calculate tax. A bill-to contact may be used if no sold-to
                contact is provided.
              type: string
            county:
              description: |
                May optionally be used by Zuora Tax to calculate county tax.
              type: string
              maxLength: 100
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              format: email
              maxLength: 80
            state:
              description: >
                State; must be a valid subregion (state or province) name or
                code. For more information, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                target="_blank">View subregions of a specific country or
                region</a>. If using Zuora Tax, be aware that Zuora Tax requires
                a state (in the US) or province (in Canada) in this field for
                the sold-to contact to calculate tax, and that a bill-to contact
                may be used if no sold-to contact is provided.
              type: string
              maxLength: 100
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              type: string
              maxLength: 100
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: >
        Container for optional sold-to contact; uses the same field structure as
        the bill-to contact (above). If a sold-to contact is not specified, one
        is created from the bill-to contact. Once created, these are two
        separate data entities, and future changes to one do not affect the
        other.
      title: soldToContact
    ChargeModelConfigurationType:
      description: >
        Container for charge model configuration data.


        **Note**: This field is only available if you have the High Water Mark,
        Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled.
        These charge models are available for customers with Enterprise and Nine
        editions by default. If you are a Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information.
      properties:
        customFieldPerUnitRate:
          description: >
            The custom field that carries the per-unit rate for each usage
            record. For example, `perUnitAmount__c`.
                
            This field is only available for the usage-based charges that use
            the Pre-Rated Per Unit Pricing charge model. The charge model is
            available for customers with Enterprise and Nine editions by
            default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
          type: string
        customFieldTotalAmount:
          description: >
            The custom field that carries the total amount to charge for a usage
            record. For example, `totalAmount__c`. 
                
            This field is only available for the usage-based charges that use
            the Pre-Rated Pricing charge model. The charge model is available
            for customers with Enterprise and Nine editions by default. If you
            are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
          type: string
        formula:
          description: >
            The pricing formula to calculate actual rating amount for each usage
            record.


            This field is only available for the usage-based charges that use
            the Multi-Attribute Pricing charge model. The charge model is
            available for customers with Enterprise and Nine editions by
            default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
          type: string
      title: chargeModelConfiguration
      type: object
    POSTTierType:
      properties:
        endingUnit:
          description: |
            End number of a range of units for the tier.
          type: number
        price:
          description: >
            Price of the tier if the charge is a flat fee, or the price of each
            unit in the tier if the charge model is tiered pricing.
          type: number
        priceFormat:
          description: |
            Indicates if pricing is a flat fee or is per unit.

            Values:

            * `FlatFee`
            * `PerUnit`
          type: string
        startingUnit:
          description: |
            Starting number of a range of units for the tier.
          type: number
        tier:
          description: |
            Unique number that identifies the tier that the price applies to.
          format: int64
          type: integer
      required:
        - tier
        - price
      title: tiers
      type: object
    RatePlanChargeObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Rate Plan Charge object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Rate Plan Charge object.
      title: ratePlanChargeFieldsCustom
      type: object
    POSTScCreateType:
      allOf:
        - properties:
            amendedByOrderOn:
              description: >
                The date when the rate plan charge is amended through an order
                or amendment. This field is to standardize the booking date
                information to increase audit ability and traceability of data
                between Zuora Billing and Zuora Revenue. It is mapped as the
                booking date for a sale order line in Zuora Revenue.
              type: string
            applyDiscountTo:
              description: >
                Specifies the type of charges that you want a specific discount
                to apply to.


                Values:


                * `ONETIME`

                * `RECURRING`

                * `USAGE`

                * `ONETIMERECURRING`

                * `ONETIMEUSAGE`

                * `RECURRINGUSAGE`

                * `ONETIMERECURRINGUSAGE`
              type: string
            billCycleDay:
              description: >
                Sets the bill cycle day (BCD) for the charge. The BCD determines
                which day of the month the customer is billed.


                Values: `1`-`31`
              type: string
            billCycleType:
              description: >
                Specifies how to determine the billing day for the charge. When
                this field is set to `SpecificDayofMonth`, set the
                `BillCycleDay` field. When this field is set to
                `SpecificDayofWeek`, set the `weeklyBillCycleDay` field.


                Values:


                * `DefaultFromCustomer`

                * `SpecificDayofMonth`

                * `SubscriptionStartDay`

                * `ChargeTriggerDay`

                * `SpecificDayofWeek`
              type: string
            billingPeriod:
              description: >
                Billing period for the charge. The start day of the billing
                period is also called the bill cycle day (BCD).

                Values:


                * `Month`

                * `Quarter`

                * `Semi_Annual`

                * `Annual`

                * `Eighteen_Months`

                * `Two_Years`

                * `Three_Years`

                * `Five_Years`

                * `Specific_Months`

                * `Subscription_Term`

                * `Week`

                * `Specific_Weeks`
              type: string
            billingPeriodAlignment:
              description: >
                Aligns charges within the same subscription if multiple charges
                begin on different dates.


                Values:


                * `AlignToCharge`

                * `AlignToSubscriptionStart`

                * `AlignToTermStart`
              type: string
            billingTiming:
              description: >
                Billing timing for the charge for recurring charge types. Not
                avaliable for one time, usage, and discount charges.


                Values:


                * `IN_ADVANCE` (default)

                * `IN_ARREARS`
              type: string
            chargeModelConfiguration:
              $ref: '#/components/schemas/ChargeModelConfigurationType'
            description:
              description: |
                Description of the charge.
              type: string
            discountAmount:
              description: |
                Specifies the amount of fixed-amount discount.
              type: number
            discountLevel:
              description: >
                Specifies if the discount applies to the product rate plan only,
                the entire subscription, or to any activity in the account.


                Values:


                * `rateplan`

                * `subscription`

                * `account`
              type: string
            discountPercentage:
              description: |
                Percentage of discount for a percentage discount. 
              type: number
            endDateCondition:
              description: >
                Defines when the charge ends after the charge trigger date. If
                the subscription ends before the charge end date, the charge
                ends when the subscription ends. But if the subscription end
                date is subsequently changed through a Renewal, or Terms and
                Conditions amendment, the charge will end on the charge end
                date.


                Values:


                * `Subscription_End`

                * `Fixed_Period`

                * `Specific_End_Date`

                * `One_Time`
              type: string
            excludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude rate plan charge related invoice items,
                invoice item adjustments, credit memo items, and debit memo
                items from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled.
              type: boolean
            excludeItemBookingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude rate plan charges from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled.
              type: boolean
            includedUnits:
              description: >
                Specifies the number of units in the base set of units for this
                charge. Must be >=`0`.
              type: number
            isAllocationEligible:
              description: >
                This field is used to identify if the charge segment is
                allocation

                eligible in revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            isUnbilled:
              description: >
                This field is used to dictate how to perform the accounting
                during

                revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            listPriceBase:
              description: |
                The list price base for the product rate plan charge.

                Values:

                * `Per_Billing_Period`
                * `Per_Month`
                * `Per_Week`
                * `Per_Year`
                * `Per_Specific_Months`
              type: string
            number:
              description: >
                Unique number that identifies the charge. Max 50 characters.
                System-generated if not provided.
              type: string
            numberOfPeriods:
              description: >
                Specifies the number of periods to use when calculating charges
                in an overage smoothing charge model.
              format: int64
              type: integer
            originalOrderDate:
              description: >
                The date when the rate plan charge is created through an order
                or amendment. This field is not updatable.


                This field is to standardize the booking date information to
                increase audit ability and traceability of data between Zuora
                Billing and Zuora Revenue. It is mapped as the booking date for
                a sale order line in Zuora Revenue.
              format: date
              type: string
            overagePrice:
              description: |
                Price for units over the allowed amount.
              type: number
            overageUnusedUnitsCreditOption:
              description: >
                Determines whether to credit the customer with unused units of
                usage.


                Values:


                * `NoCredit`

                * `CreditBySpecificRate`
              type: string
            price:
              description: |
                Price for units in the subscription rate plan.
              type: number
            priceChangeOption:
              description: >
                Applies an automatic price change when a termed subscription is
                renewed. The Billing Admin setting **Enable Automatic Price
                Change When Subscriptions are Renewed?** must be set to Yes to
                use this field.

                Values:


                * `NoChange` (default)

                * `SpecificPercentageValue`

                * `UseLatestProductCatalogPricing`
              type: string
            priceIncreasePercentage:
              description: >
                Specifies the percentage to increase or decrease the price of a
                termed subscription's renewal. Required if you set the
                `PriceChangeOption` field to `SpecificPercentageValue`. 


                Value must be a decimal between `-100` and `100`.
              type: number
            productRatePlanChargeId:
              description: |
                ID of a product rate-plan charge for this subscription.
              type: string
            productRatePlanChargeNumber:
              description: |
                Number of a product rate-plan charge for this subscription.
              type: string
            quantity:
              description: >
                Number of units. Must be a decimal >=`0`. 


                When using `chargeOverrides` for creating subscriptions with
                recurring charge types, the `quantity` field must be populated
                when the charge model is "Tiered Pricing" or "Volume Pricing".
                It is not required for "Flat Fee Pricing" charge model.
              type: number
            ratingGroup:
              description: >
                Specifies a rating group based on which usage records are rated.


                Possible values:


                - `ByBillingPeriod` (default): The rating is based on all the
                usages in a billing period.

                - `ByUsageStartDate`: The rating is based on all the usages on
                the same usage start date. 

                - `ByUsageRecord`: The rating is based on each usage record.

                - `ByUsageUpload`: The rating is based on all the  usages in a
                uploaded usage file (`.xls` or `.csv`).

                - `ByGroupId`: The rating is based on all the usages in a custom
                group.


                **Note:** 

                - The `ByBillingPeriod` value can be applied for all charge
                models. 

                - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload`
                values can only be applied for per unit, volume pricing, and
                tiered pricing charge models. 

                - The `ByGroupId` value is only available if you have the Active
                Rating feature enabled.

                - Use this field only for Usage charges. One-Time Charges and
                Recurring Charges return `NULL`.
              type: string
            specificBillingPeriod:
              description: >
                Specifies the number of month or week for the charges billing
                period. Required if you set the value of the `billingPeriod`
                field to `Specific_Months` or `Specific_Weeks`.
              format: int64
              type: integer
            specificEndDate:
              description: >
                Defines when the charge ends after the charge trigger date.


                **Note**:


                * This field is only applicable when the `endDateCondition`
                field is set to `Specific_End_Date`.


                * If the subscription ends before the specific end date, the
                charge ends when the subscription ends. But if the subscription
                end date is subsequently changed through a Renewal, or Terms and
                Conditions amendment, the charge will end on the specific end
                date.
              format: date
              type: string
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              description: >
                Container for Volume, Tiered, or Tiered with Overage charge
                models. Supports the following charge types:


                * One-time

                * Recurring

                * Usage-based
              items:
                $ref: '#/components/schemas/POSTTierType'
              type: array
            triggerDate:
              description: >
                Specifies when to start billing the customer for the charge.
                Required if the `triggerEvent` field is set to `USD`.
              format: date
              type: string
            triggerEvent:
              description: |
                Specifies when to start billing the customer for the charge.

                Values:

                * `UCE`
                * `USA`
                * `UCA`
                * `USD`
              type: string
            unusedUnitsCreditRates:
              description: >
                Specifies the rate to credit a customer for unused units of
                usage. This field applies only for overage charge models when
                the `OverageUnusedUnitsCreditOption` field is set to
                `CreditBySpecificRate`.
              type: number
            upToPeriods:
              description: >
                Specifies the length of the period during which the charge is
                active. If this period ends before the subscription ends, the
                charge ends when this period ends.


                **Note:** You must use this field together with the
                `upToPeriodsType` field to specify the time period.


                * This field is applicable only when the `endDateCondition`
                field is set to `Fixed_Period`. 

                * If the subscription end date is subsequently changed through a
                Renewal, or Terms and Conditions amendment, the charge end date
                will change accordingly up to the original period end.
              format: int64
              type: integer
            upToPeriodsType:
              description: >

                The period type used to define when the charge ends. 


                Values:


                * `Billing_Periods`

                * `Days`

                * `Weeks`

                * `Months`

                * `Years`


                You must use this field together with the `upToPeriods` field to
                specify the time period.


                This field is applicable only when the `endDateCondition` field
                is set to `Fixed_Period`. 
              type: string
            weeklyBillCycleDay:
              description: >
                Specifies which day of the week is the bill cycle day (BCD) for
                the charge. 


                Values:


                * `Sunday`

                * `Monday`

                * `Tuesday`

                * `Wednesday`

                * `Thursday`

                * `Friday`

                * `Saturday`
              type: string
          required:
            - productRatePlanChargeId
          type: object
        - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
      title: chargeOverrides
    RatePlanObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Rate Plan object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Rate Plan object.
      title: RatePlanCustomFields
      type: object
    POSTSrpCreateType:
      allOf:
        - properties:
            chargeOverrides:
              description: >
                This optional container is used to override the quantity of one
                or more product rate plan charges for this subscription.
              items:
                $ref: '#/components/schemas/POSTScCreateType'
              type: array
            externalCatalogPlanId:
              description: >
                An external ID of the product rate plan to be added. You can use
                this field to specify a product rate plan that is imported from
                an external system. The value of the `externalCatalogPlanId`
                field must match one of the values that are predefined in the
                `externallyManagedPlanIds` field on a product rate plan.


                **Note:** If both `externalCatalogPlanId` and
                `productRatePlanId` are provided. They must point to the same
                product rate plan. Otherwise, the request would fail.
              type: string
            externalIdSourceSystem:
              description: >
                The ID of the external source system. You can use this field and
                `externalCatalogPlanId` to specify a product rate plan that is
                imported from an external system.


                **Note:** If both `externalCatalogPlanId`,
                `externalIdSourceSystem` and `productRatePlanId` are provided.
                They must point to the same product rate plan. Otherwise, the
                request would fail.
              type: string
            externallyManagedPlanId:
              description: >
                Indicates the unique identifier for the rate plan purchased on a
                third-party store. This field is used to represent a
                subscription rate plan created through third-party stores.
              type: string
            productRatePlanId:
              description: |
                ID of a product rate plan for this subscription.
              type: string
            productRatePlanNumber:
              description: |
                Number of a product rate plan for this subscription.
              type: string
          type: object
        - $ref: '#/components/schemas/RatePlanObjectCustomFields'
      title: subscribeToRatePlans
    SubscriptionObjectQTFields:
      description: |
        Container for Subscription fields provided by Zuora Quotes.
      properties:
        CpqBundleJsonId__QT:
          description: >
            The Bundle product structures from Zuora Quotes if you utilize
            Bundling in Salesforce. Do not change the value in this field.
          maxLength: 32
          type: string
        OpportunityCloseDate__QT:
          description: >
            The closing date of the Opportunity. This field is used in Zuora
            data sources to report on Subscription metrics. If the subscription
            originated from Zuora Quotes, the value is populated with the value
            from Zuora Quotes.
          format: date
          type: string
        OpportunityName__QT:
          description: >
            The unique identifier of the Opportunity. This field is used in
            Zuora data sources to report on Subscription metrics. If the
            subscription originated from Zuora Quotes, the value is populated
            with the value from Zuora Quotes.
          maxLength: 100
          type: string
        QuoteBusinessType__QT:
          description: >
            The specific identifier for the type of business transaction the
            Quote represents such as New, Upsell, Downsell, Renewal or Churn.
            This field is used in Zuora data sources to report on Subscription
            metrics. If the subscription originated from Zuora Quotes, the value
            is populated with the value from Zuora Quotes.
          maxLength: 32
          type: string
        QuoteNumber__QT:
          description: >
            The unique identifier of the Quote. This field is used in Zuora data
            sources to report on Subscription metrics. If the subscription
            originated from Zuora Quotes, the value is populated with the value
            from Zuora Quotes.
          maxLength: 32
          type: string
        QuoteType__QT:
          description: >
            The Quote type that represents the subscription lifecycle stage such
            as New, Amendment, Renew or Cancel. This field is used in Zuora data
            sources to report on Subscription metrics. If the subscription
            originated from Zuora Quotes, the value is populated with the value
            from Zuora Quotes.
          maxLength: 32
          type: string
      title: subscriptionFieldsQT
      type: object
    SubscriptionObjectNSFields:
      description: >
        Container for Subscription fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the subscription's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Project__NS:
          description: >
            The NetSuite project that the subscription was created from. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SalesOrder__NS:
          description: >
            The NetSuite sales order than the subscription was created from.
            Only available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the subscription was synchronized with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: subscriptionFieldsNS
      type: object
    SubscriptionObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Subscription object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Subscription object.
      title: subscriptionFieldsCustom
      type: object
    POSTAccountTypeSubscription:
      allOf:
        - properties:
            autoRenew:
              description: |
                If `true`, auto-renew is enabled. Default is `false`.
              type: boolean
            contractEffectiveDate:
              description: |
                Effective contract date for this subscription, as `yyyy-mm-dd`.
              format: date
              type: string
            customerAcceptanceDate:
              description: >
                The date on which the services or products within a subscription
                have been accepted by the customer, as `yyyy-mm-dd`.


                Default value is dependent on the value of other fields. See
                Notes section for more details.
              format: date
              type: string
            initialTerm:
              description: >
                Duration of the initial subscription term in whole months. 
                Default is 0. 
              format: int64
              type: integer
            invoiceOwnerAccountKey:
              description: >
                Invoice owner account number or ID.


                **Note:** This feature is in Limited Availability. If you wish
                to have access to the feature, submit a request at [Zuora Global
                Support](https://support.zuora.com). 
              type: string
            invoiceSeparately:
              description: >
                Separates a single subscription from other subscriptions and
                invoices the charge independently. 


                If the value is `true`, the subscription is billed separately
                from other subscriptions. If the value is `false`, the
                subscription is included with other subscriptions in the account
                invoice.

                The default value is `false`.


                Prerequisite: The default subscription setting `Enable
                Subscriptions to be Invoiced Separately` must be set to `Yes`.
              type: boolean
            notes:
              description: ''
              type: string
            renewalTerm:
              description: |
                Duration of the renewal term in whole months. Default is 0.
              format: int64
              type: integer
            serviceActivationDate:
              description: >
                The date on which the services or products within a subscription
                have been activated and access has been provided to the
                customer, as `yyyy-mm-dd`.


                Default value is dependent on the value of other fields. See
                Notes section for more details.
              format: date
              type: string
            subscribeToRatePlans:
              description: |
                Container for one or more rate plans for this subscription.
              items:
                $ref: '#/components/schemas/POSTSrpCreateType'
              type: array
            subscriptionNumber:
              description: >
                Subscription Number. The value can be up to 1000 characters.


                If you do not specify a subscription number when creating a
                subscription for the new account, Zuora will generate a
                subscription number automatically.


                If the account is created successfully, the subscription number
                is returned in the `subscriptionNumber` response field.
              type: string
            termStartDate:
              description: >
                The date on which the subscription term begins, as `yyyy-mm-dd`.
                If this is a renewal subscription, this date is different from
                the subscription start date.
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
          required:
            - contractEffectiveDate
            - termType
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectQTFields'
        - $ref: '#/components/schemas/SubscriptionObjectNSFields'
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      description: >
        Container for subscription information, used if creating a subscription
        for the new account at the time of account creation.
      title: subscription
    AccountObjectNSFields:
      description: >
        Container for Account fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        Class__NS:
          description: >
            Value of the Class field for the corresponding customer account in
            NetSuite. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        CustomerType__NS:
          description: >
            Value of the Customer Type field for the corresponding customer
            account in NetSuite. The Customer Type field is used when the
            customer account is created in NetSuite. Only available if you have
            installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - Company
            - Individual
          type: string
        Department__NS:
          description: >
            Value of the Department field for the corresponding customer account
            in NetSuite. Only available if you have installed the [Zuora
            Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the account's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Location__NS:
          description: >
            Value of the Location field for the corresponding customer account
            in NetSuite. Only available if you have installed the [Zuora
            Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Subsidiary__NS:
          description: >
            Value of the Subsidiary field for the corresponding customer account
            in NetSuite. The Subsidiary field is required if you use NetSuite
            OneWorld. Only available if you have installed the [Zuora Connector
            for NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the account was sychronized with NetSuite. Only available
            if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SynctoNetSuite__NS:
          description: >
            Specifies whether the account should be synchronized with NetSuite.
            Only available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          enum:
            - 'Yes'
            - 'No'
          type: string
      title: accountFieldsNetSuite
      type: object
    AccountObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Account object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Account object.
      title: accountFieldsCustom
      type: object
    POSTAccountType:
      allOf:
        - properties:
            accountNumber:
              description: >
                A unique account number, up to 50 characters that do not begin
                with the default account number prefix.  If no account number is
                specified, one is generated.
              type: string
            additionalEmailAddresses:
              description: >
                A list of additional email addresses to receive email
                notifications. Use commas to separate email addresses.
              items:
                type: string
              type: array
            applicationOrder:
              description: >
                The priority order to apply credit memos and/or unapplied
                payments to an invoice. Possible item values are: `CreditMemo`,
                `UnappliedPayment`.


                **Note:**
                  - This field is valid only if the `applyCredit` field is set to `true`.
                  - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
                  - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
              items:
                type: string
              type: array
            applyCredit:
              description: >
                Whether to automatically apply credit memos or unapplied
                payments, or both to an invoice.


                If the value is `true`, the credit memo or unapplied payment, or
                both will be automatically applied to the invoice. If no value
                is specified or the value is `false`, no action is taken.


                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.
              type: boolean
            applyCreditBalance:
              description: >
                Applies a credit balance to an invoice.


                If the value is `true`, the credit balance is applied to the
                invoice. If the value is `false`, no action is taken.


                Prerequisite: `invoice` must be `true`.


                To view the credit balance adjustment, retrieve the details of
                the invoice using the Get Invoices method.



                **Note:** 
                  - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.
                  - This field is deprecated if you have the Invoice Settlement feature enabled. 
              type: boolean
            autoPay:
              description: >
                Whether future payments are to be automatically billed when they
                are due. 


                - If this field is set to `true`, you must specify either the
                `creditCard` field or the `hpmCreditCardPaymentMethodId` field,
                but not both.

                - If this field is set to `false`, you can specify neither the
                `creditCard` field nor the `hpmCreditCardPaymentMethodId` field.
              type: boolean
            batch:
              description: >
                The alias name given to a batch. A string of 50 characters or

                less.


                **Note**: By default, you have 50 configurable account batches.
                To increase the limit to 200 batches, you must have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite"
                target="_blank">Performance Booster Elite</a> package.
              type: string
            billCycleDay:
              description: >
                The account's bill cycle day (BCD), when bill runs generate
                invoices for the account.  Specify any day of the month (1-31,
                where 31 = end-of-month), or 0 for auto-set.


                Required if no subscription will be created. 


                Optional if a subscription is created and defaults to the
                day-of-the-month of the subscription's `contractEffectiveDate`.
              format: int64
              type: integer
            billToContact:
              $ref: '#/components/schemas/POSTAccountTypeBillToContact'
            collect:
              default: true
              description: >
                Collects an automatic payment for a subscription. The collection
                generated in this operation is only for this subscription, not
                for the entire customer account.


                If the value is `true`, the automatic payment is collected. If
                the value is `false`, no action is taken.


                Prerequisite: The `invoice` or `runBilling` field must be
                `true`. 


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `196.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: boolean
            communicationProfileId:
              description: >
                The ID of the communication profile that this account is linked
                to.


                You can provide either or both of the `communicationProfileId`
                and `profileNumber` fields.


                If both are provided, the request will fail if they do not refer
                to the same communication profile.


                If none is provided, the default communication profile will be
                used for this account.
              type: string
            creditCard:
              $ref: '#/components/schemas/POSTAccountTypeCreditCard'
            creditMemoReasonCode:
              description: >-
                A code identifying the reason for the credit memo transaction
                that is generated by the request. The value must be an existing
                reason code. If you do not pass the field or pass the field with
                empty value, Zuora uses the default reason code.
              type: string
            creditMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the credit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08a6246fdf101626b1b3fe0144b.
              type: string
            crmId:
              description: |
                CRM account ID for the account, up to 100 characters.
              type: string
            currency:
              description: >
                A currency as defined in Billing Settings in the Zuora UI.


                For payment method authorization, if the `paymentMethod` >
                `currencyCode` field is specified, `currencyCode` is used.
                Otherwise, this `currency` field is used for payment method
                authorization. If no currency is specified for the account, the
                default currency of the account is then used.
              type: string
            customerServiceRepName:
              description: >
                Name of the account's customer service representative, if
                applicable.
              maxLength: 50
              type: string
            debitMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the debit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08d62470a8501626b19d24f19e2.
              type: string
            documentDate:
              description: >
                The date of the billing document, in `yyyy-mm-dd` format. It
                represents the invoice date for invoices, credit memo date for
                credit memos, and debit memo date for debit memos.


                - If this field is specified, the specified date is used as the
                billing document date. 

                - If this field is not specified, the date specified in the
                `targetDate` is used as the billing document date.
              format: date
              type: string
            einvoiceProfile:
              $ref: '#/components/schemas/PostAccountEInvoiceProfile'
            gatewayRoutingEligible:
              default: false
              description: >
                Indicates whether to include the applicable billing accounts to
                gateway routing for controlled adoption. 
              type: boolean
            hpmCreditCardPaymentMethodId:
              description: >
                The ID of the payment method associated with this account. You
                can use this field to set the default payment method for the
                account. The payment method ID specified in this field will be
                set as the default payment method for this account. You can pass
                the ID of any valid payment method, including a 
                system-generated payment method ID, into this field.


                If the `autoPay` field is set to `true`, you must provide the
                credit card payment method ID for either this field or the
                `creditCard` field, but not both.


                For the Credit Card Reference Transaction payment method, you
                can specify the payment method ID in this field or use the
                `paymentMethod` field to create a CC Reference Transaction
                payment method for an account.
              type: string
            invoiceDeliveryPrefsEmail:
              default: false
              description: |
                Whether the customer wants to receive invoices through email. 
              type: boolean
            invoiceDeliveryPrefsPrint:
              default: false
              description: >
                Whether the customer wants to receive printed invoices, such as
                through postal mail.
              type: boolean
            invoiceTemplateId:
              description: >
                Invoice template ID or template number, configured in Billing
                Settings in the Zuora UI.
              type: string
            name:
              description: |
                Account name, up to 255 characters.
              type: string
            notes:
              description: A string of up to 65,535 characters.
              type: string
            organizationLabel:
              description: >
                Name of the organization that the account belongs to.  


                This field is only required when you have already turned on
                Multi-Org feature.    
              type: string
            parentId:
              description: >-
                Identifier of the parent customer account for this Account
                object. The length is 32 characters. Use this field if you have
                <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
                target="_blank">Customer Hierarchy</a> enabled.
              type: string
            partnerAccount:
              default: false
              description: >
                Whether the customer account is a partner, distributor, or
                reseller. 



                You can set this field to `true` if you have business with
                distributors or resellers, or operating in B2B model to manage
                numerous subscriptions through concurrent API requests. After
                this field is set to `true`, the calculation of account metrics
                is performed asynchronously during operations such as
                subscription creation, order changes, invoice generation, and
                payments.

                 
                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"
                target="_blank">Reseller Account</a> feature enabled.
              type: boolean
            paymentGateway:
              description: >
                The name of the payment gateway instance. If null or left
                unassigned, the Account will use the Default Gateway.
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              description: >
                Payment terms for this account. Possible values are: `Due Upon
                Receipt`, `Net 30`, `Net 60`, `Net 90`.


                **Note**: If you want to specify a payment term when creating a
                new account, you must set a value in this field. If you do not
                set a value in this field, Zuora will use the default value set
                in **Billing Settings** > **Payment Terms** from Zuora UI.
              type: string
            profileNumber:
              description: >
                The number of the communication profile that this account is
                linked to.


                You can provide either or both of the `communicationProfileId`
                and `profileNumber` fields.


                If both are provided, the request will fail if they do not refer
                to the same communication profile.


                If none is provided, the default communication profile will be
                used for this account.
              type: string
            purchaseOrderNumber:
              description: >-
                The purchase order number provided by your customer for
                services, products, or both purchased.
              type: string
            runBilling:
              default: true
              description: >
                Creates an invoice for a subscription. If you have the Invoice
                Settlement feature enabled, a credit memo might also be created
                based on the [invoice and credit memo generation
                rule](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/Rules_for_generating_invoices_and_credit_memos). 



                The billing documents generated

                in this operation is only for this subscription, not for the
                entire

                customer account.



                Possible values:


                - `true`: An invoice is created. If you have the Invoice
                Settlement feature enabled, a credit memo might also be created.



                - `false`: No invoice is created.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `196.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: boolean
            salesRep:
              description: >-
                The name of the sales representative associated with this
                account, if applicable. Maximum of 50 characters.
              type: string
            sequenceSetId:
              description: >
                The ID or number of the billing document sequence set to assign
                to the customer account. 


                The billing documents to generate for this account will adopt
                the prefix and starting document number configured in the
                sequence set.


                If a customer account has no assigned billing document sequence
                set, billing documents generated for this account adopt the
                prefix and starting document number from the default sequence
                set.
              type: string
              nullable: true
            shipToContact:
              $ref: '#/components/schemas/CreateAccountShipToContact'
            shipToSameAsBillTo:
              description: >
                Whether the ship-to contact and bill-to contact are the same
                entity.


                The created account has the same bill-to contact and ship-to
                contact entity only when all the following conditions are met in
                the request body:


                - This field is set to `true`. 


                - A bill-to contact is specified.


                - No ship-to contact is specified.
              type: boolean
            soldToContact:
              $ref: '#/components/schemas/POSTAccountTypeSoldToContact'
            soldToSameAsBillTo:
              description: >
                Whether the sold-to contact and bill-to contact are the same
                entity. 


                The created account has the same bill-to contact and sold-to
                contact entity only when all the following conditions are met in
                the request body:


                - This field is set to `true`. 

                - A bill-to contact is specified.

                - No sold-to contact is specified.
              type: boolean
            subscription:
              $ref: '#/components/schemas/POSTAccountTypeSubscription'
            summaryStatementTemplateId:
              description: >
                The summary statement template ID or number. When a user
                attempts to generate a summary statement from the "Account
                Summary Statement" screen, the system utilizes this template to
                produce the PDF.
              type: string
              nullable: true
            tagging:
              description: ''
              type: string
            targetDate:
              description: >
                Date through which to calculate charges if an invoice or a
                credit memo is generated, as yyyy-mm-dd. Default is current
                date.

                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `211.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).


                **Note:** The credit memo is only available only if you have the
                Invoice Settlement feature enabled.
              format: date
              type: string
            taxInfo:
              description: >
                Container for tax exempt information, used to establish the tax
                exempt status of a customer account.
              properties:
                VATId:
                  description: >
                    EU Value Added Tax ID. 


                    **Note:** This feature is in Limited Availability. If you
                    wish to have access to the feature, submit a request at
                    [Zuora Global Support](https://support.zuora.com).
                  type: string
                companyCode:
                  description: >
                    Unique code that identifies a company account in Avalara.
                    Use this field to calculate taxes based on origin and
                    sold-to addresses in Avalara.


                    **Note:** This feature is in Limited Availability. If you
                    wish to have access to the feature, submit a request at
                    [Zuora Global Support](https://support.zuora.com). 
                  type: string
                exemptCertificateId:
                  description: >
                    ID of the customer tax exemption certificate. Requires Zuora
                    Tax.
                  type: string
                exemptCertificateType:
                  description: >
                    Type of tax exemption certificate that the customer holds.
                    Requires Zuora Tax.
                  type: string
                exemptDescription:
                  description: >
                    Description of the tax exemption certificate that the
                    customer holds. Requires Zuora Tax.
                  type: string
                exemptEffectiveDate:
                  description: >
                    Date when the customer tax exemption starts. Requires Zuora
                    Tax.


                    Format: `yyyy-mm-dd`. Defaults to the current date.
                  format: date
                  type: string
                exemptEntityUseCode:
                  description: >
                    A unique entity use code to apply exemptions in Avalara
                    AvaTax.


                    This account-level field is required only when you choose
                    Avalara as your tax engine. See [Exempt
                    Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for
                    more details.
                  maxLength: 64
                  type: string
                exemptExpirationDate:
                  description: >
                    Date when the customer tax exemption expires. Requires Zuora
                    Tax.


                    Format: `yyyy-mm-dd`. Defaults to the current date.
                  format: date
                  type: string
                exemptIssuingJurisdiction:
                  description: >
                    Jurisdiction in which the customer tax exemption certificate
                    was issued.
                  type: string
                exemptStatus:
                  description: >
                    Status of the account tax exemption. Requires Zuora Tax.


                    Required if you use Zuora Tax. This field is unavailable if
                    Zuora Tax is not used.


                    Values: `Yes`, `No`(default), `pendingVerification`. Note
                    that the value will be set to `No` if no input.
                  type: string
              type: object
          required:
            - name
            - currency
            - billToContact
          type: object
        - $ref: '#/components/schemas/AccountObjectNSFields'
        - $ref: '#/components/schemas/AccountObjectCustomFields'
      example:
        name: Amy Lawrence
        billToContact:
          firstName: Amy
          lastName: Lawrence
          country: United States
          state: CA
        autoPay: false
        currency: USD
        billCycleDay: 1
    POSTAccountResponseType:
      properties:
        accountId:
          description: |
            Auto-generated account ID.
          type: string
        accountNumber:
          description: |
            Account number.
          type: string
        billToContactId:
          description: |
            The ID of the bill-to contact.
          type: string
        contractedMrr:
          description: |
            Contracted monthly recurring revenue of the subscription.
          format: decimal
          type: string
        creditMemoId:
          description: >
            The credit memo ID, if a credit memo is generated during the
            subscription process.


            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        invoiceId:
          description: |
            ID of the invoice generated at account creation, if applicable.
          type: string
        paidAmount:
          description: >
            Amount collected on the invoice generated at account creation, if
            applicable.
          format: decimal
          type: string
        paymentId:
          description: >
            ID of the payment collected on the invoice generated at account
            creation, if applicable.
          type: string
        paymentMethodId:
          description: >
            ID of the payment method that was set up at account creation, which
            automatically becomes the default payment method for this account.
          type: string
        shipToContactId:
          description: |
            The ID of the ship-to contact.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact.
          type: string
        subscriptionId:
          description: >
            ID of the subscription that was set up at account creation, if
            applicable.
          type: string
        subscriptionNumber:
          description: >
            Number of the subscription that was set up at account creation, if
            applicable.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        totalContractedValue:
          description: |
            Total contracted value of the subscription.
          format: decimal
          type: string
      type: object
    GETAccountTypeBasicInfo:
      allOf:
        - properties:
            accountNumber:
              description: |
                Account number.
              type: string
            batch:
              description: >
                The alias name given to a batch. A string of 50 characters or
                less.
              type: string
            communicationProfileId:
              description: >-
                The ID of the communication profile that this account is linked
                to.
              type: string
            creditMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the credit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08a6246fdf101626b1b3fe0144b.
              type: string
            crmId:
              description: |
                CRM account ID for the account, up to 100 characters.
              type: string
            customerServiceRepName:
              description: >
                Name of the account's customer service representative, if
                applicable.
              maxLength: 50
              type: string
            debitMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the debit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08d62470a8501626b19d24f19e2.
              type: string
            id:
              description: |
                Account ID.
              type: string
            invoiceTemplateId:
              description: >
                Invoice template ID, configured in Billing Settings in the Zuora
                UI.
              type: string
              nullable: true
            lastMetricsUpdate:
              description: >
                The date and time when account metrics are last updated, if the
                account is a partner account.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account" target="_blank">Reseller Account</a> feature enabled.
                  - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response. 
                  - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.
                       
              format: date-time
              type: string
            name:
              description: |
                Account name.
              type: string
            notes:
              description: |
                Notes associated with the account, up to 65,535 characters.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            parentId:
              description: >-
                Identifier of the parent customer account for this Account
                object. The length is 32 characters. Use this field if you have
                <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
                target="_blank">Customer Hierarchy</a> enabled.
              type: string
            partnerAccount:
              description: >
                Whether the customer account is a partner, distributor, or
                reseller. 



                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"
                target="_blank">Reseller Account</a> feature enabled.
              type: boolean
            profileNumber:
              description: >-
                The number of the communication profile that this account is
                linked to.
              type: string
            purchaseOrderNumber:
              description: >-
                The purchase order number provided by your customer for
                services, products, or both purchased.
              type: string
            salesRep:
              description: >-
                The name of the sales representative associated with this
                account, if applicable. Maximum of 50 characters.
              type: string
            sequenceSetId:
              description: >
                The ID of the billing document sequence set that is assigned to
                the customer account. 
              type: string
              nullable: true
            summaryStatementTemplateId:
              description: >-
                The summary statement template ID. When a user attempts to
                generate a summary statement from the "Account Summary
                Statement" screen, the system utilizes this template to produce
                the PDF.
              type: string
              nullable: true
            status:
              description: >
                Account status; possible values are: `Active`, `Draft`,
                `Canceled`.
              type: string
            tags:
              description: ''
              type: string
          type: object
        - $ref: '#/components/schemas/AccountObjectNSFields'
        - $ref: '#/components/schemas/AccountObjectCustomFields'
      description: >
        Container for basic information about the account. 


        **Notes**:

        - In the "Retrieve an order" operation, if the `getAccountDetails` query
        parameter is set to `true`, the subscription owner account details
        `subscriptionOwnerAccountDetails` and invoice owner account details
        `existingAccountDetails` will be in the response. 

        - In the "Retrieve a subscription by key" operation, the returned result
        differs based on the following query parameters: 
          - If the `getSubscriptionOwnerDetails` query parameter is set to `true`, the subscription owner account details `accountOwnerDetails` will be in the response.
          - If the `getInvoiceOwnerDetails` query parameter is set to `true`, the invoice owner account details `invoiceOwnerAccountDetails` will be in the response.
          - If both query parameters are set to `true`, the subscription owner account details `accountOwnerDetails` and invoice owner account details `invoiceOwnerAccountDetails` will be in the response.
      title: basicInfo
    GETAccountTypeBillToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                City
              type: string
              maxLength: 100
            country:
              description: >
                Full country name. This field does not contain the ISO-standard
                abbreviation of the country name.
              type: string
              nullable: true
            county:
              description: >-
                Zuora Tax uses this information to calculate county
                taxation.          
              type: string
              maxLength: 100
              nullable: true
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            id:
              description: ID of the person to bill for the account, 32 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact.
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
              nullable: true
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
              nullable: true
            personalEmail:
              description: |
                Personal email address.
              type: string
              maxLength: 80
            state:
              description: >
                Full state name. This field does not contain the ISO-standard
                abbreviation of the state name.
              type: string
              maxLength: 100
            taxRegion:
              description: |
                A region string, defined in your Zuora tax rules.
              type: string
              maxLength: 100
              nullable: true
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: |
        Container for bill-to contact information.
      title: Contact
    GetAccountEInvoiceProfile:
      description: >
        Container for e-invoicing profile information for this account.


        **Note**: This field is available only if you have the <a
        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      allOf:
        - properties:
            businessCategory:
              description: |
                The high-level category of the business.
              type: string
              enum:
                - B2B
                - B2C
                - B2G
            businessName:
              description: >
                The full official name that the Buyer is registered with the
                relevant legal authority.
              maxLength: 255
              type: string
            businessNumber:
              description: >
                The unique identifier number of the legal entity or person that
                you do business with.


                For example, you must use a GSTIN for India.
              type: string
            businessNumberSchemeId:
              description: >
                The identification scheme identifier that an official registrar
                issues to identify the Buyer as a legal entity or person.
              type: string
            enabled:
              description: >
                Whether the e-invoicing profile for the customer account is
                enabled. 


                If the following conditions are met, all billing documents for
                one account can be submitted to an e-invoicing service provider
                to be generated in electronic format:

                - The account must be configured to generate e-invoice files for
                billing documents.

                - The billing document must be in Posted status.

                - A business region must be created for the billing country
                contact, and be linked to an e-invoicing service provider.
              type: boolean
            endpointId:
              description: >
                The Buyer's electronic address, to which the application-level
                response to the billing document might be delivered.
              type: string
            endpointSchemeId:
              description: >
                The identification scheme identifier of the Buyer’s electronic
                address.
              type: string
            taxRegisterNumber:
              description: >
                The Buyer's VAT identifier (also known as the Buyer's VAT
                identification number) or the local identification (defined by
                the Buyer’s address) of the Buyer for tax purposes, or a
                reference that enables the Buyer to state the registered tax
                status.
              type: string
          title: einvoiceProfile
          type: object
        - $ref: '#/components/schemas/EinvoiceObjectCustomFields'
    GETAccountCurrencyMetricsType:
      allOf:
        - properties:
            balance:
              description: |
                The total balance in this currency.
              type: string
            contractedMrr:
              description: >
                The future expected Monthly Recurring Revenue (MRR) in this
                currency, accounting for future upgrades, downgrades, upsells,
                and cancellations.
              format: decimal
              type: string
            currency:
              description: |
                The currency that metrics are aggregated based on.
              type: string
            reservedPaymentAmount:
              description: >
                The reserved payment amount of the customer account in this
                currency. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown"
                target="_blank">Prepaid Cash with Drawdown</a>.
              format: decimal
              type: string
            totalDebitMemoBalance:
              description: >
                The total balance of all posted debit memos in this currency.


                **Note:** This field is only available if you have <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement"
                target="_blank">Invoice Settlement</a> enabled. The Invoice
                Settlement feature is generally available as of Zuora Billing
                Release 296 (March 2021). This feature includes Unapplied
                Payments, Credit and Debit Memo, and Invoice Item Settlement. If
                you want to enable Invoice Settlement, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amount[…]ment/AC_Invoice_Settlement_migration_checklist_and_guide"
                target="_blank">Invoice Settlement Enablement and Checklist
                Guide</a> for more information.
              format: decimal
              type: string
            totalInvoiceBalance:
              description: |
                The total balance of all posted invoices in this currency.
              format: decimal
              type: string
            unappliedCreditMemoAmount:
              description: >
                The total unapplied amount of all posted credit memos in this
                currency.
              format: decimal
              type: string
            unappliedPaymentAmount:
              description: >
                The total unapplied amount of all posted payments in this
                currency.


                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.
              format: decimal
              type: string
          type: object
      title: metricsData
    GetAccountTypeShipToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                City, 40 characters or less.
              type: string
            country:
              description: >
                Full country name. This field does not contain the ISO-standard
                abbreviation of the country name.
              type: string
              nullable: true
            county:
              description: >-
                County; 32 characters or less. Zuora tax uses this information
                to calculate county taxation.          
              type: string
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            id:
              description: >-
                ID of the person who bought the subscription associated with the
                account, 32 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact.
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              maxLength: 80
            state:
              description: >
                Full state name. This field does not contain the ISO-standard
                abbreviation of the state name.
              type: string
            taxRegion:
              description: |
                A region string, defined in your Zuora tax rules.
              type: string
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: >
        Container for ship-to contact information. Uses the same field structure
        as billToContact.
      title: Contact
    GETAccountTypeSoldToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                City, 40 characters or less.
              type: string
            country:
              description: >
                Full country name. This field does not contain the ISO-standard
                abbreviation of the country name.
              type: string
              nullable: true
            county:
              description: >-
                County; 32 characters or less. Zuora tax uses this information
                to calculate county taxation.          
              type: string
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            id:
              description: >-
                ID of the person who bought the subscription associated with the
                account, 32 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact.
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              maxLength: 80
            state:
              description: >
                Full state name. This field does not contain the ISO-standard
                abbreviation of the state name.
              type: string
            taxRegion:
              description: |
                A region string, defined in your Zuora tax rules.
              type: string
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: >
        Container for sold-to contact information. Uses the same field structure
        as billToContact.
      title: Contact
    GETAccountType:
      properties:
        basicInfo:
          $ref: '#/components/schemas/GETAccountTypeBasicInfo'
        billToContact:
          $ref: '#/components/schemas/GETAccountTypeBillToContact'
        billingAndPayment:
          description: Container for billing and payment information for the account.
          properties:
            additionalEmailAddresses:
              description: >
                A list of additional email addresses to receive email
                notifications.
              items:
                type: string
              type: array
            autoPay:
              description: >+
                Whether future payments are automatically collected when they
                are due during a payment run.

              type: boolean
            billCycleDay:
              description: >
                Billing cycle day (BCD), the day of the month when a bill run
                generates invoices for the account.
              format: int64
              type: integer
            bcdSettingOption:
              description: >
                Bill cycle day setting option. Indicates whether the account’s
                bill cycle day is managed manually or automatically.
                  - `ManualSet`: The bill cycle day is explicitly set to a specific day of the month (1–31).
                  - `AutoSet`: The bill cycle day is automatically determined by Zuora. The bill cycle day is assigned when the first subscription is created for the account.

                This field is system-derived and read-only. Its value is
                automatically determined based on the `billCycleDay` field.
              type: string
              enum:
                - ManualSet
                - AutoSet
            currency:
              description: |
                A currency defined in the web-based UI administrative settings.
              type: string
            defaultPaymentMethodId:
              description: |
                ID of the default payment method for the account.
              type: string
            invoiceDeliveryPrefsEmail:
              description: |
                Whether the customer wants to receive invoices through email. 
              type: boolean
            invoiceDeliveryPrefsPrint:
              description: >
                Whether the customer wants to receive printed invoices, such as
                through postal mail.
              type: boolean
            paymentMethodCascadingConsent:
              description: >
                `true` indicates the consent from your customer to use the
                Cascading Payment Method feature was collected. 

                `false` indicates the consent was not collected and the
                Cascading Payment Method feature is not enabled.
              type: boolean
            paymentGateway:
              description: >
                The name of the payment gateway instance. If null or left
                unassigned, the Account will use the Default Gateway.
              type: string
            paymentTerm:
              description: >
                A payment-terms indicator defined in the web-based UI
                administrative settings, e.g., "Net 30".
              type: string
          type: object
        einvoiceProfile:
          $ref: '#/components/schemas/GetAccountEInvoiceProfile'
        gatewayRoutingEligible:
          description: >
            Returns `true` if the applicable billing accounts were was processed
            successfully for gateway routing .
          type: boolean
        metrics:
          description: >
            Container for account metrics of the account's default currency. 

            If you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currencies</a> feature enabled, the
            `metricsData` field provides account metrics of different
            currencies.
          properties:
            balance:
              description: |
                The customer's total invoice balance minus credit balance.
              format: decimal
              type: string
            contractedMrr:
              description: >
                Future expected MRR that accounts for future upgrades,
                downgrades, upsells and cancellations.
              format: decimal
              type: string
            creditBalance:
              description: |
                Current credit balance.
              format: decimal
              type: string
            reservedPaymentAmount:
              description: >
                The Reserved Payment Amount of the customer account. 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. 
              format: float
              type: number
            totalDebitMemoBalance:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                Total balance of all posted debit memos.
              format: decimal
              type: string
            totalInvoiceBalance:
              description: |
                Total balance of all posted invoices.
              format: decimal
              type: string
            unappliedCreditMemoAmount:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                Total unapplied amount of all posted credit memos.
              format: decimal
              type: string
            unappliedPaymentAmount:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                Total unapplied amount of all posted payments.
              format: decimal
              type: string
          type: object
        metricsData:
          description: >
            Container for account metrics of different currencies.

            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currencies</a> feature enabled.
          items:
            $ref: '#/components/schemas/GETAccountCurrencyMetricsType'
          type: array
        shipToContact:
          $ref: '#/components/schemas/GetAccountTypeShipToContact'
        soldToContact:
          $ref: '#/components/schemas/GETAccountTypeSoldToContact'
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        taxInfo:
          description: >
            Container for tax exempt information, used to establish the tax
            exempt status of a customer account.
          properties:
            VATId:
              description: |
                EU Value Added Tax ID.
              type: string
            companyCode:
              description: |
                Unique code that identifies a company account in Avalara.
              type: string
            exemptCertificateId:
              description: |
                ID of the customer tax exemption certificate.
              type: string
            exemptCertificateType:
              description: |
                Type of tax exemption certificate that the customer holds.
              type: string
            exemptDescription:
              description: >
                Description of the tax exemption certificate that the customer
                holds.
              type: string
            exemptEffectiveDate:
              description: |
                Date when the customer tax exemption starts.
              format: date
              type: string
            exemptEntityUseCode:
              description: >
                A unique entity use code to apply exemptions in Avalara AvaTax.


                This account-level field is required only when you choose
                Avalara as your tax engine. See [Exempt
                Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for
                more details.
              maxLength: 64
              type: string
            exemptExpirationDate:
              description: |
                Date when the customer tax exemption expires.
              format: date
              type: string
            exemptIssuingJurisdiction:
              description: >
                Jurisdiction in which the customer tax exemption certificate was
                issued.
              type: string
            exemptStatus:
              description: |
                Status of the account tax exemption.
              type: string
          type: object
      type: object
    PUTAccountTypeBillToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            city:
              description: |
                City
              type: string
              maxLength: 100
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the sold-to contact to
                calculate tax. A bill-to contact may be used if no sold-to
                contact is provided.
              type: string
            county:
              description: |
                May optionally be used by Zuora Tax to calculate county tax.
              type: string
              maxLength: 100
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              format: email
              maxLength: 80
            state:
              description: >
                State; must be a valid subregion (state or province) name or
                code. For more information, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                target="_blank">View subregions of a specific country or
                region</a>. If using Zuora Tax, be aware that Zuora Tax requires
                a state (in the US) or province (in Canada) in this field for
                the sold-to contact to calculate tax, and that a bill-to contact
                may be used if no sold-to contact is provided.
              type: string
              maxLength: 100
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              type: string
              maxLength: 100
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: |
        Container for bill-to contact information for this account.
      title: Contact
    PUTAccountEinvoiceProfile:
      allOf:
        - properties:
            businessCategory:
              description: |
                The high-level category of the business.
              type: string
              enum:
                - B2B
                - B2C
                - B2G
            businessName:
              description: >-
                Legal Business Name. The full formal name by which the Buyer is
                registered with the relevant legal authority. 
              maxLength: 255
              type: string
            businessNumber:
              description: >-
                Buyer legal registration identifier. An identifier issued by an
                official registrar that identifies the Buyer as a legal entity
                or person. GSTIN of buyer for India. 
              type: string
            businessNumberSchemeId:
              description: >-
                Business Number Schema Id. The identification scheme identifier
                of the Buyer legal registration identifier. 
              type: string
            enabled:
              description: >-
                Enable e-invoice for the account. All invoices generated from
                this account can be submitted to generate e-invoices when
                invoices meet the conditions: A business region must be created
                for the billing country contact, and it must be linked to a
                service provider. The account must be enabled to generate
                e-invoices. The invoice must be in the "Posted" status. 
              type: boolean
            endpointId:
              description: >
                Buyer electronic address.Identifies the Buyer's electronic
                address to which the invoice is delivered.
              type: string
            endpointSchemeId:
              description: 'Buyer electronic address identification scheme identifier. '
              type: string
            taxRegisterNumber:
              description: >
                Buyer VAT identifier. The Buyer's VAT identifier (also known as
                Buyer VAT identification number).
              type: string
          type: object
        - $ref: '#/components/schemas/EinvoiceObjectCustomFields'
      description: >
        Container for profile information for this account.


        **Note**: This field is available only if you have the <a

        href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"

        target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
        enabled.
      title: einvoiceProfile
    UpdateAccountShipToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            city:
              description: |
                City
              type: string
              maxLength: 100
            country:
              description: |
                Country; must be a valid country name or abbreviation.
              type: string
            county:
              description: |
                May optionally be used by Zuora Tax to calculate county tax.
              type: string
              maxLength: 100
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              format: email
              maxLength: 80
            state:
              description: >
                State; must be a valid subregion (state or province) name or
                code. For more information, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                target="_blank">View subregions of a specific country or
                region</a>.
              type: string
              maxLength: 100
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              type: string
              maxLength: 100
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: |
        Container for optional ship-to contact.
      title: Contact
    PUTAccountTypeSoldToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            city:
              description: |
                City, 100 characters or less.
              type: string
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the sold-to contact to
                calculate tax. A bill-to contact may be used if no sold-to
                contact is provided.
              type: string
            county:
              description: >
                County; 100 characters or less. May optionally be used by Zuora
                Tax to calculate county tax.
              type: string
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              type: string
            nickname:
              description: |
                Nickname for this contact
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              type: string
              format: email
              maxLength: 80
            state:
              description: >
                100 characters or less.

                State; must be a valid subregion (state or province) name or
                code. For more information, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                target="_blank">View subregions of a specific country or
                region</a>. If using Zuora Tax, be aware that Zuora Tax 
                requires a state (in the US) or province (in Canada) in this
                field for the sold-to contact to calculate tax, and that a
                bill-to contact may be used if no sold-to contact is provided.
              type: string
            taxRegion:
              description: >
                100 characters or less.

                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              type: string
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: |
        Container for optional sold-to contact.
      title: Contact
    PUTAccountType:
      allOf:
        - properties:
            additionalEmailAddresses:
              description: >
                A list of additional email addresses to receive email
                notifications. Use commas to separate email addresses.
              items:
                type: string
              type: array
            autoPay:
              description: >
                Whether future payments are to be automatically billed when they
                are due. 
              type: boolean
            batch:
              description: >
                The alias name given to a batch. A string of 50 characters or

                less.


                **Note**: By default, you have 50 configurable account batches.
                To increase the limit to 200 batches, you must have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite"
                target="_blank">Performance Booster Elite</a> package.
              type: string
            billCycleDay:
              description: >
                Sets the bill cycle day (BCD) for the charge. The BCD determines

                which day of the month the customer is billed. Values: Any
                activated system-defined bill cycle day （`1`-`31`）
              maxLength: 2
              type: integer
            billToContact:
              $ref: '#/components/schemas/PUTAccountTypeBillToContact'
            billToContactId:
              description: >
                The ID of a contact that will be the bill-to contact of the
                current account. 
              type: string
            communicationProfileId:
              description: >
                The ID of the communication profile that this account is linked
                to.


                You can provide either or both of the `communicationProfileId`
                and `profileNumber` fields.


                If both are provided, the request will fail if they do not refer
                to the same communication profile.
              type: string
            creditMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the credit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08a6246fdf101626b1b3fe0144b.
              type: string
            crmId:
              description: |
                CRM account ID for the account, up to 100 characters.
              type: string
            customerServiceRepName:
              description: >
                Name of the account’s customer service representative, if
                applicable.
              maxLength: 50
              type: string
            debitMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the debit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08d62470a8501626b19d24f19e2.
              type: string
            defaultPaymentMethodId:
              description: |
                ID of the default payment method for the account.

                Values: a valid ID for an existing payment method.
              maxLength: 64
              type: string
            einvoiceProfile:
              $ref: '#/components/schemas/PUTAccountEinvoiceProfile'
            gatewayRoutingEligible:
              default: false
              description: >
                Indicates whether to include the applicable billing accounts to
                gateway routing for controlled adoption. 
              type: boolean
            invoiceDeliveryPrefsEmail:
              description: |
                Whether the customer wants to receive invoices through email. 

                The default value is `false`.
              type: boolean
            invoiceDeliveryPrefsPrint:
              description: >
                Whether the customer wants to receive printed invoices, such as
                through postal mail.


                The default value is `false`.
              type: boolean
            invoiceTemplateId:
              description: >
                Invoice template ID, configured in Billing Settings in the Zuora
                UI.
              type: string
            name:
              description: |
                Account name, up to 255 characters.
              type: string
            notes:
              description: |
                A string of up to 65,535 characters.
              type: string
            parentId:
              description: >-
                Identifier of the parent customer account for this Account
                object. The length is 32 characters. Use this field if you have
                <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
                target="_blank">Customer Hierarchy</a> enabled.
              type: string
            partnerAccount:
              default: false
              description: >
                Whether the customer account is a partner, distributor, or
                reseller. 



                You can set this field to `true` if you have business with
                distributors or resellers, or operating in B2B model to manage
                numerous subscriptions through concurrent API requests. After
                this field is set to `true`, the calculation of account metrics
                is performed asynchronously during operations such as
                subscription creation, order changes, invoice generation, and
                payments.



                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"
                target="_blank">Reseller Account</a> feature enabled.
              type: boolean
            paymentGateway:
              description: >
                The name of the payment gateway instance. If null or left
                unassigned, the Account will use the Default Gateway.
              type: string
            paymentTerm:
              description: >-
                Payment terms for this account. Possible values are `Due Upon
                Receipt`, `Net 30`, `Net 60`, `Net 90`.
              type: string
            profileNumber:
              description: >
                The number of the communication profile that this account is
                linked to.


                You can provide either or both of the `communicationProfileId`
                and `profileNumber` fields.


                If both are provided, the request will fail if they do not refer
                to the same communication profile.
              type: string
            purchaseOrderNumber:
              description: >-
                The purchase order number provided by your customer for
                services, products, or both purchased.
              type: string
            salesRep:
              description: >-
                The name of the sales representative associated with this
                account, if applicable. Maximum of 50 characters.
              type: string
            sequenceSetId:
              description: >
                The ID of the billing document sequence set to assign to the
                customer account. 


                The billing documents to generate for this account will adopt
                the prefix and starting document number configured in the
                sequence set.


                If a customer account has no assigned billing document sequence
                set, billing documents generated for this account adopt the
                prefix and starting document number from the default sequence
                set.
              type: string
              nullable: true
            shipToContact:
              $ref: '#/components/schemas/UpdateAccountShipToContact'
            shipToContactId:
              description: >
                The ID of a contact that will be the ship-to contact of the
                current account.
              type: string
            soldToContact:
              $ref: '#/components/schemas/PUTAccountTypeSoldToContact'
            soldToContactId:
              description: >
                The ID of a contact that will be the sold-to contact of the
                current account. 
              type: string
            tagging:
              description: ''
              type: string
            summaryStatementTemplateId:
              description: >
                The summary statement template ID or number. When a user
                attempts to generate a summary statement from the "Account
                Summary Statement" screen, the system utilizes this template to
                produce the PDF.
              type: string
              nullable: true
            taxInfo:
              description: >
                Container for tax exempt information, used to establish the tax
                exempt status of a customer account.
              properties:
                VATId:
                  description: >
                    EU Value Added Tax ID. 


                    **Note:** This feature is in Limited Availability. If you
                    wish to have access to the feature, submit a request at
                    [Zuora Global Support](https://support.zuora.com).
                  type: string
                companyCode:
                  description: >
                    Unique code that identifies a company account in Avalara.
                    Use this field to calculate taxes based on origin and
                    sold-to addresses in Avalara.


                    **Note:** This feature is in Limited Availability. If you
                    wish to have access to the feature, submit a request at
                    [Zuora Global Support](https://support.zuora.com). 
                  type: string
                exemptCertificateId:
                  description: >
                    ID of the customer tax exemption certificate. Requires Zuora
                    Tax.
                  type: string
                exemptCertificateType:
                  description: >
                    Type of tax exemption certificate that the customer holds.
                    Requires Zuora Tax.
                  type: string
                exemptDescription:
                  description: >
                    Description of the tax exemption certificate that the
                    customer holds. Requires Zuora Tax.
                  type: string
                exemptEffectiveDate:
                  description: >
                    Date when the customer tax exemption starts. Requires Zuora
                    Tax.


                    Format: `yyyy-mm-dd`. Defaults to the current date.
                  format: date
                  type: string
                exemptEntityUseCode:
                  description: >
                    A unique entity use code to apply exemptions in Avalara
                    AvaTax.


                    This account-level field is required only when you choose
                    Avalara as your tax engine. See [Exempt
                    Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for
                    more details.
                  maxLength: 64
                  type: string
                exemptExpirationDate:
                  description: >
                    Date when the customer tax exemption expires. Requires Zuora
                    Tax.


                    Format: `yyyy-mm-dd`. Defaults to the current date.
                  format: date
                  type: string
                exemptIssuingJurisdiction:
                  description: >
                    Jurisdiction in which the customer tax exemption certificate
                    was issued.
                  type: string
                exemptStatus:
                  description: >
                    Status of the account tax exemption. Requires Zuora Tax.


                    Required if you use Zuora Tax. This field is unavailable if
                    Zuora Tax is not used.


                    Values: `Yes`, `No`(default), `pendingVerification`. Note
                    that the value will be set to `No` if no input.
                  type: string
              type: object
          type: object
        - $ref: '#/components/schemas/AccountObjectNSFields'
        - $ref: '#/components/schemas/AccountObjectCustomFields'
      example:
        billCycleDay: 1
    DeleteAccountResponseType:
      properties:
        id:
          description: |
            The ID of the deleted account.
          type: string
        jobId:
          description: >
            The ID of the job that handles the account deletion operation. 


            You can specify the value of this field as the value of the `jobId`
            path parameter in the [Retrieve an operation
            job](https://developer.zuora.com/api-references/api/operation/GET_OperationJob/)
            API operation to query job information.
          type: string
        jobStatus:
          description: |
            The status of the account deletion operation. 
          enum:
            - Pending
          type: string
        reasons:
          items:
            properties:
              code:
                description: |
                  The error code of the response.
                type: string
              message:
                description: |
                  The detail information of the error response.
                type: string
            type: object
          type: array
        success:
          description: |
            Whether the call succeeded.
          type: boolean
      type: object
    GETAccountPMAccountHolderInfo:
      description: |
        The account holder information.
      properties:
        accountHolderName:
          description: |
            The full name of the account holder.
          maxLength: 60
          type: string
        addressLine1:
          description: |
            The first line of the address for the account holder.
          type: string
        addressLine2:
          description: |
            The second line of the address for the account holder. 
          type: string
        city:
          description: |
            The city where the account holder stays. 
          type: string
        country:
          description: >
            The country where the account holder stays.


            When creating a payment method through a translated UI or Payment
            Page, a country name in a translated language might be selected.
            Regardless of the country texts selected when creating the payment
            method, only the supported country name returns in this field. For a
            complete list of supported country names, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a>. Internationalization
            is not supported for the API field value.
          type: string
          nullable: true
        email:
          description: |
            The email address of the account holder.
          type: string
        phone:
          description: |
            The phone number of the account holder.
          type: string
        state:
          description: |
            The state where the account holder stays.
          type: string
        zipCode:
          description: |
            The zip code for the address of the account holder.
          type: string
      title: accountHolderInfo
      type: object
    POSTAccountPMMandateInfo:
      description: >
        The mandate information for the Credit Card, Apple Pay, Google Pay,
        Credit Card Reference Transaction, ACH, or Bank Transfer payment method.


        The following mandate fields are common to all supported payment
        methods:

        * `mandateId`

        * `mandateReason`

        * `mandateStatus`


        The following mandate fields are specific to the ACH and Bank Transfer
        payment methods:

        * `mandateReceivedStatus`

        * `existingMandateStatus`

        * `mandateCreationDate`

        * `mandateUpdateDate`


        The following mandate fields are specific to the Credit Card, Apple Pay,
        and Google Pay payment methods:

        * `mitTransactionId`

        * `mitProfileAgreedOn`

        * `mitConsentAgreementRef`

        * `mitConsentAgreementSrc`

        * `mitProfileType`

        * `mitProfileAction`
      properties:
        existingMandateStatus:
          description: |
            Indicates whether the mandate is an existing mandate.
          enum:
            - 'Yes'
            - 'No'
          type: string
        mandateCreationDate:
          description: |
            The date on which the mandate was created.
          format: date
          type: string
        mandateId:
          description: |
            The mandate ID.
          type: string
        mandateReason:
          description: |
            The reason of the mandate from the gateway side.
          type: string
        mandateReceivedStatus:
          description: |
            Indicates whether the mandate is received from the gateway
          enum:
            - 'Yes'
            - 'No'
          type: string
        mandateStatus:
          description: |
            The status of the mandate from the gateway side.
          type: string
        mandateUpdateDate:
          description: |
            The date on which the mandate was updated.
          format: date
          type: string
        mitConsentAgreementRef:
          description: >
            Reference for the consent agreement that you have established with
            the customer.  
          type: string
        mitConsentAgreementSrc:
          description: >
            Required if you set the `mitProfileAction` field. Specify how the
            consent agreement has been established with the customer. The
            allowed value is `External`. If you do not specify the
            `mitProfileAction` field, Zuora will automatically create a stored
            credential profile for the payment method, with the default value
            `External` set to this field.
          enum:
            - External
          type: string
        mitProfileAction:
          description: >
            Specifies how Zuora creates and activates the stored credential
            profile. Only applicable if you set the `status` field to `Active`.


            * `Activate` (default) - Use this value if you are creating the
            stored credential profile after receiving the customer's consent.

              Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.
              
              If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.


            * `Persist` - Use this value if the stored credential profile
            represents a stored credential profile in an external system. The
            status of the payment method's stored credential profile will be
            `Active`.


            If you do not specify this field, Zuora will automatically create a
            stored credential profile for the payment method, with the default
            value `Activate` set to this field.
          enum:
            - Activate
            - Persist
          type: string
        mitProfileAgreedOn:
          description: >
            The date on which the stored credential profile is agreed. The date
            format is `yyyy-mm-dd`.
          format: date
          type: string
        mitProfileType:
          description: >
            Indicates the type of the stored credential profile. If you do not
            specify the `mitProfileAction` field, Zuora will automatically
            create a stored credential profile for the payment method, with the
            default value `Recurring` set to this field.
          type: string
        mitTransactionId:
          description: >
            Specifies the ID of the transaction. Only applicable if you set the
            `mitProfileAction` field to `Persist`.
          maxLength: 128
          type: string
      title: mandateInfo
      type: object
    PaymentMethodObjectCustomFieldsForAccount:
      additionalProperties:
        description: >
          Custom fields of the payment method. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a payment method object.
      title: paymentMethodFieldsCustom
      type: object
    GETPaymentMethodResponseBankTransferForAccount:
      properties:
        IBAN:
          description: >
            The International Bank Account Number used to create the SEPA
            payment method. The value is masked.
          type: string
        accountNumber:
          description: |
            The number of the customer's bank account and it is masked.
          type: string
        bankCode:
          description: >
            The sort code or number that identifies the bank. This is also known
            as the sort code.         
          type: string
        bankTransferType:
          description: |
            The type of the Bank Transfer payment method. For example, `SEPA`.
          type: string
        branchCode:
          description: |
            The branch code of the bank used for Direct Debit.
          type: string
        businessIdentificationCode:
          description: |
            The BIC code used for SEPA. The value is masked.       
          type: string
        identityNumber:
          description: |
            The identity number of the account holder or the cardholder.
          type: string
      type: object
    GETPaymentMethodResponseACHForAccount:
      properties:
        bankABACode:
          description: >
            The nine-digit routing number or ABA number used by banks. This
            field is only required if the `type` field is set to `ACH`.
          type: string
        bankAccountName:
          description: >
            The name of the account holder, which can be either a person or a
            company. This field is only required if the `type` field is set to
            `ACH`.
          type: string
      type: object
    GETPaymentMethodResponseCreditCardForAccount:
      properties:
        cardNumber:
          description: >
            The masked credit card number.


            When `cardNumber` is `null`, the following fields will not be
            returned:
              - `expirationMonth`
              - `expirationYear`
              - `accountHolderInfo`
          type: string
        expirationMonth:
          description: |
            One or two digits expiration month (1-12).
          type: integer
        expirationYear:
          description: |
            Four-digit expiration year.
          type: integer
        securityCode:
          description: |
            The CVV or CVV2 security code for the credit card or debit card.
                        Only required if changing expirationMonth, expirationYear, or cardHolderName.
                        To ensure PCI compliance, this value isn''t stored and can''t be queried. 
          type: string
      type: object
    GETPaymentMethodResponsePayPalForAccount:
      properties:
        BAID:
          description: |
            ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.
          type: string
        email:
          description: |
            Email address associated with the PayPal payment method. 
          type: string
        preapprovalKey:
          description: |
            The PayPal preapproval key.                
          type: string
      type: object
    GETPaymentMethodResponseGooglePayForAccount:
      properties:
        googleBIN:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
        googleCardNumber:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
        googleCardType:
          description: >
            This field is only available for Google Pay payment methods.


            For Google Pay payment methods on Adyen, the first 100 characters of
            [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant)
            returned from Adyen are stored in this field.
          type: string
        googleExpiryDate:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
        googleGatewayToken:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
      type: object
    GETPaymentMethodResponseApplePayForAccount:
      properties:
        appleBIN:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
        appleCardNumber:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
        appleCardType:
          description: >
            This field is only available for Apple Pay payment methods.


            For Apple Pay payment methods on Adyen, the first 100 characters of
            [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant)
            returned from Adyen are stored in this field.
          type: string
        appleExpiryDate:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
        appleGatewayToken:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
      type: object
    GETPaymentMethodResponseForAccount:
      allOf:
        - properties:
            accountHolderInfo:
              $ref: '#/components/schemas/GETAccountPMAccountHolderInfo'
            accountVerificationService:
              description: |
                Displays the name of the service provider. For example, Plaid.
              type: string
            accountVerificationStatus:
              description: >
                Displays the status of the account.

                **Note:** 

                - `Active` - Access token is active. 

                - `Expired` - Access token has expired and must be linked
                again. 

                - `Expiring` - Access token will expire in few days(7 days for
                Plaid) and must be linked again

                - `Inactive` - The end customer has revoked the account
                pemission. The end customer can login again and select the same
                method for the access token to be linked again.
              enum:
                - Active
                - Expired
                - Expiring
                - Inactive
              type: string
            bankIdentificationNumber:
              description: >
                The first six or eight digits of the payment method's number,
                such as the credit card number or account number. Banks use this
                number to identify a payment method.
              type: string
            createdBy:
              description: ID of the user who created this payment method.
              type: string
            createdOn:
              description: >
                The date and time when the payment method was created, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
            creditCardMaskNumber:
              description: >
                The masked credit card number, such as:

                ```

                *********1112

                ```

                **Note:** This field is only returned for Credit Card Reference
                Transaction payment type.
              type: string
            creditCardType:
              description: >
                The type of the credit card or debit card.


                Possible values include `Visa`, `MasterCard`, `AmericanExpress`,
                `Discover`, `JCB`, and `Diners`. For more information about
                credit card types supported by different payment gateways, see
                [Supported Payment
                Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).


                **Note:** This field is only returned for the Credit Card and
                Debit Card payment types.
              type: string
            deviceSessionId:
              description: >
                The session ID of the user when the `PaymentMethod` was created
                or updated.
              type: string
            existingMandate:
              description: |
                Indicates whether the mandate is an existing mandate.
              enum:
                - 'Yes'
                - 'No'
              type: string
            id:
              description: |
                The payment method ID.
              type: string
            ipAddress:
              description: >
                The IP address of the user when the payment method was created
                or updated.
              type: string
            isDefault:
              description: >
                Indicates whether this payment method is the default payment
                method for the account.
              type: boolean
            lastFailedSaleTransactionDate:
              description: >
                The date of the last failed attempt to collect payment with this
                payment method.
              format: date-time
              type: string
            lastTransaction:
              description: Indicates the occurrence and status of the last transaction.
              type: string
            lastTransactionTime:
              description: >-
                The time when the last transaction of this payment method
                happened.
              format: date-time
              type: string
            mandateInfo:
              $ref: '#/components/schemas/POSTAccountPMMandateInfo'
            maxConsecutivePaymentFailures:
              description: >
                The number of allowable consecutive failures Zuora attempts with
                the payment method before stopping.
              type: integer
            numConsecutiveFailures:
              description: >
                The number of consecutive failed payments for this payment
                method. It is reset to `0` upon successful payment. 
              format: int32
              type: integer
            paymentRetryWindow:
              description: >
                The retry interval setting, which prevents making a payment
                attempt if the last failed attempt was within the last specified
                number of hours.
              type: integer
            secondTokenId:
              description: >
                A gateway unique identifier that replaces sensitive payment
                method data.


                **Note:** This field is only returned for the Credit Card
                Reference Transaction payment type.
              type: string
            status:
              description: |
                The status of the payment method.
              enum:
                - Active
                - Closed
                - Scrubbed
              type: string
            tokenId:
              description: >
                A gateway unique identifier that replaces sensitive payment
                method data or represents a gateway's unique customer profile.


                **Note:** This field is only returned for the Credit Card
                Reference Transaction payment type.
              type: string
            totalNumberOfErrorPayments:
              description: |
                The number of error payments that used this payment method.
              format: int32
              type: integer
            totalNumberOfProcessedPayments:
              description: |
                The number of successful payments that used this payment method.
              format: int32
              type: integer
            type:
              description: |
                The type of the payment method.
              type: string
              enum:
                - CreditCard
                - CreditCardReferenceTransaction
                - ACH
                - SEPA
                - Betalingsservice
                - Autogiro
                - Bacs
                - Becs
                - Becsnz
                - PAD
                - PayPalCP
                - PayPalEC
                - PayPalNativeEC
                - PayPalAdaptive
                - AdyenApplePay
                - AdyenGooglePay
                - GooglePay
            updatedBy:
              description: ID of the user who made the last update to this payment method.
              type: string
            updatedOn:
              description: >
                The last date and time when the payment method was updated, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
            useDefaultRetryRule:
              description: >
                Indicates whether this payment method uses the default retry
                rules configured in the Zuora Payments settings.
              type: boolean
          type: object
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFieldsForAccount'
        - $ref: '#/components/schemas/GETPaymentMethodResponseBankTransferForAccount'
        - $ref: '#/components/schemas/GETPaymentMethodResponseACHForAccount'
        - $ref: '#/components/schemas/GETPaymentMethodResponseCreditCardForAccount'
        - $ref: '#/components/schemas/GETPaymentMethodResponsePayPalForAccount'
        - $ref: '#/components/schemas/GETPaymentMethodResponseGooglePayForAccount'
        - $ref: '#/components/schemas/GETPaymentMethodResponseApplePayForAccount'
    CustomAccountPaymentMethod:
      additionalProperties:
        description: >
          Container for custom payment methods created through the [Open Payment
          Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
          service.


          **Note:** The response could return more than one custom payment
          methods.
        title: Custom Payment Method
        type: object
      description: >
        Container for custom payment methods created through the [Open Payment
        Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods)
        service.


        **Note:** The response could return more than one custom payment
        methods.
      title: CustomPaymentMethod
      type: object
    GETAccountPaymentMethodType:
      allOf:
        - properties:
            defaultPaymentMethodId:
              description: |
                ID of the default payment method for the account.
              type: string
            paymentGateway:
              description: >
                The name of the payment gateway instance. If null or left
                unassigned, the Account will use the Default Gateway.
              type: string
            returnedPaymentMethodType:
              description: >
                Container for a specific type of payment method on the customer
                account. For example, `creditcard`, `debitcard`,
                `creditcardreferencetransaction`, `ach`, etc. Each
                `returnedPaymentMethodType` array contains one or more payment
                methods of that payment method type.


                **Note:** The response could return more than one payment method
                type arrays. See **Response samples** as an example.
              items:
                $ref: '#/components/schemas/GETPaymentMethodResponseForAccount'
              title: Payment Method Type
              type: array
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
          type: object
        - $ref: '#/components/schemas/CustomAccountPaymentMethod'
    GetCascadingPaymentMethodsConfigurationResponse:
      properties:
        consent:
          type: boolean
          description: >
            `true` indicates the consent from your customer to use the Cascading
            Payment Method feature was collected. `false` indicates the consent
            was not collected and the Cascading Payment Method feature is not
            enabled.
        priorities:
          type: array
          description: |
            Container for the priority configuration of payment methods. 
          items:
            type: object
            properties:
              paymentMethodId:
                type: string
                description: |
                  The ID of a payment method.
                nullable: true
              order:
                type: integer
                minimum: 1
                description: >
                  The order of the payment method in the priority list. For
                  example, `1` indicates the payment method is the first one in
                  the priority list, and `2` indicates it is the second.


                  The first payment method in the priority list is the default
                  payment method of the customer account.
          title: priority
        success:
          type: boolean
          description: |
            Indicates whether the call succeeded.
      type: object
    PutCascadingPaymentMethodsConfigurationRequest:
      properties:
        consent:
          type: boolean
          description: >
            `true` indicates that you have collected consent from your customer
            to use the Cascading Payment Method feature. `false` indicates the
            consent was not collected and the Cascading Payment Method feature
            is not enabled.


            The `priorities` field can be specified only if `consent` is `true`.
        priorities:
          type: array
          description: >
            Container for the priority configuration of payment methods. You can
            add up to three payment methods to this container. For more
            information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/B2_Cascade_payment_methods"
            target="_blank">Cascade payment methods</a>.


            `priorities` is required if `consent` is `true`.
          items:
            type: object
            properties:
              paymentMethodId:
                type: string
                description: |
                  The ID of a payment method.
              order:
                type: integer
                minimum: 1
                description: >
                  The order of the payment method in the priority list. For
                  example, `1` indicates the payment method is the first one in
                  the priority list, and `2` indicates it is the second.


                  The first payment method in the priority list will be the
                  default payment method of the customer account.
            required:
              - paymentMethodId
              - order
          title: priority
      type: object
      example:
        consent: true
        priorities:
          - paymentMethodId: 2c92c0f95be68649015bf14e001f2760
            order: 1
          - paymentMethodId: 2c92c0f95be68649015bf14e001f2761
            order: 2
          - paymentMethodId: 2c92c0f95be68649015bf14e001f2762
            order: 3
    GETAccountSummaryTypeBasicInfo:
      allOf:
        - properties:
            accountNumber:
              description: |
                Account number.
              type: string
            additionalEmailAddresses:
              description: >
                A list of additional email addresses to receive email
                notifications.
              items:
                type: string
              type: array
            autoPay:
              description: >
                Whether future payments are automatically collected when they
                are due during a payment run.
              type: boolean
            balance:
              description: |
                Current outstanding balance.
              format: decimal
              type: string
            batch:
              description: >
                The alias name given to a batch. A string of 50 characters or
                less.
              type: string
            billCycleDay:
              description: >
                Billing cycle day (BCD), the day of the month when a bill run
                generates invoices for the account.
              type: string
            bcdSettingOption:
              description: >
                Bill cycle day setting option. Indicates whether the account’s
                bill cycle day is managed manually or automatically.
                  - `ManualSet`: The bill cycle day is explicitly set to a specific day of the month (1–31).
                  - `AutoSet`: The bill cycle day is automatically determined by Zuora. The bill cycle day is assigned when the first subscription is created for the account.

                  This field is system-derived and read-only. Its value is automatically determined based on the `billCycleDay` field.
              type: string
              enum:
                - ManualSet
                - AutoSet
            currency:
              description: |
                A currency as defined in Billing Settings in the Zuora UI.
              type: string
            defaultPaymentMethod:
              description: |
                Information of the default payment method for the account.
              properties:
                creditCardExpirationMonth:
                  description: |
                    Two-digit numeric card expiration month as `mm`.
                  type: string
                creditCardExpirationYear:
                  description: |
                    Four-digit card expiration year as `yyyy`.
                  type: string
                creditCardNumber:
                  description: >
                    Credit card number, 16 characters or less, displayed in
                    masked format (e.g., ************1234).
                  type: string
                creditCardType:
                  description: >
                    The type of the credit card.


                    Possible values  include `Visa`, `MasterCard`,
                    `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more
                    information about credit card types supported by different
                    payment gateways, see [Supported Payment
                    Methods](https://knowledgecenter.zuora.com/Zuora_Central/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods).
                  type: string
                id:
                  description: >
                    ID of the default payment method associated with this
                    account.
                  type: string
                paymentMethodType:
                  description: >
                    Type of the payment method. For non-Credit-Card payment
                    methods, only the `id` and `paymentMethodType` fields are
                    returned.
                  type: string
                  enum:
                    - CreditCard
                    - CreditCardReferenceTransaction
                    - ACH
                    - BankTransfer
                    - PayPal
                    - AdyenApplePay
                    - AdyenGooglePay
                    - GooglePay
              type: object
            id:
              description: |
                Account ID.
              type: string
            invoiceDeliveryPrefsEmail:
              description: |
                Whether the customer wants to receive invoices through email. 
              type: boolean
            invoiceDeliveryPrefsPrint:
              description: >
                Whether the customer wants to receive printed invoices, such as
                through postal mail.
              type: boolean
            lastInvoiceDate:
              description: >
                Date of the most recent invoice for the account; null if no
                invoice has ever been generated.
              format: date
              type: string
            lastMetricsUpdate:
              description: >
                The date and time when account metrics are last updated, if the
                account is a partner account.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account" target="_blank">Reseller Account</a> feature enabled.
                  - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response. 
                  - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated.
                  
              format: date-time
              type: string
            lastPaymentAmount:
              description: >
                Amount of the most recent payment collected for the account;
                null if no payment has ever been collected.
              format: decimal
              type: string
            lastPaymentDate:
              description: >
                Date of the most recent payment collected for the account. Null
                if no payment has ever been collected.
              format: date
              type: string
            name:
              description: |
                Account name.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            partnerAccount:
              description: >
                Whether the customer account is a partner, distributor, or
                reseller. 



                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"
                target="_blank">Reseller Account</a> feature enabled.
              type: boolean
            paymentMethodCascadingConsent:
              description: >
                `true` indicates the consent from your customer to use the
                Cascading Payment Method feature was collected. 

                `false` indicates the consent was not collected and the
                Cascading Payment Method feature is not enabled.
              type: boolean
            purchaseOrderNumber:
              description: >-
                The purchase order number provided by your customer for
                services, products, or both purchased.
              type: string
            status:
              description: >
                Account status; possible values are: `Active`, `Draft`,
                `Canceled`.
              type: string
            tags:
              description: ''
              type: string
          type: object
        - $ref: '#/components/schemas/AccountObjectNSFields'
        - $ref: '#/components/schemas/AccountObjectCustomFields'
      description: |
        Container for basic information about the account.
      title: basicInfo
    GETAccountSummaryTypeBillToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                City, 40 characters or less.
              type: string
            country:
              description: >
                Full country name. This field does not contain the ISO-standard
                abbreviation of the country name.
              type: string
              nullable: true
            county:
              description: >-
                County; 32 characters or less. Zuora Tax uses this information
                to calculate county taxation.          
              type: string
              nullable: true
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            id:
              description: |
                Contact ID.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            state:
              description: >
                Full state name. This field does not contain the ISO-standard
                abbreviation of the state name.
              type: string
            taxRegion:
              description: |
                A region string, defined in your Zuora tax rules.
              type: string
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: |
        Container for bill-to contact information. 

        **Notes**: 
          - If the bill-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the bill-to contact on the subscription, see <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Leverage_advanced_capabilities/Flexible_Billing/Flexible_Billing_Attributes/A_Overview_of_Flexible_Billing_Attributes#Billing_attributes_for_this_feature" target="_blank">Overview of Flexible Billing Attributes</a>.
          - If the bill-to contact is not specified on the subscription, the bill-to contact on the invoice owner account will be populated in this field.
      title: Contact
    GETAccountSummaryInvoiceType:
      properties:
        amount:
          description: |
            Invoice amount before adjustments, discounts, and similar items.
          type: number
        balance:
          description: |
            Balance due on the invoice.
          format: decimal
          type: string
        dueDate:
          description: |
            Due date as `yyyy-mm-dd`.
          format: date
          type: string
        id:
          description: |
            Invoice ID.
          type: string
        invoiceDate:
          description: |
            Invoice date as `yyyy-mm-dd`.
          format: date
          type: string
        invoiceNumber:
          description: |
            Invoice number.
          type: string
        status:
          description: >
            Invoice status - not the payment status of the invoice, just the
            status of the invoice itself. Possible values are: `Posted`,
            `Draft`, `Canceled`, `Error`.
          type: string
      title: invoices
      type: object
    GETAccountSummaryPaymentInvoiceType:
      properties:
        appliedPaymentAmount:
          description: |
            Amount of payment applied to the invoice.
          format: decimal
          type: string
        invoiceId:
          description: |
            Invoice ID.
          type: string
        invoiceNumber:
          description: |
            Invoice number.
          type: string
      title: paidInvoices
      type: object
    GETAccountSummaryPaymentType:
      properties:
        effectiveDate:
          description: |
            Effective date as `yyyy-mm-dd`.
          format: date
          type: string
        id:
          description: |
            Payment ID.
          type: string
        paidInvoices:
          description: |
            Container for paid invoices for this subscription.
          items:
            $ref: '#/components/schemas/GETAccountSummaryPaymentInvoiceType'
          type: array
        paymentNumber:
          description: |
            Payment number.
          type: string
        paymentType:
          description: |
            Payment type; possible values are: `External`, `Electronic`.
          type: string
        status:
          description: >
            Payment status. Possible values are: `Draft`, `Processing`,
            `Processed`, `Error`, `Voided`, `Canceled`, `Posted`.
          type: string
      title: payments
      type: object
    GetAccountSummaryTypeShipToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                City, 40 characters or less.
              type: string
            country:
              description: >
                Full country name. This field does not contain the ISO-standard
                abbreviation of the country name.
              type: string
              nullable: true
            county:
              description: >-
                County; 32 characters or less. Zuora Tax uses this information
                to calculate county taxation.          
              type: string
              nullable: true
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            id:
              description: |
                Contact ID.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            state:
              description: >
                Full state name. This field does not contain the ISO-standard
                abbreviation of the state name.
              type: string
            taxRegion:
              description: |
                A region string, defined in your Zuora tax rules.
              type: string
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: |
        Container for ship-to contact information.

        **Notes**: 
          - If the ship-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the ship-to contact on the subscription, see <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Leverage_advanced_capabilities/Flexible_Billing/Flexible_Billing_Attributes/A_Overview_of_Flexible_Billing_Attributes#Billing_attributes_for_this_feature" target="_blank">Overview of Flexible Billing Attributes</a>.
          - If the ship-to contact is not specified on the subscription, the ship-to contact on the subscription owner account will be populated in this field.
      title: Contact
    GETAccountSummaryTypeSoldToContact:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                City, 40 characters or less.
              type: string
            country:
              description: >
                Full country name. This field does not contain the ISO-standard
                abbreviation of the country name.
              type: string
              nullable: true
            county:
              description: >-
                County; 32 characters or less. Zuora Tax uses this information
                to calculate county taxation.          
              type: string
              nullable: true
            fax:
              description: |
                Fax phone number, 40 characters or less.
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              type: string
            id:
              description: |
                Contact ID.
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              type: string
            state:
              description: >
                Full state name. This field does not contain the ISO-standard
                abbreviation of the state name.
              type: string
            taxRegion:
              description: |
                A region string, defined in your Zuora tax rules.
              type: string
            workEmail:
              description: |
                Work email address, 80 characters or less.
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      description: |
        Container for sold-to contact information. 

        **Notes**: 
          - If the sold-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the sold-to contact on the subscription, see <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Leverage_advanced_capabilities/Flexible_Billing/Flexible_Billing_Attributes/A_Overview_of_Flexible_Billing_Attributes#Billing_attributes_for_this_feature" target="_blank">Overview of Flexible Billing Attributes</a>.
          - If the sold-to contact is not specified on the subscription, the sold-to contact on the subscription owner account will be populated in this field.
      title: Contact
    GETAccountSummarySubscriptionRatePlanType:
      properties:
        productId:
          description: |
            Product ID.
          type: string
        productName:
          description: |
            Product name.
          type: string
        productRatePlanId:
          description: |
            Product Rate Plan ID.
          type: string
        productSku:
          description: ''
          type: string
        ratePlanName:
          description: |
            Rate plan name.
          type: string
      title: ratePlans
      type: object
    GETAccountSummarySubscriptionType:
      allOf:
        - properties:
            autoRenew:
              description: >
                If `true`, auto-renew is enabled. If `false`, auto-renew is
                disabled.
              type: boolean
            id:
              description: |
                Subscription ID.
              type: string
            initialTerm:
              description: |
                Duration of the initial subscription term in whole months. 
              type: string
            ratePlans:
              description: |
                Container for rate plans for this subscription.
              items:
                $ref: '#/components/schemas/GETAccountSummarySubscriptionRatePlanType'
              type: array
            renewalTerm:
              description: |
                Duration of the renewal term in whole months.
              type: string
            status:
              description: >
                Subscription status; possible values are: `Draft`,
                `PendingActivation`, `PendingAcceptance`, `Active`, `Cancelled`,
                `Expired`.
              type: string
            subscriptionNumber:
              description: |
                Subscription Number.
              type: string
            subscriptionStartDate:
              description: |
                Subscription start date.
              format: date
              type: string
            termEndDate:
              description: >
                End date of the subscription term. If the subscription is
                evergreen, this is either null or equal to the cancellation
                date, as appropriate.
              format: date
              type: string
            termStartDate:
              description: >
                Start date of the subscription term. If this is a renewal
                subscription, this date is different than the subscription start
                date.
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectQTFields'
        - $ref: '#/components/schemas/SubscriptionObjectNSFields'
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      title: subscriptions
    GETAccountSummaryUsageType:
      properties:
        quantity:
          description: |
            Number of units used.
          format: decimal
          type: string
        startDate:
          description: >
            The start date of a usage period as `yyyy-mm`. Zuora uses this field
            value to determine the usage date.
          format: date
          type: string
        unitOfMeasure:
          description: >
            Unit by which consumption is measured, as configured in the Billing
            Settings section of the web-based UI.
          type: string
      title: usage
      type: object
    GETAccountSummaryType:
      properties:
        basicInfo:
          $ref: '#/components/schemas/GETAccountSummaryTypeBasicInfo'
        billToContact:
          $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact'
        invoices:
          description: |
            Container for invoices. Only returns the last 6 invoices.
          items:
            $ref: '#/components/schemas/GETAccountSummaryInvoiceType'
          type: array
        payments:
          description: |
            Container for payments. Only returns the last 6 payments.
          items:
            $ref: '#/components/schemas/GETAccountSummaryPaymentType'
          type: array
        shipToContact:
          $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact'
        soldToContact:
          $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact'
        subscriptions:
          description: |
            Container for subscriptions.
          items:
            $ref: '#/components/schemas/GETAccountSummarySubscriptionType'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        taxInfo:
          description: >
            Container for tax exempt information, used to establish the tax
            exempt status of a customer account.
          properties:
            VATId:
              description: |
                EU Value Added Tax ID.
              type: string
            companyCode:
              description: |
                Unique code that identifies a company account in Avalara.
              type: string
            exemptCertificateId:
              description: |
                ID of the customer tax exemption certificate.
              type: string
            exemptCertificateType:
              description: |
                Type of tax exemption certificate that the customer holds.
              type: string
            exemptDescription:
              description: >
                Description of the tax exemption certificate that the customer
                holds.
              type: string
            exemptEffectiveDate:
              description: |
                Date when the customer tax exemption starts.
              format: date
              type: string
            exemptEntityUseCode:
              description: >
                A unique entity use code to apply exemptions in Avalara AvaTax.


                This account-level field is required only when you choose
                Avalara as your tax engine. See [Exempt
                Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for
                more details.
              maxLength: 64
              type: string
            exemptExpirationDate:
              description: |
                Date when the customer tax exemption expires.
              format: date
              type: string
            exemptIssuingJurisdiction:
              description: >
                Jurisdiction in which the customer tax exemption certificate was
                issued.
              type: string
            exemptStatus:
              description: |
                Status of the account tax exemption.
              type: string
          type: object
        usage:
          description: >
            Container for usage data. Only returns the last 6 months of usage.


            **Note:** If the Active Rating feature is enabled, no usage data is
            returned in the response body field.
          items:
            $ref: '#/components/schemas/GETAccountSummaryUsageType'
          type: array
      type: object
    POSTContactType:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with the contact. 


                **Note**: When creating a contact, you must specify
                `accountNumber`, `accountId`, or both in the request body. If
                both fields are specified, they must correspond to the same
                account.
              type: string
            accountNumber:
              description: >
                The number of the customer account associated with the contact. 


                **Note**: When creating a contact, you must specify
                `accountNumber`, `accountId`, or both in the request body. If
                both fields are specified, they must correspond to the same
                account.
              type: string
            address1:
              description: >
                The first line of the contact's address, which is often a street
                address or business name.
              maxLength: 255
              type: string
            address2:
              description: |
                The second line of the contact's address.
              maxLength: 255
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                The city of the contact's address.
              maxLength: 100
              type: string
            contactDescription:
              description: |
                A description for the contact.
              maxLength: 100
              type: string
            country:
              description: >
                The country of the contact's address. Either a full name or an
                ISO code is supported.
              maxLength: 64
              type: string
            county:
              description: >
                The county. May optionally be used by Zuora Tax to calculate
                county tax.
              maxLength: 100
              type: string
            fax:
              description: |
                The contact's fax number.
              maxLength: 40
              type: string
            firstName:
              description: |
                The contact's first name.
              maxLength: 100
              type: string
            homePhone:
              description: |
                The contact's home phone number.
              maxLength: 40
              type: string
            lastName:
              description: |
                The contact's last name.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                The mobile phone number of the contact.
              maxLength: 100
              type: string
            nickname:
              description: |
                A nickname for the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: |
                An additional phone number for the contact.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                The type of the additional phone number.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                The contact's personal email address.
              maxLength: 80
              type: string
              format: email
            state:
              description: >
                The state or province of the contact's address. Either a full
                name or an abbreviation code is supported.
              maxLength: 100
              type: string
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              maxLength: 100
              type: string
            workEmail:
              description: |
                The contact's business email address.
              maxLength: 80
              type: string
            workPhone:
              description: |
                The contact's business phone number.
              maxLength: 40
              type: string
            zipCode:
              description: |
                The zip code for the contact's address.
              maxLength: 20
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      example:
        accountId: 6e767220676e6e61206776652075207570
        accountNumber: A00000001
        address1: 314, Bongora
        address2: near Tech City
        city: GHY
        contactDescription: This is a description for the contact
        country: India
        fax: '6174'
        firstName: Kuhi
        homePhone: '1234123'
        lastName: Das
        mobilePhone: '123213'
        nickname: Dorimi
        otherPhone: '2314213'
        otherPhoneType: Work
        personalEmail: kuhiroll@example.com
        state: Assam
        zipCode: '123456'
    ContactResponse:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the account associated with the contact.
              type: string
            accountNumber:
              description: |
                The number of the customer account associated with the contact.
              type: string
            address1:
              description: >
                The first line of the contact's address, which is often a street
                address or business name.
              maxLength: 255
              type: string
            address2:
              description: |
                The second line of the contact's address.
              maxLength: 255
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                The city of the contact's address.
              maxLength: 40
              type: string
            contactDescription:
              description: |
                A description for the contact.
              maxLength: 100
              type: string
            country:
              description: |
                The full country name of the contact's address.
              maxLength: 64
              type: string
            county:
              description: >
                The county. May optionally be used by Zuora Tax to calculate
                county tax.
              maxLength: 32
              type: string
            fax:
              description: |
                The contact's fax number. 
              maxLength: 40
              type: string
            firstName:
              description: |
                The contact's first name.
              maxLength: 100
              type: string
            homePhone:
              description: |
                The contact's home phone number.
              maxLength: 40
              type: string
            lastName:
              description: |
                The contact's last name.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                The mobile phone number of the contact.
              maxLength: 100
              type: string
            nickname:
              description: |
                A nickname for the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: |
                An additional phone number for the contact.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                The type of the additional phone number.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                The contact's personal email address.
              maxLength: 80
              type: string
            state:
              description: |
                The full state or province name of the contact's address.
              maxLength: 40
              type: string
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              maxLength: 32
              type: string
            workEmail:
              description: |
                The contact's business email address.
              maxLength: 80
              type: string
            workPhone:
              description: |
                The contact's business phone number.
              maxLength: 40
              type: string
            zipCode:
              description: |
                The zip code for the contact's address.
              maxLength: 20
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    PUTContactType:
      allOf:
        - properties:
            address1:
              description: >
                The first line of the contact's address, which is often a street
                address or business name.
              maxLength: 255
              type: string
            address2:
              description: |
                The second line of the contact's address.
              maxLength: 255
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                The city of the contact's address.
              maxLength: 100
              type: string
            contactDescription:
              description: |
                A description for the contact.
              maxLength: 100
              type: string
            country:
              description: >
                The country of the contact's address. Either a full name or an
                ISO code is supported.
              maxLength: 64
              type: string
            county:
              description: >
                The county. May optionally be used by Zuora Tax to calculate
                county tax.
              maxLength: 100
              type: string
            fax:
              description: |
                The contact's fax number.
              maxLength: 40
              type: string
            firstName:
              description: |
                The contact's first name.
              maxLength: 100
              type: string
            homePhone:
              description: |
                The contact's home phone number.
              maxLength: 40
              type: string
            lastName:
              description: |
                The contact's last name.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                The mobile phone number of the contact.
              maxLength: 100
              type: string
            nickname:
              description: |
                A nickname for the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: |
                An additional phone number for the contact.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                The type of the additional phone number.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                The contact's personal email address.
              maxLength: 80
              type: string
            state:
              description: >
                The state or province of the contact's address. Either a full
                name or an abbreviation code is supported.
              maxLength: 100
              type: string
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              maxLength: 100
              type: string
            workEmail:
              description: |
                The contact's business email address.
              maxLength: 80
              type: string
            workPhone:
              description: |
                The contact's business phone number.
              maxLength: 40
              type: string
            zipCode:
              description: |
                The zip code for the contact's address.
              maxLength: 20
              type: string
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
      example:
        address1: new Address
        city: Mumbai
        contactDescription: This is the new Description
        mobilePhone: 123213
        zipCode: 123134
    PUTTransferContact:
      type: object
      properties:
        destinationAccountKey:
          description: |
            The ID or number of the destination account.
          type: string
      example:
        destinationAccountKey: A00000135
    ContactSnapshotObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Contact Snapshot object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. For more information, see <a
          href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Custom_fields/Manage_custom_fields_with_the_Object_Manager"
          target="_blank">Manage custom fields</a>.
      description: |
        Container for custom fields of a Contact Snapshot object.
      title: contactSnapshotFieldsCustom
      type: object
    GETContactSnapshotResponse:
      allOf:
        - properties:
            address1:
              description: >
                The first line for the address of the contact, which is often a
                street address or business name.
              type: string
            address2:
              description: >
                The second line for the address of the contact, which is mostly
                the locality.
              type: string
            asBillTo:
              description: >
                Indicates whether the contact can be specified as a bill-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asShipTo:
              description: >
                Indicates whether the contact can be specified as a ship-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            asSoldTo:
              description: >
                Indicates whether the contact can be specified as a sold-to
                contact.


                This field is available only if you have turned on the Ship To
                Contact feature. You can turn on the feature through the
                self-service interface for <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"
                target="_blank">Feature Management</a>.
              type: boolean
            city:
              description: |
                The city for the address of the contact.
              type: string
            contactId:
              description: |
                The Zuora ID of the contact who the snapshot belongs to.
              type: string
            country:
              description: |
                The country for the address of the contact.
              type: string
              nullable: true
            county:
              description: >
                The county for the address of the contact. The field value might
                optionally be used by Zuora Tax to calculate county tax.
              type: string
            description:
              description: |
                A description of the contact.
              type: string
            fax:
              description: |
                The fax number of the contact.
              format: number
              type: string
            firstName:
              description: |
                The first name of the contact.
              type: string
            homePhone:
              description: |
                The home phone number of the contact.
              format: number
              type: string
            id:
              description: |
                The unique ID of the contact snapshot.
              type: string
            lastName:
              description: |
                The last name of the contact.
              type: string
            mobilePhone:
              description: |
                The mobile phone number of the contact.
              format: number
              type: string
            nickname:
              description: |
                A nickname for the contact.
              type: string
            otherPhone:
              description: |
                An additional phone number for the contact.
              type: string
            otherPhoneType:
              description: |
                The type of the additional phone number.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                The personal email address of the contact.
              type: string
              maxLength: 80
            postalCode:
              description: |
                The postal code for the address of the contact.
              format: number
              type: string
            state:
              description: |
                The state or province for the address of the contact.
              type: string
            taxRegion:
              description: |
                If using Zuora Tax rules.
              type: string
            workEmail:
              description: |
                The business email address of the contact.
              type: string
            workPhone:
              description: |
                The business email address of the contact.
              format: number
              type: string
          type: object
        - $ref: '#/components/schemas/ContactSnapshotObjectCustomFields'
    CustomFields:
      additionalProperties:
        description: >
          The name of each custom field has the form
          <code>*customField*__c</code>. Custom field names are case sensitive.
          See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information. 


          The Sign up API is based on Orders. The root element uses the custom
          field defintion on an "Order" object, `accountData` uses the custom
          field defintion on an "Account" object, and `subscriptionData` uses
          the custom field defintion on an "Order Action" object (not on an
          "Subscription" object).
      description: |
        Container for custom fields.
      title: CustomFields
      type: object
    ContactInfo:
      allOf:
        - description: |
            Contact details associated with an account.
          properties:
            address1:
              description: >
                First line of the contact's address. This is often a street
                address or a business name.
              maxLength: 255
              type: string
            address2:
              description: |
                Second line of the contact's address.
              maxLength: 255
              type: string
            city:
              description: |
                City of the contact's address.
              maxLength: 100
              type: string
            contactDescription:
              description: |
                A description for the contact.
              maxLength: 100
              type: string
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                [Zuora
                Tax](https://knowledgecenter.zuora.com/Zuora_Billing/Taxes/A_Zuora_Tax),
                you must specify a country in the bill-to contact to calculate
                tax.
              maxLength: 64
              type: string
            county:
              description: |
                County of the contact's address.
              maxLength: 100
              type: string
            customFields:
              $ref: '#/components/schemas/CustomFields'
            fax:
              description: |
                Fax number of the contact.
              maxLength: 40
              type: string
            firstName:
              description: |
                First name of the contact.
              maxLength: 100
              type: string
            homePhone:
              description: |
                Home phone number of the contact.
              maxLength: 40
              type: string
            lastName:
              description: ''
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                Mobile phone number of the contact.
              maxLength: 40
              type: string
            nickname:
              description: |
                Nickname of the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: >
                Additional phone number of the contact. Use the `otherPhoneType`
                field to specify the type of phone number.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                Specifies the type of phone number in the `otherPhone` field.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                Personal email address of the contact.
              format: email
              maxLength: 80
              type: string
            postalCode:
              description: |
                ZIP code or other postal code of the contact's address.
              maxLength: 20
              type: string
            state:
              description: |
                State or province of the contact's address.
              maxLength: 100
              type: string
            taxRegion:
              description: >
                Region defined in your taxation rules. Only applicable if you
                use Zuora Tax.
              maxLength: 100
              type: string
            workEmail:
              description: |
                Business email address of the contact.
              format: email
              maxLength: 80
              type: string
            workPhone:
              description: |
                Business phone number of the contact.
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - {}
    SignUpCreatePaymentMethodCreditCardReferenceTransaction:
      properties:
        secondTokenId:
          description: |
            The second token id of CreditCardReferenceTransaction.
          type: string
        tokenId:
          description: >
            The token id of payment method, required field of
            CreditCardReferenceTransaction type.
          type: string
      type: object
    SignUpCreatePMPayPalECPayPalNativeEC:
      properties:
        BAID:
          description: |
            ID of a PayPal billing agreement, for example, I-1TJ3GAGG82Y9.
          type: string
        email:
          description: >
            Email address associated with the payment method. This field is only
            supported for PayPal payment methods and is required if you want to
            create any of the following PayPal payment methods:
              - PayPal Express Checkout payment method 
              - PayPal Adaptive payment method
              - PayPal Commerce Platform payment method
          type: string
      type: object
    SignUpCreatePaymentMethodPayPalAdaptive:
      properties:
        preapprovalKey:
          description: |
            The PayPal preapproval key.
          type: string
      type: object
    SignUpCreatePaymentMethodCardholderInfo:
      description: |
        Container for cardholder information. If provided, Zuora will
        only use this information for this card. Otherwise, Zuora will use
        the account''s existing bill-to contact information for this card.
      properties:
        addressLine1:
          description: |
            First address line, 255 characters or less.
          type: string
        addressLine2:
          description: |
            Second address line, 255 characters or less.
          type: string
        cardHolderName:
          description: >
            The card holder's full name as it appears on the card, e.g., "John J
            Smith", 50 characters or less.
          type: string
        city:
          description: |
            City, 40 characters or less.
          type: string
        country:
          description: |
            Country, must be a valid country name or abbreviation.
          type: string
        email:
          description: |
            Card holder's email address, 80 characters or less.
          type: string
        phone:
          description: |
            Phone number, 40 characters or less.
          type: string
        state:
          description: >
            State; must be a valid subregion (state or province) name or code.
            For more information, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
            target="_blank">View subregions of a specific country or region</a>.
          type: string
        zipCode:
          description: |
            Zip code, 20 characters or less.
          type: string
      required:
        - cardHolderName
      title: cardHolderInfo
      type: object
    SignUpCreatePaymentMethodCreditCard:
      properties:
        cardHolderInfo:
          $ref: '#/components/schemas/SignUpCreatePaymentMethodCardholderInfo'
        cardNumber:
          description: |
            Credit card number.
          type: string
        cardType:
          description: >
            The type of the credit card.


            Possible values include `Visa`, `MasterCard`, `AmericanExpress`,
            `Discover`, `JCB`, and `Diners`. For more information about credit
            card types supported by different payment gateways, see [Supported
            Payment
            Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).
          type: string
        checkDuplicated:
          type: boolean
        expirationMonth:
          description: |
            One or two digit expiration month (1-12) of the credit card.
          type: string
        expirationYear:
          description: |
            Four-digit expiration year of the credit card.
          type: string
        mitConsentAgreementRef:
          description: >
            Specifies your reference for the stored credential consent agreement
            that you have established with the customer. Only applicable if you
            set the `mitProfileAction` field.
          maxLength: 128
          type: string
        mitConsentAgreementSrc:
          description: >
            Required if you set the `mitProfileAction` field. Specifies how the
            consent agreement has been established with the customer. The
            allowed value is `External`. If you do not specify the
            `mitProfileAction` field, Zuora will automatically create a stored
            credential profile for the payment method, with the default value
            `External` set to this field.
          enum:
            - External
          type: string
        mitNetworkTransactionId:
          description: >
            Specifies the ID of a network transaction. Only applicable if you
            set the `mitProfileAction` field to `Persist`.
          maxLength: 128
          type: string
        mitProfileAction:
          description: >
            Specifies how Zuora creates and activates the stored credential
            profile. If you do not specify this field, Zuora will automatically
            create a stored credential profile for the payment method, with the
            default value `Activate` set to this field.
          enum:
            - Activate
            - Persist
          type: string
        mitProfileAgreedOn:
          description: >
            The date on which the profile is agreed. The date format is
            `yyyy-mm-dd`.
          format: date
          type: string
        mitProfileType:
          description: >
            Required if you set the `mitProfileAction` field. If you do not
            specify the `mitProfileAction` field, Zuora will automatically
            create a stored credential profile for the payment method, with the
            default value `Recurring` set to this field.
          enum:
            - Recurring
          type: string
        securityCode:
          description: >
            CVV or CVV2 security code of the credit card.


            To ensure PCI compliance, this value is not stored and cannot be
            queried.
          type: string
      type: object
    SignUpCreatePaymentMethodCommon:
      properties:
        accountKey:
          description: >
            Internal ID of the customer account that will own the payment
            method.
          type: string
        authGateway:
          description: >
            Internal ID of the payment gateway that Zuora will use to authorize
            the payments that are made with the payment method.


            If you do not set this field, Zuora will use one of the following
            payment gateways instead:


            * The default payment gateway of the customer account that owns the
            payment method, if the `accountKey` field is set.

            * The default payment gateway of your Zuora tenant, if the
            `accountKey` field is not set.
          type: string
        ipAddress:
          description: >
            The IPv4 or IPv6 information of the user when the payment method is
            created or updated. Some gateways use this field for fraud
            prevention. If this field is passed to Zuora, Zuora directly passes
            it to gateways. 


            If the IP address length is beyond 45 characters, a validation error
            occurs.
          type: string
        makeDefault:
          default: false
          description: >
            Specifies whether the payment method will be the default payment
            method of the customer account that owns the payment method. Only
            applicable if the `accountKey` field is set.
          type: boolean
      type: object
    SignUpPaymentMethodObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the payment method. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a payment method object.
      title: paymentMethodFieldsCustom
      type: object
    SignUpPaymentMethod:
      allOf:
        - properties:
            type:
              description: >
                Type of payment method. The following types of the payment
                method are supported:
              enum:
                - PayPalEC
                - PayPalNativeEC
                - PayPalAdaptive
                - CreditCard
                - CreditCardReferenceTransaction
              type: string
          required:
            - type
          type: object
        - $ref: >-
            #/components/schemas/SignUpCreatePaymentMethodCreditCardReferenceTransaction
        - $ref: '#/components/schemas/SignUpCreatePMPayPalECPayPalNativeEC'
        - $ref: '#/components/schemas/SignUpCreatePaymentMethodPayPalAdaptive'
        - $ref: '#/components/schemas/SignUpCreatePaymentMethodCreditCard'
        - $ref: '#/components/schemas/SignUpCreatePaymentMethodCommon'
        - $ref: '#/components/schemas/SignUpPaymentMethodObjectCustomFields'
    SignUpTaxInfo:
      description: |
        Information about the tax exempt status of a customer account.
      properties:
        VATId:
          description: >
            EU Value Added Tax ID.


            **Note:** This feature is in Limited Availability. If you wish to
            have access to the feature, submit a request at [Zuora Global
            Support](https://support.zuora.com).
          maxLength: 25
          type: string
        companyCode:
          description: >
            Unique code that identifies a company account in Avalara. Use this
            field to calculate taxes based on origin and sold-to addresses in
            Avalara.


            **Note:** This feature is in Limited Availability. If you wish to
            have access to the feature, submit a request at [Zuora Global
            Support](https://support.zuora.com).
          maxLength: 50
          type: string
        exemptCertificateId:
          description: >
            ID of the customer tax exemption certificate. Applicable if you use
            Zuora Tax or Connect tax engines.
          maxLength: 32
          type: string
        exemptCertificateType:
          description: >
            Type of tax exemption certificate that the customer holds.
            Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 32
          type: string
        exemptDescription:
          description: >
            Description of the tax exemption certificate that the customer
            holds. Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 500
          type: string
        exemptEffectiveDate:
          description: >
            Date when the customer tax exemption starts, in YYYY-MM-DD format.
            Applicable if you use Zuora Tax or Connect tax engines.
          format: date
          type: string
        exemptExpirationDate:
          description: >
            Date when the customer tax exemption expires, in YYYY-MM-DD format.
            Applicable if you use Zuora Tax or Connect tax engines.
          format: date
          type: string
        exemptIssuingJurisdiction:
          description: >
            Jurisdiction in which the customer tax exemption certificate was
            issued.
          maxLength: 32
          type: string
        exemptStatus:
          default: 'No'
          description: >
            Status of the account tax exemption. Applicable if you use Zuora Tax
            or Connect tax engines. Required if you use Zuora Tax. 
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
          type: string
      title: taxInfo
      type: object
    AccountData:
      description: >
        The information of the account that you are to create through the "Sign
        up" operation.
      properties:
        accountNumber:
          maxLength: 70
          type: string
        autoPay:
          description: >-
            Specifies whether future payments are to be automatically billed
            when they are due. Possible values are `true`, `false`.
          type: boolean
        batch:
          description: >
            **Note**: By default, you have 50 configurable account batches. To
            increase the limit to 200 batches, you must have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite"
            target="_blank">Performance Booster Elite</a> package.
          type: string
        billCycleDay:
          description: >-
            Day of the month that the account prefers billing periods to begin
            on. If set to 0, the bill cycle day will be set as "AutoSet".
          maximum: 31
          minimum: 0
          type: integer
        billToContact:
          $ref: '#/components/schemas/ContactInfo'
        communicationProfileId:
          type: string
        creditMemoTemplateId:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            The unique ID of the credit memo template, configured in **Billing
            Settings** > **Manage Billing Document Configuration** through the
            Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b.
          type: string
        crmId:
          maxLength: 100
          type: string
        currency:
          description: >
            3 uppercase character currency code.


            **Note**: Specify this field only for a new account to be created;
            do not specify this field to update an existing account.



            For payment method authorization, if the `paymentMethod` >
            `currencyCode` field is specified, `currencyCode` is used.
            Otherwise, this `currency` field is used for payment method
            authorization. If no currency is specified for the account, the
            default currency of the account is then used.
          type: string
        customFields:
          $ref: '#/components/schemas/CustomFields'
        debitMemoTemplateId:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            The unique ID of the debit memo template, configured in **Billing
            Settings** > **Manage Billing Document Configuration** through the
            Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2.
          type: string
        invoiceTemplateId:
          type: string
        name:
          maxLength: 255
          type: string
        notes:
          maxLength: 65535
          type: string
        organizationLabel:
          type: string
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
        paymentMethod:
          $ref: '#/components/schemas/SignUpPaymentMethod'
        paymentTerm:
          type: string
        purchaseOrderNumber:
          description: >
            The number of the purchase order associated with this account.
            Purchase order information generally comes from customers.
          maxLength: 100
          type: string
        sequenceSetId:
          description: >
            The ID of the billing document sequence set to assign to the
            customer account. 


            The billing documents to generate for this account will adopt the
            prefix and starting document number configured in the sequence set.
          type: string
          nullable: true
        shipToContact:
          $ref: '#/components/schemas/ContactInfo'
        soldToContact:
          $ref: '#/components/schemas/ContactInfo'
        taxInfo:
          $ref: '#/components/schemas/SignUpTaxInfo'
      required:
        - billCycleDay
        - billToContact
        - currency
        - name
      type: object
    Options:
      description: Invoice or Payment.
      properties:
        billingTargetDate:
          description: >-
            Date through which to calculate charges if an invoice is generated.
            See [What is a Target
            Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).
          format: date
          type: string
        collectPayment:
          description: >-
            Indicates if the current request needs to collect payments. This
            value can not be 'true' when 'runBilling' flag is 'false'.
          type: boolean
        maxSubscriptionsPerAccount:
          type: number
        runBilling:
          description: >-
            Indicates if the current request needs to generate an invoice. The
            invoice will be generated against all subscriptions included in this
            order.
          type: boolean
      type: object
    PaymentData:
      properties:
        authTransactionId:
          description: |
            The authorization transaction ID from the payment gateway.
          type: string
        authorizedAmount:
          description: >
            The amount that is authorized before this API call. Only used for
            the Delay Capture function.
          format: double
          type: number
        authorizedCurrency:
          description: >-
            The authorization of currency code that occurs before this API call.
            We will verify whether it is same as the account's currency.
          type: string
      type: object
    RatePlan:
      properties:
        customFields:
          $ref: '#/components/schemas/CustomFields'
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
      type: object
    RatePlans:
      items:
        $ref: '#/components/schemas/RatePlan'
      type: array
    TermInfo_initialTerm:
      description: |
        Information about the first term of the subscription.
      properties:
        period:
          description: >
            Duration of the first term in months, years, days, or weeks,
            depending on the value of the `periodType` field. Only applicable if
            the value of the `termType` field is `TERMED`.
          type: integer
        periodType:
          description: >
            Unit of time that the first term is measured in. Only applicable if
            the value of the `termType` field is `TERMED`.
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
        startDate:
          description: |
            Start date of the first term, in YYYY-MM-DD format.
          format: date
          type: string
        termType:
          description: >
            Type of the first term. If the value of this field is `TERMED`, the
            first term has a predefined duration based on the value of the
            `period` field. If the value of this field is `EVERGREEN`, the first
            term does not have a predefined duration.
          enum:
            - TERMED
            - EVERGREEN
          type: string
      required:
        - termType
      type: object
    TermInfo_renewalTerms:
      properties:
        period:
          description: >
            Duration of the renewal term in months, years, days, or weeks,
            depending on the value of the `periodType` field.
          type: integer
        periodType:
          description: |
            Unit of time that the renewal term is measured in.
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
      type: object
    TermInfo:
      description: |
        Container for the terms and renewal settings of the subscription.
      properties:
        autoRenew:
          description: >
            Specifies whether the subscription automatically renews at the end
            of the each term. Only applicable if the type of the first term is
            `TERMED`.
          type: boolean
        initialTerm:
          $ref: '#/components/schemas/TermInfo_initialTerm'
        renewalSetting:
          description: >
            Specifies the type of the terms that follow the first term if the
            subscription is renewed. Only applicable if the type of the first
            term is `TERMED`.


            * `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a predefined
            duration. The first entry in `renewalTerms` specifies the duration
            of the second term of the subscription, the second entry in
            `renewalTerms` specifies the duration of the third term of the
            subscription, and so on. The last entry in `renewalTerms` specifies
            the ultimate duration of each renewal term.

            * `RENEW_TO_EVERGREEN` - The second term of the subscription does
            not have a predefined duration.
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          type: string
        renewalTerms:
          $ref: '#/components/schemas/TermInfo_renewalTerms'
      required:
        - initialTerm
      type: object
    SubscriptionData:
      properties:
        customFields:
          $ref: '#/components/schemas/CustomFields'
        invoiceSeparately:
          description: >
            Specifies whether the subscription appears on a separate invoice
            when Zuora generates invoices.
          type: boolean
        notes:
          description: >
            Notes about the subscription. These notes are only visible to Zuora
            users.
          maxLength: 500
          type: string
        ratePlans:
          $ref: '#/components/schemas/RatePlans'
        startDate:
          format: date
          type: string
        subscriptionNumber:
          description: >
            Subscription number of the subscription to create, for example,
            A-S00000001.


            If you do not set this field, Zuora will generate a subscription
            number.
          maxLength: 100
          type: string
        terms:
          $ref: '#/components/schemas/TermInfo'
      type: object
    SignUpRequest:
      example:
        accountData:
          autoPay: false
          billCycleDay: 15
          billToContact:
            country: US
            firstName: foo
            lastName: bar
            state: California
          currency: USD
          customFields:
            CustomerUserId__c: User_269145114619000
          name: User
          paymentMethod:
            makeDefault: true
            secondTokenId: '010'
            tokenId: User_269145114619000
            type: CreditCardReferenceTransaction
        accountIdentifierField: CustomerUserId__c
        options:
          billingTargetDate: '2021-07-01'
          collectPayment: true
          maxSubscriptionsPerAccount: 0
          runBilling: true
        subscriptionData:
          invoiceSeparately: false
          ratePlans:
            - productRatePlanId: 4028818284f5f8130184f5fe1a73101f
          startDate: '2021-04-15'
          terms:
            autoRenew: false
            initialTerm:
              period: 6
              periodType: Month
              startDate: '2021-04-15'
              termType: TERMED
            renewalSetting: RENEW_WITH_SPECIFIC_TERM
            renewalTerms:
              - period: 6
                periodType: Month
      properties:
        accountData:
          $ref: '#/components/schemas/AccountData'
        accountIdentifierField:
          description: Specify the name of the field that holds external account id
          type: string
        customFields:
          $ref: '#/components/schemas/CustomFields'
        options:
          $ref: '#/components/schemas/Options'
        paymentData:
          $ref: '#/components/schemas/PaymentData'
        subscriptionData:
          $ref: '#/components/schemas/SubscriptionData'
      type: object
    SignUpResponse_reasons:
      properties:
        code:
          description: |
            The error code of response.
          type: string
        message:
          description: |
            The detail information of the error response
          type: string
      type: object
    SignUpResponse:
      properties:
        accountId:
          description: The account id for the order.
          type: string
        accountNumber:
          description: The account number for the order.
          type: string
        creditMemoId:
          description: >-
            An array of the credit memo id generated in this order request. The
            credit memo is only available if you have the Invoice Settlement
            feature enabled.
          type: string
        creditMemoNumber:
          description: >-
            An array of the credit memo numbers generated in this order request.
            The credit memo is only available if you have the Invoice Settlement
            feature enabled.
          type: string
        invoiceId:
          description: The invoice id generated in this order request
          type: string
        invoiceNumber:
          description: The invoice number generated in this order request
          type: string
        orderNumber:
          description: The order number of the order created.
          type: string
        paidAmount:
          description: The total amount collected in this order request.
          type: string
        paymentId:
          description: The payment id that is collected in this order request.
          type: string
        paymentNumber:
          description: The payment number that is collected in this order request.
          type: string
        processId:
          description: |
            The Id of the process that handles the operation.
          type: string
        reasons:
          items:
            $ref: '#/components/schemas/SignUpResponse_reasons'
          type: array
        status:
          description: >-
            Status of the order. `Pending` is only applicable for an order that
            contains a `CreateSubscription` order action.
          enum:
            - Completed
            - Pending
          type: string
        subscriptionId:
          description: The subscription id of the order.
          type: string
        subscriptionNumber:
          description: The subscription number of the order.
          type: string
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    OrderObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Order object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Order object.
      title: OrderCustomFields
      type: object
    OrderLineItemCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Order Line Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Order Line Item object.
      title: OrderLineItemCustomFields
      type: object
    OrderLineItemCommonPostOrder:
      properties:
        UOM:
          description: |
            Specifies the units to measure usage.
          type: string
        accountingCode:
          description: |
            The accounting code for the Order Line Item.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        amountPerUnit:
          description: >
            The actual charged amount per unit for the Order Line Item.


            If you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          type: number
        billTargetDate:
          description: >
            The target date for the Order Line Item to be picked up by bill run
            for billing.
          format: date
          type: string
        billTo:
          description: >
            The ID of the bill-to contact of an order line item. Specify an
            existing contact under the billing account as the bill-to contact of
            the order line item. The billing account is the order account.


            **Note**: If an order's category is set to **Return** in a return
            Order Line Item, it will inherit the original Order Line Item's
            `billTo` contact automatically. You cannot specify a different
            value.
          type: string
        billingRule:
          default: TriggerWithoutFulfillment
          description: |
            The billing rule for the Order Line Item.
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        currency:
          description: >
            The currency for the order line item. You can specify a currency
            when creating an order line item through the "Create an order"
            operation.
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFields'
        deferredRevenueAccountingCode:
          description: |
            The deferred revenue accounting code for the Order Line Item.
          type: string
        description:
          description: |
            The description of the Order Line Item.
          type: string
          maxLength: 500
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude Order Line Item related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude Order Line Item from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled.
          type: boolean
        inlineDiscountPerUnit:
          description: >
            Use this field in accordance with the `inlineDiscountType` field, in
            the following manner:

            * If the `inlineDiscountType` field is set as `Percentage`, this
            field specifies the discount percentage for each unit of the order
            line item. For exmaple, if you specify `5` in this field, the
            discount percentage is 5%.

            * If the `inlineDiscountType` field is set as `FixedAmount`, this
            field specifies the discount amount on each unit of the order line
            item. For exmaple, if you specify `10` in this field, the discount
            amount on each unit of the order line item is 10.


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          type: number
        inlineDiscountType:
          description: >
            Use this field to specify the inline discount type, which can be
            `Percentage`, `FixedAmount`, or `None`. The default value is
            `Percentage`.


            Use this field together with the `inlineDiscountPerUnit` field to
            specify inline discounts for order line items. The inline discount
            is applied to the list price of an order line item. 


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        itemCategory:
          default: Sales
          description: >
            The category for the Order Line Item, to indicate a product sale or
            return.
          enum:
            - Sales
            - Return
          type: string
        itemName:
          description: |
            The name of the Order Line Item.
          type: string
        itemNumber:
          description: >
            The number of the Order Line Item. Use this field to specify a
            custom item number for your Order Line Item. If you are to use this
            field,  you must set all the item numbers in an order when there are
            several order line items in the order.
          type: string
        itemState:
          description: >
            The state of an Order Line Item. If you want to generate billing
            documents for order line items, you must set this field to
            `SentToBilling`. For invoice preview, you do not need to set this
            field.


            See [State transitions for an order, order line item, and
            fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          description: |
            The type of the Order Line Item. 
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          description: |
            The list price per unit for the Order Line Item.
          type: number
        originalOrderLineItemNumber:
          description: >
            The number of the original sale order line item for a return order
            line item. 
          type: string
        originalOrderNumber:
          description: |
            The number of the original sale order for a return order line item. 
          type: string
        ownerAccountNumber:
          description: >
            Use this field to assign an existing account as the owner of an
            order line item.
          type: string
        productCode:
          description: |
            The product code for the Order Line Item.
          type: string
        productRatePlanChargeId:
          description: >
            ID of a product rate plan charge. Only one-time charges are
            supported.


            If you do not have the **Create Order Line Items Without Product
            Catalog** billing permission, you must specify this field to create
            the order line item from an existing product rate plan charge.
          type: string
        purchaseOrderNumber:
          description: >
            Used by customers to specify the Purchase Order Number provided by
            the buyer.
          type: string
        quantity:
          description: >
            The quantity of units, such as the number of authors in a hosted
            wiki service.
          type: number
        recognizedRevenueAccountingCode:
          description: |
            The recognized revenue accounting code for the Order Line Item.
          type: string
        relatedSubscriptionNumber:
          description: >
            Use this field to relate an order line item to a subscription when
            you create the order line item.


            * To relate an order line item to a new subscription which is yet to
            create in the same "Create an order" call, use this field in
            combination with the `subscriptions` > `subscriptionNumber` field in
            the "Create an order" operation. Specify this field to the same
            value as that of the `subscriptions` > `subscriptionNumber` field
            when you make the "Create an order" call.

            * To relate an order line item to an existing subscription, specify
            this field to the subscription number of the existing subscription.
          type: string
        revenueRecognitionRule:
          description: |
            The Revenue Recognition rule for the Order Line Item.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the order line item.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
          maxLength: 255
          nullable: true
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the order line item.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
        paymentTerm:
          description: |
            The payment term name associated with the order line item.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the order line item.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
        shipTo:
          description: >
            Use this field to assign an existing account as the ship-to contact
            of an order line item, by the following rules:


            * If the `ownerAccountNumber` field is set, then this field must be
            the ID of a contact that belongs to the owner account of the order
            line item. 


            * If the `ownerAccountNumber` field is not set, then this field must
            be the ID of a contact that belongs to the billing account of the
            order line item. The billing account is the order account.



            **Note**: If an order's category is set to **Return** in a return
            Order Line Item, it will inherit the original Order Line Item's
            `shipTo` contact automatically. You cannot specify a different
            value.
          type: string
        soldTo:
          description: >
            Use this field to assign an existing account as the sold-to contact
            of an order line item, by the following rules:


            * If the `ownerAccountNumber` field is set, then this field must be
            the ID of a contact that belongs to the owner account of the order
            line item. 

            * If the `ownerAccountNumber` field is not set, then this field must
            be the ID of a contact that belongs to the billing account of the
            order line item. The billing account is the order account.


            **Note**: If an order's category is set to **Return** in a return
            Order Line Item, it will inherit the original Order Line Item's
            `soldTo` contact automatically. You cannot specify a different
            value.
        taxCode:
          description: |
            The tax code for the Order Line Item.
          type: string
        taxMode:
          description: |
            The tax mode for the Order Line Item.
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          description: >
            The date a transaction is completed. The default value of this field
            is the transaction start date. Also, the value of this field should
            always equal or be later than the value of the
            `transactionStartDate` field.
          format: date
          type: string
        transactionStartDate:
          description: >
            The date a transaction starts. The default value of this field is
            the order date.
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
      title: OrderLineItem
      type: object
    CreateOrderOrderLineItem:
      allOf:
        - $ref: '#/components/schemas/OrderLineItemCommonPostOrder'
    PreviewContactInfo:
      description: |
        Contact details associated with an account.
      properties:
        address1:
          description: >
            First line of the contact's address. This is often a street address
            or a business name.
          maxLength: 255
          type: string
        address2:
          description: |
            Second line of the contact's address.
          maxLength: 255
          type: string
        city:
          maxLength: 100
          type: string
        country:
          description: >-
            Country; must be a valid country name or abbreviation. If using
            Zuora Tax, you must specify a country to calculate tax.
          maxLength: 64
          type: string
        county:
          maxLength: 100
          type: string
        postalCode:
          maxLength: 20
          type: string
        state:
          maxLength: 100
          type: string
        taxRegion:
          maxLength: 100
          type: string
      type: object
    TaxInfo:
      description: |
        Information about the tax exempt status of a customer account.
      properties:
        VATId:
          description: >
            EU Value Added Tax ID.


            **Note:** This feature is in Limited Availability. If you wish to
            have access to the feature, submit a request at [Zuora Global
            Support](https://support.zuora.com).
          maxLength: 25
          type: string
        companyCode:
          description: >
            Unique code that identifies a company account in Avalara. Use this
            field to calculate taxes based on origin and sold-to addresses in
            Avalara.


            **Note:** This feature is in Limited Availability. If you wish to
            have access to the feature, submit a request at [Zuora Global
            Support](https://support.zuora.com).
          maxLength: 50
          type: string
        exemptCertificateId:
          description: >
            ID of the customer tax exemption certificate. Applicable if you use
            Zuora Tax or Connect tax engines.
          maxLength: 32
          type: string
        exemptCertificateType:
          description: >
            Type of tax exemption certificate that the customer holds.
            Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 32
          type: string
        exemptDescription:
          description: >
            Description of the tax exemption certificate that the customer
            holds. Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 500
          type: string
        exemptEffectiveDate:
          description: >
            Date when the customer tax exemption starts, in YYYY-MM-DD format.
            Applicable if you use Zuora Tax or Connect tax engines.
          format: date
          type: string
        exemptExpirationDate:
          description: >
            Date when the customer tax exemption expires, in YYYY-MM-DD format.
            Applicable if you use Zuora Tax or Connect tax engines.
          format: date
          type: string
        exemptIssuingJurisdiction:
          description: >
            Jurisdiction in which the customer tax exemption certificate was
            issued.
          maxLength: 32
          type: string
        exemptStatus:
          default: 'No'
          description: >
            Status of the account tax exemption. Applicable if you use Zuora Tax
            or Connect tax engines. Required if you use Zuora Tax. 
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
          type: string
      title: taxInfo
      type: object
    PreviewAccountInfo:
      description: |
        Information about the account that will own the order.
      properties:
        billCycleDay:
          description: >-
            Day of the month that the account prefers billing periods to begin
            on. If set to 0, the bill cycle day will be set as "AutoSet".
          maximum: 31
          minimum: 0
          type: integer
        currency:
          description: |
            ISO 3-letter currency code (uppercase). For example, USD.
          maxLength: 3
          type: string
        customFields:
          $ref: '#/components/schemas/AccountObjectCustomFields'
        shipToContact:
          $ref: '#/components/schemas/PreviewContactInfo'
        soldToContact:
          $ref: '#/components/schemas/PreviewContactInfo'
        taxInfo:
          $ref: '#/components/schemas/TaxInfo'
      required:
        - currency
        - billCycleDay
      title: previewAccountInfo
      type: object
    PreviewOptions:
      properties:
        previewNumberOfPeriods:
          description: >
            The number of periods to preview when the value of the
            `previewThroughType` field is set to `NumberOfPeriods`.
          minLength: 1
          type: integer
        previewThruType:
          description: >
            The options on how the preview through date is calculated. Available
            for preview only. 

            - If you set this field to `SpecificDate`, you must specify a
            specific date in the `specificPreviewThruDate` field. If you also
            set `billTargetDate` in the `orderLineItems` field, order line items
            whose `billTargetDate` is no later than `specificPreviewThruDate`
            are returned.


            - If you set this field to `NumberOfPeriods`, you must use the
            `previewNumberOfPeriods` field to specify how many periods you want
            to preview. In case the order only contains an order line item but
            not contains a subscription, if you also set `billTargetDate` in the
            `orderLineItems` field, order line items whose `billTargetDate` is
            no later than today are returned.


            - The `TermEnd` option is invalid when any subscription included in
            this order is evergreen. In case the order only contains an order
            line item but not contains a subscription, if you set this field to
            `TermEnd` and set `billTargetDate` in the `orderLineItems` field,
            order line items whose `billTargetDate` is no later than today are
            returned.
          enum:
            - SpecificDate
            - TermEnd
            - NumberOfPeriods
          type: string
        previewTypes:
          description: >
            One or more types of the preview. It can include:


            * ChargeMetrics: charge level metrics will be returned in the
            response, including: `cmrr`, `tcv`, `tcb`, and `tax`.

            * BillingDocs: `invoices` and `creditMemos` will be returned in the
            response. Note `creditMemos` is only available if the Invoice
            Settlement feature is enabled.

            * OrderDeltaMetrics: order delta metrics will be returned in the
            response, including: `orderDeltaMrr`, `orderDeltaTcb` and 
            `orderDeltaTcv`.

            * OrderMetrics: order metrics will be returned in the response,
            including: `quantity`, `mrr`, `tcb`, `tcv`, and `elp`. **Note:** As
            of Zuora Billing Release 306, Zuora has upgraded the methodologies
            for calculating metrics in
            [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders).
            The new methodologies are reflected in the OrderDeltaMetrics. It is
            recommended that all customers use the [Order Delta
            Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics).
            If you are an existing [Order
            Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders)
            customer and want to migrate to Order Delta Metrics, submit a
            request at [Zuora Global Support](https://support.zuora.com/).
            Whereas new customers, and existing customers not currently on
            [Order
            Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders),
            will no longer have access to Order Metrics, existing customers
            currently using Order Metrics will continue to be supported.

            * RampMetrics: ramp metrics will be returned in the response,
            including: `quantity`, `mrr`, `tcb`, `tcv` metrics for each charge
            and each ramp interval.

            * RampDeltaMetrics: ramp metrics changes will be returned in the
            response, including: `deltaQuantity`, `deltaMrr`, `deltaTcb`,
            `deltaTcv` metrics for each charge and each ramp interval.
          items:
            enum:
              - ChargeMetrics
              - BillingDocs
              - OrderDeltaMetrics
              - OrderMetrics
              - RampMetrics
              - RampDeltaMetrics
            type: string
          type: array
        skipTax:
          type: boolean
          description: >-
            If set to true, the system will bypass the tax calculation during
            order preview.
          default: false
        specificPreviewThruDate:
          description: >
            The end date of the order preview. You can preview the invoice
            charges through the preview through date. (Invoice preview only)



            **Note:** This field is only applicable if the 'previewThruType'
            field is set to 'SpecificDate'.
          format: date
          type: string
        chargeTypeToExclude:
          description: |
            The charge types to exclude from the forecast run.
          items:
            type: string
            enum:
              - OneTime
              - Recurring
              - Usage
          type: array
      type: object
    EndConditions:
      description: |
        Specifies when a charge becomes inactive.
      properties:
        endDateCondition:
          description: >
            Condition for the charge to become inactive.


            - If the value of this field is `Fixed_Period`, the charge is active
            for a predefined duration based on the value of the
            `upToPeriodsType` and `upToPeriods` fields.

            - If the value of this field is `Specific_End_Date`, use the
            `specificEndDate` field to specify the date when the charge becomes
            inactive.
          enum:
            - Subscription_End
            - Fixed_Period
            - Specific_End_Date
          type: string
        endDatePolicy:
          description: >
            End date policy of the discount charge to become active when the
            **Apply to billing period partially** checkbox is selected from the
            product catalog UI or the `applyToBillingPeriodPartially` field is
            set as true from the "CRUD: Create a product rate plan charge"
            operation. 


            - If the value of this field is `FixedPeriod`, the charge is active
            for a predefined duration based on the value of the
            `upToPeriodsType` and `upToPeriods` fields.

            - If the value of this field is `SpecificEndDate`, use the
            `specificEndDate` field to specify the date when the charge becomes
            inactive.


            **Notes**: 

            - You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.

            - You can use either `endDateCondition` or `endDatePolicy` to define
            when a discount charge ends, but not both at the same time.
          enum:
            - AlignToApplyToCharge
            - SpecificEndDate
            - FixedPeriod
          type: string
        specificEndDate:
          description: >
            Date in YYYY-MM-DD format. Only applicable if the value of the
            `endDateCondition` field is `Specific_End_Date`.
          format: date
          type: string
        upToPeriods:
          description: >
            Duration of the charge in billing periods, days, weeks, months, or
            years, depending on the value of the `upToPeriodsType` field. Only
            applicable if the value of the `endDateCondition` field is
            `Fixed_Period`.
          type: integer
        upToPeriodsType:
          description: >
            Unit of time that the charge duration is measured in. Only
            applicable if the value of the `endDateCondition` field is
            `Fixed_Period`.
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
          type: string
      title: endDate
      type: object
    NegotiatedItems:
      properties:
        items:
          description: |-
            The rate card entry object.


              **Note:** For more information, refer to the rate card definition in the product catalog.
          additionalProperties: true
          type: object
      type: object
    ChargeTier:
      properties:
        endingUnit:
          description: |
            Limit on the number of units for which the tier is effective.
          type: number
        originalListPrice:
          description: >
            The original list price is the price of a product or service at
            which it is listed for sale by a manufacturer or retailer.
          type: number
        price:
          description: >
            Price or per-unit price of the tier, depending on the value of the
            `priceFormat` field.
          type: number
        priceFormat:
          description: |
            Specifies whether the tier has a fixed price or a per-unit price.
          enum:
            - FlatFee
            - PerUnit
          type: string
        startingUnit:
          description: |
            Number of units at which the tier becomes effective.
          type: number
        tier:
          description: |
            Index of the tier in the charge.
          minimum: 1
          type: integer
      required:
        - tier
        - startingUnit
        - price
        - priceFormat
      title: chargeTier
      type: object
    ChargeModelDataOverride:
      description: >
        Container for charge model configuration data.


        **Note**: This field is only available if you have the High Water Mark,
        Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The
        High Water Mark and Pre-Rated Pricing charge models are available for
        customers with Enterprise and Nine editions by default. If you are a
        Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information.
      properties:
        chargeModelConfiguration:
          properties:
            customFieldPerUnitRate:
              description: >
                The custom field that carries the per-unit rate for each usage
                record. For example, `perUnitAmount__c`.


                This field is only available for the usage-based charges that
                use the Pre-Rated Per Unit Pricing charge model. The charge
                model is available for customers with Enterprise and Nine
                editions by default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.
              type: string
            customFieldTotalAmount:
              description: >
                The custom field that carries the total amount to charge for a
                usage record. For example, `totalAmount__c`. 


                This field is only available for the usage-based charges that
                use the Pre-Rated Pricing charge model. The charge model is
                available for customers with Enterprise and Nine editions by
                default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.
              type: string
            formula:
              description: >
                The pricing formula to calculate actual rating amount.


                This field is only available for charges that use the
                Multi-Attribute Pricing charge model.
              type: string
          type: object
        quantity:
          description: >
            Number of units purchased. This field is used if the Multi-Attribute
            Pricing formula uses the `quantity()` function.


            This field is only available for one-time and recurring charges that
            use the Multi-Attribute Pricing charge model.
          minimum: 0
          type: number
        tiers:
          description: >
            List of cumulative pricing tiers in the charge.


            **Note**: When you override the tiers of a usage-based charge using
            High Water Mark Pricing charge model, you have to provide all of the
            tiers, including the ones you do not want to change. The new tiers
            will completely override the previous ones. The High Water Mark
            Pricing charge models are available for customers with Enterprise
            and Nine editions by default. If you are a Growth customer, see
            [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
          items:
            $ref: '#/components/schemas/ChargeTier'
          type: array
      title: chargeModelData
      type: object
    DiscountApplyDetail:
      properties:
        productRatePlanChargeId:
          description: |
            Product Rate Plan Charge Id of the discount apply to.
          type: string
        productRatePlanId:
          description: |
            Product Rate Plan Id of the discount apply to.
          type: string
      required:
        - productRatePlanId
        - productRatePlanChargeId
      title: discountApplyDetail
      type: object
    DiscountPricingOverride:
      description: |
        Pricing information about a discount charge.
      properties:
        applyDiscountTo:
          description: |
            Specifies which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        applyToBillingPeriodPartially:
          description: >
            Allow the discount duration to be aligned with the billing period
            partially.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          type: boolean
        discountAmount:
          description: |
            Only applicable if the discount charge is a fixed-amount discount.
          type: number
        discountApplyDetails:
          description: >
            Charge list of discount be applied to.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          items:
            $ref: '#/components/schemas/DiscountApplyDetail'
          type: array
        discountClass:
          description: >
            The discount class defines the sequence in which discount product
            rate plan charges are applied.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          type: string
        discountLevel:
          description: >
            Application scope of the discount charge. For example, if the value
            of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          description: |
            Only applicable if the discount charge is a percentage discount.
          type: number
        originalDiscountAmount:
          description: >
            The manufacturer's suggested retail discount price for standalone
            charge.


            Only applicable if the standalone discount charge is a fixed-amount
            discount.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: number
        originalDiscountPercentage:
          description: >
            The manufacturer's suggested retail discount percentage for
            standalone charge.


            Only applicable if the standalone discount charge is a percentage
            discount.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: number
        priceChangeOption:
          description: >
            Specifies how Zuora changes the price of the charge each time the
            subscription renews.
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      title: discount
      type: object
    OneTimeFlatFeePricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "flat fee"
        charge model. In this charge model, the charge has a fixed price.
      properties:
        listPrice:
          description: |
            Price of the charge.
          type: number
        originalListPrice:
          description: >
            The original list price is the price of a product or service at
            which it is listed for sale by a manufacturer or retailer.
          type: number
      required:
        - listPrice
      title: oneTimeFlatFee
      type: object
    OneTimePerUnitPricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "per unit"
        charge model. In this charge model, the charge has a fixed price per
        unit purchased.
      properties:
        listPrice:
          description: |
            Per-unit price of the charge.
          type: number
        originalListPrice:
          description: >
            The original list price is the price of a product or service at
            which it is listed for sale by a manufacturer or retailer.
          type: number
        quantity:
          description: |
            Number of units purchased.
          minimum: 0
          type: number
        uom:
          description: >
            Unit of measure of the standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: number
      title: oneTimePerUnit
      type: object
    OneTimeTieredPricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "tiered
        pricing" charge model. In this charge model, the charge has cumulative
        pricing tiers that become effective as units are purchased.
      properties:
        quantity:
          description: |
            Number of units purchased.
          minimum: 0
          type: number
        tiers:
          description: |
            List of cumulative pricing tiers in the charge.
          items:
            $ref: '#/components/schemas/ChargeTier'
          type: array
        uom:
          description: >
            Unit of measure of the standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: number
      title: oneTimeTiered
      type: object
    OneTimeVolumePricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "volume
        pricing" charge model. In this charge model, the charge has a variable
        price per unit, depending on how many units are purchased.
      properties:
        quantity:
          description: |
            Number of units purchased.
          minimum: 0
          type: number
        tiers:
          description: |
            List of variable pricing tiers in the charge.
          items:
            $ref: '#/components/schemas/ChargeTier'
          type: array
        uom:
          description: >
            Unit of measure of the standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: number
      title: oneTimeVolume
      type: object
    PriceChangeParams:
      properties:
        priceChangeOption:
          description: >
            Specifies how Zuora changes the price of the charge each time the
            subscription renews.


            If the value of this field is `SpecificPercentageValue`, use the
            `priceIncreasePercentage` field to specify how much the price of the
            charge should change.
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
        priceIncreasePercentage:
          description: >
            Specifies the percentage by which the price of the charge should
            change each time the subscription renews. Only applicable if the
            value of the `priceChangeOption` field is `SpecificPercentageValue`.
          minimum: -100
          type: number
      type: object
    DeliveryScheduleParams:
      properties:
        frequency:
          description: |
            Specifies the frequency for delivery schedule
          enum:
            - Weekly
          type: string
        friday:
          description: |
            Indicates whether delivery on friday.
          type: boolean
        monday:
          description: |
            Indicates whether delivery on monday.
          type: boolean
        saturday:
          description: |
            Indicates whether delivery on saturday.
          type: boolean
        sunday:
          description: |
            Indicates whether delivery on sunday.
          type: boolean
        thursday:
          description: |
            Indicates whether delivery on thursday.
          type: boolean
        tuesday:
          description: |
            Indicates whether delivery on tuesday.
          type: boolean
        wednesday:
          description: |
            Indicates whether delivery on wednesday.
          type: boolean
      type: object
    RecurringDeliveryPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              description: |
                Price of the charge in each recurring period.
              type: number
      description: >
        Pricing information about a recurring charge that uses the Delivery
        Pricing charge model. In this charge model, the charge has a fixed
        price. This field is only available if you have the Delivery Pricing
        charge model enabled.
      title: recurringDelivery
    RecurringFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              description: |
                Price of the charge in each recurring period.
              type: number
            listPriceBase:
              description: |
                Specifies the duration of each recurring period.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.              
              format: int32
              maximum: 200
              minimum: 1
              type: integer
          type: object
      description: >
        Pricing information about a recurring charge that uses the "flat fee"
        charge model. In this charge model, the charge has a fixed price.
      title: recurringFlatFee
    RecurringPerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              description: |
                Per-unit price of the charge in each recurring period.
              type: number
            listPriceBase:
              description: |
                Specifies the duration of each recurring period.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
            quantity:
              description: |
                Number of units purchased.
              minimum: 0
              type: number
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.              
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            uom:
              description: >
                Unit of measure of the standalone charge.


                **Note:** This field is available when the <a
                href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
                target="_blank">Standalone Orders</a> feature is enabled.
              type: number
          type: object
      description: >
        Pricing information about a recurring charge that uses the "per unit"
        charge model. In this charge model, the charge has a fixed price per
        unit purchased.
      title: recurringPerUnit
    RecurringTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPriceBase:
              description: |
                Specifies the duration of each recurring period.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              description: |
                Number of units purchased.
              minimum: 0
              type: number
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.              
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              description: |
                List of cumulative pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              description: >
                Unit of measure of the standalone charge.


                **Note:** This field is available when the <a
                href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
                target="_blank">Standalone Orders</a> feature is enabled.
              type: number
          type: object
      description: >
        Pricing information about a recurring charge that uses the "tiered
        pricing" charge model. In this charge model, the charge has cumulative
        pricing tiers that become effective as units are purchased.
      title: recurringTiered
    RecurringVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPriceBase:
              description: |
                Specifies the duration of each recurring period.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              description: |
                Number of units purchased.
              minimum: 0
              type: number
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.              
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              description: |
                List of variable pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              description: >
                Unit of measure of the standalone charge.


                **Note:** This field is available when the <a
                href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
                target="_blank">Standalone Orders</a> feature is enabled.
              type: number
          type: object
      description: >
        Pricing information about a recurring charge that uses the "volume
        pricing" charge model. In this charge model, the charge has a variable
        price per unit, depending on how many units are purchased.
      title: recurringVolume
    PreviewOrderTriggerParams:
      description: |
        Specifies when a charge becomes active.
      properties:
        specificTriggerDate:
          description: >
            Date in YYYY-MM-DD format. Only applicable if the value of the
            `triggerEvent` field is `SpecificDate`. 


            While this field is applicable, if this field is not set, your
            `CreateSubscription` order action creates a `Pending` order and a
            `Pending Acceptance` subscription. If at the same time the service
            activation date is required and not set, a `Pending Activation`
            subscription is created.
          format: date
          type: string
        triggerEvent:
          description: >
            Condition for the charge to become active.


            If the value of this field is `SpecificDate`, use the
            `specificTriggerDate` field to specify the date when the charge
            becomes active.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    PreviewOrderChargeOverride:
      description: |
        Charge associated with a rate plan.
      properties:
        accountReceivableAccountingCode:
          description: >
            The accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The adjustmentLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The adjustmentRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        billing:
          description: |
            Billing information about the charge.
          properties:
            billCycleDay:
              description: >
                Day of the month that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofMonth`.
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              description: >
                Specifies how Zuora determines the day that each billing period
                begins on.

                  * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
                  * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
                  * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
                  * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
                  * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              description: >
                Billing frequency of the charge. The value of this field
                controls the duration of each billing period.


                If the value of this field is `Specific_Days`, `Specific_Months`
                or `Specific_Weeks`, use the `specificBillingPeriod` field to
                specify the duration of each billing period.
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              description: >
                Specifies how Zuora determines when to start new billing
                periods. You can use this field to align the billing periods of
                different charges.


                * `AlignToCharge` - Zuora starts a new billing period on the
                first billing day that falls on or after the date when the
                charge becomes active.

                * `AlignToSubscriptionStart` - Zuora starts a new billing period
                on the first billing day that falls on or after the start date
                of the subscription.

                * `AlignToTermStart` - For each term of the subscription, Zuora
                starts a new billing period on the first billing day that falls
                on or after the start date of the term.


                See the `billCycleType` field for information about how Zuora
                determines the billing day.


                **Note**: This field is not supported in one time charges.
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              description: >
                Specifies whether to invoice for a billing period on the first
                day of the billing period (billing in advance) or the first day
                of the next billing period (billing in arrears).
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              description: >
                Duration of each billing period in months or weeks, depending on
                the value of the `billingPeriod` field. Only applicable if the
                value of the `billingPeriod` field is `Specific_Months` or
                `Specific_Weeks`.
              type: integer
            weeklyBillCycleDay:
              description: >
                Day of the week that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofWeek`.
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines what type of charge it is:

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge. 

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> target="_blank">Minimum
            Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the type of the commitment for both the
            commitment true-up charge and credit commitment charge, and so you
            must define the type as `CURRENCY`.
          enum:
            - CURRENCY
          type: string
        creditOption:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          description: >
            The chargeModel of a standalone charge.



            Supported charge models:


            * `FlatFee`


            * `PerUnit`


            * `Volume`


            * `Tiered`


            * `DiscountFixedAmount`


            * `DiscountPercentage`


            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        chargeNumber:
          description: >
            Charge number of the charge. For example, C-00000307.


            * If you do not set this field, Zuora will generate a charge number
            starting with a default prefix, for example, C-. This default prefix
            is predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**.

            * If you want to use a custom charge number, do not use the default
            prefix predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**. Use your own prefix, for example,
            SC-. 
          maxLength: 50
          type: string
        chargeType:
          description: >
            The chargeType of a standalone charge.


            Supported charge types:


            * `OneTime`


            * `Recurring`


            * `Usage`


            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        contractAssetAccountingCode:
          description: >
            The contractAssetAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractLiabilityAccountingCode:
          description: >
            The contractLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The contractRecognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          description: >
            The deferredRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        description:
          description: |
            Description of the charge.
          maxLength: 500
          type: string
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            If you specify `SpecificDate` in the `startDate` > `triggerEvent`
            field and want to create a completed order and an active
            subscription, you must specify either the `estimatedStartDate` or
            `startDate` > `specificTriggerDate` field:


            - `estimatedStartDate`: The charge will be in pending status.


            - `specificTriggerDate`: The charge will be in active status.


            The value of this field must be a date within the subscription term.
            The system will then automatically calculate the estimated end date
            for the pending charge. The estimated start and end dates are used
            to manage the estimated charge duration and forecast the revenue for
            the pending charge.


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charge related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBillingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge. In addition, if the
            `excludeItemBookingFromRevenueAccounting` field in a Create
            Subscription or Add Product order action is set to `false`, you must
            also set the `excludeItemBillingFromRevenueAccounting` field in this
            order action to `false`.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled.
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charges from revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBookingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled.
          type: boolean
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isRollover:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The value is either "True" or "False". It determines whether the
            rollover fields are needed.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        name:
          description: >
            The name of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        negotiatedPriceTable:
          description: >
            Array of negotiated price table information. The rate card entries
            provided in the array will override 

            the existing rate card entries in the standard price table to form a
            negotiated price table that will be    

            used during pricing evaluation.



            **Note:** To enable the Negotiated Price Table feature, submit a
            request to <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.                  
          items:
            $ref: '#/components/schemas/NegotiatedItems'
          type: array
        pobPolicy:
          description: >
            The pobPolicy of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
        pricing:
          description: |
            Pricing information about the charge.
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
          type: object
        pricingAttributes:
          description: >
            Container for pricing attribute and value that provide additional
            context for dynamic pricing. The pricing attribute values are used
            to get the charge’s list price from the product catalog. For the
            pricing attribute mapped to a Zuora object field, Zuora will
            retrieve the value automatically, you don’t need to pass its value
            explicitly. If you pass a value that doesn’t match the actual value
            of the Zuora object, an error will be returned. 

            Note that for any pricing attribute mapped to the field of Zuora
            object Usage, because its value is only determined when the usage
            record arrives, you can’t provide a value via Orders API payload and
            Zuora will not retrieve its value automatically.    



            **Note:** To enable Dynamic Pricing, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          type: object
          additionalProperties: true
        productCategory:
          description: >
            The productCategory of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productClass:
          description: >
            The productClass of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productFamily:
          description: >
            The productFamily of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productLine:
          description: >
            The productLine of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productRatePlanChargeId:
          description: >
            Internal identifier of the product rate plan charge that the charge
            is based on.
          type: string
        productRatePlanChargeNumber:
          description: |
            Number of a product rate-plan charge for this subscription.
          type: string
        prorationOption:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
            target="_blank">Usage charge proration</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            You can use this field to specify the charge-level proration option
            for a usage charge or recurring charge when you creating or adding a
            subscription rate plan charge through an order. The tenant-level
            proration option will be overridden.
              * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
              * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
              * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
              * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field.
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            This field is used only when the value of the `prorationOption`
            field is set to `CustomizeProrationOptionOverrides`. 


            Use this field to specify more customized proration options for a
            recurring charge when you creating or adding a subscription rate
            plan charge through an order. The tenant-level proration option will
            be overridden.
          type: object
          properties:
            isProratePartialMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify whether to prorate the recurring
                charge for a partial month. The tenant-level proration option
                will be overridden.
              type: boolean
            prorationUnit:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the unit of proration for a recurring
                charge. The tenant-level proration option will be overridden.
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the number of days counted for a month
                when prorating a recurring charge. The tenant-level proration
                option will be overridden. See more details for each of the
                following enum values in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Common_subscription_information/F_Proration#When_prorating_a_month.2C_assume_30_days_in_a_month_or_use_actual_days.3F"
                target="_blank">Proration</a>.
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          description: >
            The recognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        revRecCode:
          description: |
            Revenue Recognition Code
          maxLength: 70
          type: string
        revRecTriggerCondition:
          description: |
            Specifies the revenue recognition trigger condition.

              * `Contract Effective Date` 
              * `Service Activation Date`
              * `Customer Acceptance Date`
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          description: >
            Specifies the revenue recognition rule, such as `Recognize upon
            invoicing` or `Recognize daily over time`.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. In this
            case, you must set the `rolloverPeriods` field to 1. For example,
            you can define the rollover fund's period length as 5 months,
            shorter than the prepayment charge's validity period: a year.
          type: integer
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: number
        startDate:
          $ref: '#/components/schemas/PreviewOrderTriggerParams'
        unBilledReceivablesAccountingCode:
          description: >
            The unBilledReceivablesAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        uniqueToken:
          description: >
            Unique identifier for the charge. This identifier enables you to
            refer to the charge before the charge has an internal identifier in
            Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the charge.
            Then when you update the product, you can use the same unique
            identifier to specify which charge to modify.
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          description: >
            The identifier of the original upselling charge associated with the
            current charge.


            For a termed subscription, you can now use the "Create an order" API
            operation to perform an Add Product order action to make a product
            quantity upsell for per unit recurring charges. The benefit is that
            the charge added by this approach will be automatically combined
            with the original existing charge for which you want to upsell when
            the subscription is renewed. The approach is as follows:

            * Use an Add Product order action to add a charge that is of the
            same charge type, charge model, and charge end date as the existing
            per unit recurring charge for which you want to make a quantity
            upsell.


            * In the preceding charge to add, use the `upsellOriginChargeNumber`
            field to specify the existing rate plan charge for which you want to
            make the quantity upsell.


            Note that a termed subscription with such upsell charges can not be
            changed to an evergreen subscription.   


            **Note**: The Quantity Upsell feature is in the **Early Adopter**
            phase. We are actively soliciting feedback from a small set of early
            adopters before releasing it as generally available. If you want to
            join this early adopter program, submit a request at [Zuora Global
              Support](https://support.zuora.com).  
          type: string
        validityPeriodType:
          description: >
            **Note**: This field is only available if you have enabled either of
            the following:

            * <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            * <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a>

            * Both <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>


            You can use this field in the following scenarios: 

            * When you create a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge),
            use this field to define the period in which the prepayment units
            are valid to use.


            * When you override the setting of <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment#Commitment_true-up_charge_specific_settings"
            target="_blank">commitment true-up charge</a> from the product
            catalog, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.


            * When you use a standalone order to create a commitment true-up
            charge, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
        taxCode:
          description: >
            The tax code of a charge. This field is available when the `taxable`
            field is set to `true`. 
          type: string
        taxMode:
          description: >
            The tax mode of a charge.  This field is available when the
            `taxable` field is set to `true`.
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        taxable:
          description: >
            The flag indicates whether the charge is taxable. If this field is
            set to `true`, you must specify the `taxCode` and `taxMode` fields.
          type: boolean
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    OrdersRatePlanObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Rate Plan object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: >
        Container for custom fields of the Rate Plan object. The custom fields
        of the Rate Plan object are used when rate plans are subscribed.
      title: RatePlanCustomFields
      type: object
    RatePlanFeatureOverrideCustomFields:
      additionalProperties:
        description: >
          Custom fields of the feature. 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: |
        A container for custom fields of the feature.
      title: ratePlanFeatureCustom
      type: object
    CreateOrderRatePlanFeatureOverride:
      description: |
        Information about feature in rate plan.
      properties:
        customFields:
          $ref: '#/components/schemas/RatePlanFeatureOverrideCustomFields'
        description:
          description: A description of the feature.
          maxLength: 500
          type: string
        featureId:
          description: |
            Internal identifier of the feature in the product catalog.
          type: string
      required:
        - featureId
      title: ratePlanFeature
      type: object
    PreviewOrderRatePlanOverride:
      description: |
        Information about an order action of type `AddProduct`.
      properties:
        chargeOverrides:
          description: |
            List of charges associated with the rate plan.
          items:
            $ref: '#/components/schemas/PreviewOrderChargeOverride'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        isAddingSubsetCharges:
          description: >
            Specifies whether to add a subset of charges to the subscription.



            **Note:** To access this field for adding a subset of charges,
            submit a request at <a href="http://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isFromExternalCatalog:
          description: >
            Indicates whether the rate plan is created from the Zuora product
            catalog or from an external product catalog.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: boolean
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanName:
          description: >
            Name of the standalone rate plan.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        uniqueToken:
          description: >
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the rate
            plan. Then when you update the product, you can use the same unique
            identifier to specify which rate plan to modify.
          maxLength: 50
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a subscription rate plan for this subscription.
          maxLength: 50
          type: string
      required:
        - productRatePlanId
      title: ratePlan
      type: object
    CancelSubscription:
      description: |
        Information about an order action of type `CancelSubscription`.
      properties:
        cancellationEffectiveDate:
          format: date
          type: string
        cancellationPolicy:
          enum:
            - EndOfCurrentTerm
            - EndOfLastInvoicePeriod
            - SpecificDate
          type: string
      required:
        - cancellationPolicy
      title: cancelSubscription
      type: object
    CreateOrderTriggerParams:
      description: |
        Specifies when a charge becomes active.
      properties:
        periodsAfterChargeStart:
          description: >
            Duration of the discount charge in days, weeks, months, or years,
            depending on the value of the `startPeriodsType` field. Only
            applicable if the value of the `startDatePolicy` field is
            `FixedPeriodAfterApplyToChargeStartDate`.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          type: integer
        specificTriggerDate:
          description: >
            Date in YYYY-MM-DD format. Only applicable if the value of the
            `triggerEvent` field is `SpecificDate`. 


            While this field is applicable, if this field is not set, your
            `CreateSubscription` order action creates a `Pending` order and a
            `Pending Acceptance` subscription. If at the same time the service
            activation date is required and not set, a `Pending Activation`
            subscription is created.


            While this field is applicable, if this field is not set, the
            following order actions create a `Pending` order but do not impact
            the subscription status. **Note**: This feature is in **Limited
            Availability**. If you want to have access to the feature, submit a
            request at [Zuora Global Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions
          format: date
          type: string
        startDatePolicy:
          description: >
            Start date policy of the discount charge to become active when the
            **Apply to billing period partially** checkbox is selected from the
            product catalog UI or the `applyToBillingPeriodPartially` field is
            set as true from the "CRUD: Create a product rate plan charge"
            operation.


            - If the value of this field is `SpecificDate`, use the
            `specificTriggerDate` field to specify the date when the charge
            becomes active.

            - If the value of this field is
            `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a
            predefined duration based on the value of the `upToPeriodsType` and
            `upToPeriods` fields.


            **Notes**: 
              - You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field. 
              - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.
          enum:
            - AlignToApplyToCharge
            - SpecificDate
            - EndOfLastInvoicePeriodOfApplyToCharge
            - FixedPeriodAfterApplyToChargeStartDate
          type: string
        startPeriodsType:
          description: >
            Unit of time that the discount charge duration is measured in. Only
            applicable if the value of the `startDatePolicy` field is
            `FixedPeriodAfterApplyToChargeStartDate`.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          enum:
            - Days
            - Weeks
            - Months
            - Years
          type: string
        triggerEvent:
          description: >
            Condition for the charge to become active.


            If the value of this field is `SpecificDate`, use the
            `specificTriggerDate` field to specify the date when the charge
            becomes active.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    PreviewOrderChangePlanChargeOverride:
      description: |
        Charge associated with a rate plan.
      properties:
        accountReceivableAccountingCode:
          description: >
            The accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The adjustmentLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The adjustmentRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        billing:
          description: |
            Billing information about the charge.
          properties:
            billCycleDay:
              description: >
                Day of the month that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofMonth`.
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              description: >
                Specifies how Zuora determines the day that each billing period
                begins on.

                  * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
                  * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
                  * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
                  * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
                  * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              description: >
                Billing frequency of the charge. The value of this field
                controls the duration of each billing period.


                If the value of this field is `Specific_Days`, `Specific_Months`
                or `Specific_Weeks`, use the `specificBillingPeriod` field to
                specify the duration of each billing period.
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              description: >
                Specifies how Zuora determines when to start new billing
                periods. You can use this field to align the billing periods of
                different charges.


                * `AlignToCharge` - Zuora starts a new billing period on the
                first billing day that falls on or after the date when the
                charge becomes active.

                * `AlignToSubscriptionStart` - Zuora starts a new billing period
                on the first billing day that falls on or after the start date
                of the subscription.

                * `AlignToTermStart` - For each term of the subscription, Zuora
                starts a new billing period on the first billing day that falls
                on or after the start date of the term.


                See the `billCycleType` field for information about how Zuora
                determines the billing day.


                **Note**: This field is not supported in one time charges. 
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              description: >
                Specifies whether to invoice for a billing period on the first
                day of the billing period (billing in advance) or the first day
                of the next billing period (billing in arrears).
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              description: >
                Duration of each billing period in months or weeks, depending on
                the value of the `billingPeriod` field. Only applicable if the
                value of the `billingPeriod` field is `Specific_Months` or
                `Specific_Weeks`.
              type: integer
            weeklyBillCycleDay:
              description: >
                Day of the week that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofWeek`.
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines what type of charge it is:

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge. 

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the type of the commitment for both the
            commitment true-up charge and credit commitment charge, and so you
            must define the type as `CURRENCY`.
          enum:
            - CURRENCY
          type: string
        creditOption:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          description: >
            The chargeModel of a standalone charge.



            Supported charge models:


            * `FlatFee`


            * `PerUnit`


            * `Volume`


            * `Tiered`


            * `DiscountFixedAmount`


            * `DiscountPercentage`



            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        chargeNumber:
          description: >
            Charge number of the charge. For example, C-00000307.


            * If you do not set this field, Zuora will generate a charge number
            starting with a default prefix, for example, C-. This default prefix
            is predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**.

            * If you want to use a custom charge number, do not use the default
            prefix predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**. Use your own prefix, for example,
            SC-.
          maxLength: 50
          type: string
        chargeType:
          description: >
            The chargeType of a standalone charge.


            Supported charge types:


            * `OneTime`


            * `Recurring`


            * `Usage`


            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        contractAssetAccountingCode:
          description: >
            The contractAssetAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractLiabilityAccountingCode:
          description: >
            The contractLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The contractRecognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          description: >
            The deferredRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        description:
          description: |
            Description of the charge.
          maxLength: 500
          type: string
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            If you specify `SpecificDate` in the `startDate` > `triggerEvent`
            field and want to create a completed order and an active
            subscription, you must specify either the `estimatedStartDate` or
            `startDate` > `specificTriggerDate` field:


            - `estimatedStartDate`: The charge will be in pending status.


            - `specificTriggerDate`: The charge will be in active status.


            The value of this field must be a date within the subscription term.
            The system will then automatically calculate the estimated end date
            for the pending charge. The estimated start and end dates are used
            to manage the estimated charge duration and forecast the revenue for
            the pending charge.


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charge related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charges from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isRollover:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The value is either "True" or "False". It determines whether the
            rollover fields are needed.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        negotiatedPriceTable:
          description: >
            Array of negotiated price table information. The rate card entries
            provided in the array will override

            the existing rate card entries in the standard price table to form a
            negotiated price table that will be   

            used during pricing evaluation.


            **Note:** To enable the Negotiated Price Table feature, submit a
            request to <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.                 
          items:
            $ref: '#/components/schemas/NegotiatedItems'
          type: array
        name:
          description: >
            The name of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        pobPolicy:
          description: >
            The pobPolicy of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
        pricing:
          description: |
            Pricing information about the charge.
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
          type: object
        pricingAttributes:
          description: >
            Container for pricing attribute and value that provide additional
            context for dynamic pricing. The pricing attribute values are used
            to get the charge’s list price from the product catalog. For the
            pricing attribute mapped to a Zuora object field, Zuora will
            retrieve the value automatically, you don’t need to pass its value
            explicitly. If you pass a value that doesn’t match the actual value
            of the Zuora object, an error will be returned.

            Note that for any pricing attribute mapped to the field of Zuora
            object Usage, because its value is only determined when the usage
            record arrives, you can’t provide a value via Orders API payload and
            Zuora will not retrieve its value automatically.   



            **Note:** To enable Dynamic Pricing, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          type: object
          additionalProperties: true
        productCategory:
          description: >
            The productCategory of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productClass:
          description: >
            The productClass of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productFamily:
          description: >
            The productFamily of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productLine:
          description: >
            The productLine of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productRatePlanChargeId:
          description: >
            Internal identifier of the product rate plan charge that the charge
            is based on.
          type: string
        productRatePlanChargeNumber:
          description: |
            Number of a product rate-plan charge for this subscription.
          type: string
        prorationOption:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
            target="_blank">Usage charge proration</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            You can use this field to specify the charge-level proration option
            for a usage charge or recurring charge when you creating or adding a
            subscription rate plan charge through an order. The tenant-level
            proration option will be overridden.
              * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
              * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
              * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
              * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field.
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            This field is used only when the value of the `prorationOption`
            field is set to `CustomizeProrationOptionOverrides`. 


            Use this field to specify more customized proration options for a
            recurring charge when you creating or adding a subscription rate
            plan charge through an order. The tenant-level proration option will
            be overridden.
          type: object
          properties:
            isProratePartialMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify whether to prorate the recurring
                charge for a partial month. The tenant-level proration option
                will be overridden.
              type: boolean
            prorationUnit:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the unit of proration for a recurring
                charge. The tenant-level proration option will be overridden.
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the number of days counted for a month
                when prorating a recurring charge. The tenant-level proration
                option will be overridden. See more details for each of the
                following enum values in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Common_subscription_information/F_Proration#When_prorating_a_month.2C_assume_30_days_in_a_month_or_use_actual_days.3F"
                target="_blank">Proration</a>.
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          description: >
            The recognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        revRecCode:
          description: |
            Revenue Recognition Code
          maxLength: 70
          type: string
        revRecTriggerCondition:
          description: |
            Specifies the revenue recognition trigger condition.

              * `Contract Effective Date` 
              * `Service Activation Date`
              * `Customer Acceptance Date`
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          description: >
            Specifies the revenue recognition rule, such as `Recognize upon
            invoicing` or `Recognize daily over time`.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The period length of the rollover fund.
          type: integer
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: number
        startDate:
          $ref: '#/components/schemas/CreateOrderTriggerParams'
        taxCode:
          description: >
            The taxCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        taxMode:
          description: >
            The taxMode of a standalone charge. 


            Values:

            * `TaxExclusive`

            * `TaxInclusive`


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        unBilledReceivablesAccountingCode:
          description: >
            The unBilledReceivablesAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        uniqueToken:
          description: >
            Unique identifier for the charge. This identifier enables you to
            refer to the charge before the charge has an internal identifier in
            Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the charge.
            Then when you update the product, you can use the same unique
            identifier to specify which charge to modify.
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          description: >
            The identifier of the original upselling charge associated with the
            current charge.


            For a termed subscription, you can now use the "Create an order" API
            operation to perform an Add Product order action to make a product
            quantity upsell for per unit recurring charges. The benefit is that
            the charge added by this approach will be automatically combined
            with the original existing charge for which you want to upsell when
            the subscription is renewed. The approach is as follows:

            * Use an Add Product order action to add a charge that is of the
            same charge type, charge model, and charge end date as the existing
            per unit recurring charge for which you want to make a quantity
            upsell.


            * In the preceding charge to add, use the `upsellOriginChargeNumber`
            field to specify the existing rate plan charge for which you want to
            make the quantity upsell.


            Note that a termed subscription with such upsell charges can not be
            changed to an evergreen subscription.   


            **Note**: The Quantity Upsell feature is in the **Early Adopter**
            phase. We are actively soliciting feedback from a small set of early
            adopters before releasing it as generally available. If you want to
            join this early adopter program, submit a request at [Zuora Global
              Support](https://support.zuora.com).  
          type: string
        validityPeriodType:
          description: >
            **Note**: This field is only available if you have enabled either of
            the following:

            * <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            * <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a>

            * Both <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>


            You can use this field in the following scenarios: 

            * When you create a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge),
            use this field to define the period in which the prepayment units
            are valid to use.


            * When you override the setting of <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment#Commitment_true-up_charge_specific_settings"
            target="_blank">commitment true-up charge</a> from the product
            catalog, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.


            * When you use a standalone order to create a commitment true-up
            charge, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    PreviewOrderChangePlanRatePlanOverride:
      description: |
        Information about the new product rate plan to add. 
      properties:
        chargeOverrides:
          description: |
            List of charges associated with the rate plan.
          items:
            $ref: '#/components/schemas/PreviewOrderChangePlanChargeOverride'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          description: >
            An external ID of the product rate plan to be added. You can use
            this field to specify a product rate plan that is imported from an
            external system. The value of the `externalCatalogPlanId` field must
            match one of the values that are predefined in the
            `externallyManagedPlanIds` field on a product rate plan.


            **Note:** If both `externalCatalogPlanId` and `productRatePlanId`
            are provided. They must point to the same product rate plan.
            Otherwise, the request would fail.
          type: string
        externallyManagedPlanId:
          description: >
            Indicates the unique identifier for the rate plan purchased on a
            third-party store. This field is used to represent a subscription
            rate plan created through third-party stores.
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a subscription rate plan for this subscription.
          maxLength: 50
          type: string
        isFromExternalCatalog:
          description: >
            Indicates whether the rate plan is created from the Zuora product
            catalog or from an external product catalog.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: boolean
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanName:
          description: >
            Name of the standalone rate plan.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        uniqueToken:
          description: >
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the rate
            plan. Then when you update the product, you can use the same unique
            identifier to specify which rate plan to modify.
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    PreviewOrderCreateChangePlan:
      description: >
        Information about an order action of type `ChangePlan`. 


        Use the change plan type of order action to replace the existing rate
        plans in a subscription with other rate plans.


        **Note**: The change plan type of order action is supported for the  <a
        href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
        target="_blank">Order to Revenue</a> feature. However, it is currently
        not supported for the <a
        href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
        target="_blank">Billing - Revenue Integration</a> feature. When Billing
        - Revenue Integration is enabled, the change plan type of order action
        will no longer be applicable in Zuora Billing.


        If you want to create a pending order through the "change plan" order
        action, and if the charge's trigger condition is `Specific Date`, you
        must set a charge number in the `chargeNumber` field for the "change
        plan" order action. In this case, if you do not set it, Zuora will not
        generate the charge number for you.


        See more information about pending orders in <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/Pending_orders_and_subscriptions"
        target="_blank">Pending orders and subscriptions</a>.
      properties:
        effectivePolicy:
          description: |
            The default value for the `effectivePolicy` field is as follows:
              * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
              * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
              * Otherwise, the effective policy is `SpecificDate` by default.

            **Notes**: 
              * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates" target="_blank">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period, and you cannot set the following billing trigger date settings to `Yes`:
                * <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Customer_Acceptance_of_Orders.3F" target="_blank">Require Customer Acceptance of Orders?</a>
                * <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Service_Activation_of_Orders.3F" target="_blank">Require Service Activation of Orders?</a>
              
              * When setting this field to `SpecificDate`, you must also set the contract effective date in the `triggerDates` field as follows:
                * Set the `name` field as `ContractEffective`
                * Specify a date for the `triggerDate` field
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        externalCatalogPlanId:
          description: >
            An external ID of the rate plan to be removed. You can use this
            field to specify an existing rate plan in your subscription. The
            value of the `externalCatalogPlanId` field must match one of the
            values that are predefined in the `externallyManagedPlanIds` field
            on a product rate plan. However, if there are multiple rate plans
            with the same `productRatePlanId` value existing in the
            subscription, you must use the `ratePlanId` field to remove the rate
            plan. The `externalCatalogPlanId` field cannot be used to
            distinguish multiple rate plans in this case.


            **Note:** Please provide only one of `externalCatalogPlanId`,
            `ratePlanId` or `productRatePlanId`. If more than 1 field is
            provided then the request would fail.
          type: string
        newProductRatePlan:
          $ref: '#/components/schemas/PreviewOrderChangePlanRatePlanOverride'
        productRatePlanId:
          description: |
            ID of the product rate plan that the removed rate plan is based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            ID of the rate plan to remove. This can be the latest version or any
            history version of ID. Note that the removal of a rate plan through
            the Change Plan order action supports the function of <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/Order_actions_tutorials/E2_Remove_rate_plan_on_subscription_before_future-dated_removals"
            target="_blank">removal before future-dated removals</a>, as in a
            Remove Product order action.
          type: string
        resetBcd:
          default: false
          description: >
            If resetBcd is true then reset the Account BCD to the effective
            date; if it is false keep the original BCD.


            **Note**: If the rate plan change is an upgrade (the `subType` field
            is `Upgrade`), then the effective policy is `EffectiveImmediately`
            by default. In this case, if you do not specify the `resetBcd`
            field, the system sets this field to `true` while BCD is the
            effective date.
          type: boolean
        subType:
          description: >
            Use this field to choose the sub type for your change plan order
            action.


            However, if you do not set this field, the field will be
            automatically generated by the system according to the following
            rules:


            When the old and new rate plans are within the same Grading catalog
            group:

            * If the grade of new plan is greater than that of the old plan,
            this is an "Upgrade".

            * If the grade of new plan is less than that of the old plan, this
            is a "Downgrade".

            * If the grade of new plan equals that of the old plan, this is a
            "Crossgrade".


            When the old and new rate plans are not in the same Grading catalog
            group, or either has no group, this is "PlanChanged".
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
      required:
        - newProductRatePlan
      title: createChangePlan
      type: object
    BillToContactPostOrder:
      allOf:
        - description: |
            Contact details associated with an account.
          properties:
            address1:
              description: >
                First line of the contact's address. This is often a street
                address or a business name.
              maxLength: 255
              type: string
            address2:
              description: |
                Second line of the contact's address.
              maxLength: 255
              type: string
            city:
              description: |
                City of the contact's address.
              maxLength: 100
              type: string
            contactDescription:
              description: |
                A description for the contact.
              maxLength: 100
              type: string
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the bill-to contact to
                calculate tax.
              maxLength: 64
              type: string
            county:
              description: |
                County of the contact's address.
              maxLength: 100
              type: string
            fax:
              description: |
                Fax number of the contact.
              maxLength: 40
              type: string
            firstName:
              description: |
                First name of the contact.
              maxLength: 100
              type: string
            homePhone:
              description: |
                Home phone number of the contact.
              maxLength: 40
              type: string
            lastName:
              description: |
                Last name of the contact.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                Mobile phone number of the contact.
              maxLength: 40
              type: string
            nickname:
              description: |
                Nickname of the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: >
                Additional phone number of the contact. Use the `otherPhoneType`
                field to specify the type of phone number.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                Specifies the type of phone number in the `otherPhone` field.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                Personal email address of the contact.
              format: email
              maxLength: 80
              type: string
            postalCode:
              description: |
                ZIP code or other postal code of the contact's address.
              maxLength: 20
              type: string
            state:
              description: |
                State or province of the contact's address.
              maxLength: 100
              type: string
            taxRegion:
              description: >
                Region defined in your taxation rules. Only applicable if you
                use Zuora Tax.
              maxLength: 100
              type: string
              nullable: true
            workEmail:
              description: |
                Business email address of the contact.
              format: email
              maxLength: 80
              type: string
            workPhone:
              description: |
                Business phone number of the contact.
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    AccountCreditCardHolder:
      description: >
        Information about the cardholder of a credit card payment method
        associated with an account. If you do not provide information about the
        cardholder, Zuora uses the account's bill-to contact.
      properties:
        addressLine1:
          description: |
            First line of the cardholder's address.
          maxLength: 255
          type: string
        addressLine2:
          description: |
            Second line of the cardholder's address.
          maxLength: 255
          type: string
        cardHolderName:
          description: >-
            Full name of the cardholder as it appears on the card. For example,
            "John J Smith", 50 characters or less. The value must consist only
            of US-ASCII characters and must not  include special characters.
          maxLength: 50
          type: string
        city:
          description: >
            City of the cardholder's address.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          maxLength: 40
          type: string
        country:
          description: >
            Country of the cardholder's address. The value of this field must be
            a valid country name or abbreviation.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          maxLength: 64
          type: string
        email:
          description: |
            Email address of the cardholder.
          maxLength: 80
          type: string
        phone:
          description: |
            Phone number of the cardholder.
          maxLength: 40
          type: string
        state:
          description: |
            State or province of the cardholder's address.
          maxLength: 50
          type: string
        zipCode:
          description: |
            ZIP code or other postal code of the cardholder's address.
          maxLength: 20
          type: string
      type: object
    creditCard:
      description: >
        Default payment method associated with an account. Only credit card
        payment methods are supported.
      properties:
        cardHolderInfo:
          $ref: '#/components/schemas/AccountCreditCardHolder'
        cardNumber:
          description: >
            Card number. Once set, you cannot update or query the value of this
            field. The value of this field is only available in masked format.
            For example, XXXX-XXXX-XXXX-1234 (hyphens must not be used when you
            set the credit card number).
          type: string
        cardType:
          description: |
            Type of card.
          enum:
            - Visa
            - MasterCard
            - AmericanExpress
            - Discover
            - JCB
            - Diners
            - CUP
            - Maestro
            - Electron
            - AppleVisa
            - AppleMasterCard
            - AppleAmericanExpress
            - AppleDiscover
            - AppleJCB
            - Elo
            - Hipercard
            - Naranja
            - Nativa
            - TarjetaShopping
            - Cencosud
            - Argencard
            - Cabal
          type: string
        expirationMonth:
          description: |
            Expiration date of the card.
          maximum: 12
          minimum: 1
          type: integer
        expirationYear:
          description: |
            Expiration year of the card.
          maximum: 2500
          minimum: 1980
          type: integer
        securityCode:
          description: >
            CVV or CVV2 security code of the card. To ensure PCI compliance,
            Zuora does not store the value of this field.
          type: string
      type: object
    SoldToContactPostOrder:
      allOf:
        - description: |
            Contact details associated with an account.
          properties:
            address1:
              description: >
                First line of the contact's address. This is often a street
                address or a business name.
              maxLength: 255
              type: string
            address2:
              description: |
                Second line of the contact's address.
              maxLength: 255
              type: string
            city:
              description: |
                City of the contact's address.
              maxLength: 100
              type: string
            contactDescription:
              description: |
                A description for the contact.          
              maxLength: 100
              type: string
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the sold-to contact to
                calculate tax. A bill-to contact may be used if no sold-to
                contact is provided.
              maxLength: 64
              type: string
            county:
              description: |
                County of the contact's address.
              maxLength: 100
              type: string
            fax:
              description: |
                Fax number of the contact.
              maxLength: 40
              type: string
            firstName:
              description: |
                First name of the contact.
              maxLength: 100
              type: string
            homePhone:
              description: |
                Home phone number of the contact.
              maxLength: 40
              type: string
            lastName:
              description: |
                Last name of the contact.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                Mobile phone number of the contact.
              maxLength: 40
              type: string
            nickname:
              description: |
                Nickname of the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: >
                Additional phone number of the contact. Use the `otherPhoneType`
                field to specify the type of phone number.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                Specifies the type of phone number in the `otherPhone` field.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                Personal email address of the contact.
              format: email
              maxLength: 80
              type: string
            postalCode:
              description: |
                ZIP code or other postal code of the contact's address.
              maxLength: 20
              type: string
            state:
              description: |
                State or province of the contact's address.
              maxLength: 100
              type: string
            taxRegion:
              description: >
                Region defined in your taxation rules. Only applicable if you
                use Zuora Tax.
              maxLength: 100
              type: string
              nullable: true
            workEmail:
              description: |
                Business email address of the contact.
              format: email
              maxLength: 80
              type: string
            workPhone:
              description: |
                Business phone number of the contact.
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    RenewalTerm:
      properties:
        period:
          description: >
            Duration of the renewal term in months, years, days, or weeks,
            depending on the value of the `periodType` field.
          type: integer
        periodType:
          description: |
            Unit of time that the renewal term is measured in.
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
      type: object
    PreviewOrderCreateSubscription:
      description: |
        Information about an order action of type `CreateSubscription`.
      properties:
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        currency:
          description: >
            The code of currency that is used for this subscription. If the
            currency is not selected, the default currency from the account will
            be used.


            All subscriptions in the same order must use the same currency. The
            currency for a subscription cannot be changed.


            **Note**: 
              This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies" target="_blank">Multiple Currencies</a> feature enabled.
          maxLength: 3
          type: string
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the subscription.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          description: >
            Specifies whether the subscription appears on a separate invoice
            when Zuora generates invoices.
          type: boolean
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        newSubscriptionOwnerAccount:
          description: >
            Information about a new account that will own the subscription. Only
            available if you have enabled the Owner Transfer feature.


            **Note:** The Owner Transfer feature is in **Limited Availability**.
            If you wish to have access to the feature, submit a request at
            [Zuora Global Support](http://support.zuora.com/).


            If you do not set this field or the `subscriptionOwnerAccountNumber`
            field, the account that owns the order will also own the
            subscription. Zuora will return an error if you set this field and
            the `subscriptionOwnerAccountNumber` field.
          properties:
            accountNumber:
              description: |
                Account number. For example, A00000001.
              maxLength: 70
              type: string
            additionalEmailAddresses:
              description: >
                List of additional email addresses to receive emailed invoices.
                Values should be a comma-separated list of email addresses.
              maxLength: 1200
              type: string
            allowInvoiceEdit:
              description: |
                Indicates if associated invoices can be edited.
                Values are: 

                * `true`
                * `false` (default)
              type: boolean
            autoPay:
              description: >
                Specifies whether future payments are automatically billed when
                they are due.
              type: boolean
            batch:
              description: >
                Name of the billing batch that the account belongs to. For
                example, Batch1.
              type: string
            billCycleDay:
              description: >
                Day of the month that the account prefers billing periods to
                begin on. If set to 0, the bill cycle day will be set as
                "AutoSet".
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContactPostOrder'
            communicationProfileId:
              description: >
                Internal identifier of the communication profile that Zuora uses
                when sending notifications to the account's contacts.
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            creditMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the credit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08a6246fdf101626b1b3fe0144b.
              type: string
            crmId:
              description: |
                External identifier of the account in a CRM system.
              maxLength: 100
              type: string
            currency:
              description: |
                ISO 3-letter currency code (uppercase). For example, USD.
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            customerServiceRepName:
              description: >
                Name of the account's customer service representative, if
                applicable.
              maxLength: 50
              type: string
            debitMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the debit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08d62470a8501626b19d24f19e2.
              type: string
            hpmCreditCardPaymentMethodId:
              description: >
                The ID of the payment method associated with this account. The
                payment method specified for this field will be set as the
                default payment method of the account.


                If the `autoPay` field is set to `true`, you must provide the
                credit card payment method ID for either this field or the
                `creditCard` field,

                but not both.


                For a specified credit card payment method, it is recommended
                that [the support for stored credential
                transactions](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Stored_credential_transactions)
                for this payment method is already enabled.
              type: string
            invoiceDeliveryPrefsEmail:
              description: >
                Specifies whether to turn on the invoice delivery method 'Email'
                for the new account. 

                Values are: 


                * `true` (default). Turn on the invoice delivery method 'Email'
                for the new account.

                * `false`. Turn off the invoice delivery method 'Email' for the
                new account.         
              type: boolean
            invoiceDeliveryPrefsPrint:
              description: >
                Specifies whether to turn on the invoice delivery method 'Print'
                for the new account.

                Values are: 


                * `true`. Turn on the invoice delivery method 'Print' for the
                new account.

                * `false` (default). Turn off the invoice delivery method
                'Print' for the new account.
              type: boolean
            invoiceTemplateId:
              description: >
                Internal identifier of the invoice template that Zuora uses when
                generating invoices for the account.
              type: string
            name:
              description: |
                Account name.
              maxLength: 255
              type: string
            notes:
              description: >
                Notes about the account. These notes are only visible to Zuora
                users.
              maxLength: 65535
              type: string
            parentId:
              description: >-
                Identifier of the parent customer account for this Account
                object. Use this field if you have <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
                target="_blank">Customer Hierarchy</a> enabled.
              type: string
            paymentGateway:
              description: >
                The payment gateway that Zuora uses when processing electronic
                payments and refunds for the account. If you do not specify this
                field or if the value of this field is null, Zuora uses your
                default payment gateway.
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              description: >
                Name of the payment term associated with the account. For
                example, "Net 30". The payment term determines the due dates of
                invoices.
              type: string
            purchaseOrderNumber:
              description: >
                The number of the purchase order associated with this account.
                Purchase order information generally comes from customers.
              maxLength: 100
              type: string
            salesRep:
              description: >
                The name of the sales representative associated with this
                account, if applicable.
              maxLength: 50
              type: string
            soldToContact:
              $ref: '#/components/schemas/SoldToContactPostOrder'
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        notes:
          description: >
            Notes about the subscription. These notes are only visible to Zuora
            users.
          maxLength: 500
          type: string
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For
            example, `Net 30`. The payment term determines the due dates of
            invoices.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          description: >
            The ID of the ship-to contact associated with the subscription. It
            must be a contact of the subscription owner.



            **Note**:
              To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        subscribeToRatePlans:
          description: |
            List of rate plans associated with the subscription.
          items:
            $ref: '#/components/schemas/PreviewOrderRatePlanOverride'
          type: array
        subscriptionNumber:
          description: >
            Subscription number of the subscription. For example, A-S00000001.


            If you do not set this field, Zuora will generate the subscription
            number.
          maxLength: 100
          type: string
        subscriptionOwnerAccountNumber:
          description: >
            Account number of an existing account that will own the
            subscription. For example, A00000001.


            If you do not set this field or the `newSubscriptionOwnerAccount`
            field, the account that owns the order will also own the
            subscription. Zuora will return an error if you set this field and
            the `newSubscriptionOwnerAccount` field.
          maxLength: 70
          type: string
        invoiceOwnerAccountNumber:
          description: >
            Account number of an existing account that will own the invoice. For
            example, A00000001. If you do not set this field, the account that
            owns the order will also own this invoice.
          maxLength: 70
          type: string
        terms:
          description: |
            Container for the terms and renewal settings of the subscription.
          properties:
            autoRenew:
              description: >
                Specifies whether the subscription automatically renews at the
                end of the each term. Only applicable if the type of the first
                term is `TERMED`.
              type: boolean
            initialTerm:
              description: |
                Information about the first term of the subscription.
              properties:
                period:
                  description: >
                    Duration of the first term in months, years, days, or weeks,
                    depending on the value of the `periodType` field. Only
                    applicable if the value of the `termType` field is `TERMED`.
                  type: integer
                periodType:
                  description: >
                    Unit of time that the first term is measured in. Only
                    applicable if the value of the `termType` field is `TERMED`.
                  enum:
                    - Month
                    - Year
                    - Day
                    - Week
                  type: string
                startDate:
                  description: |
                    Start date of the first term, in YYYY-MM-DD format.
                  format: date
                  type: string
                endDate:
                  description: |
                    End date of the first term, in YYYY-MM-DD format.
                  format: date
                  type: string
                termType:
                  description: >
                    Type of the first term. If the value of this field is
                    `TERMED`, the first term has a predefined duration based on
                    the value of the `period` field. If the value of this field
                    is `EVERGREEN`, the first term does not have a predefined
                    duration.
                  enum:
                    - TERMED
                    - EVERGREEN
                  type: string
              required:
                - termType
              type: object
            renewalSetting:
              description: >
                Specifies the type of the terms that follow the first term if
                the subscription is renewed. Only applicable if the type of the
                first term is `TERMED`.


                * `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a
                predefined duration. The first entry in `renewalTerms` specifies
                the duration of the second term of the subscription, the second
                entry in `renewalTerms` specifies the duration of the third term
                of the subscription, and so on. The last entry in `renewalTerms`
                specifies the ultimate duration of each renewal term.

                * `RENEW_TO_EVERGREEN` - The second term of the subscription
                does not have a predefined duration.
              enum:
                - RENEW_WITH_SPECIFIC_TERM
                - RENEW_TO_EVERGREEN
              type: string
            renewalTerms:
              description: >
                List of renewal terms of the subscription. Only applicable if
                the type of the first term is `TERMED` and the value of the
                `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.
              items:
                $ref: '#/components/schemas/RenewalTerm'
              type: array
          required:
            - initialTerm
          type: object
      title: createSubscription
      type: object
    OrderActionObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Order Action object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Order Action object.
      title: orderActionFieldsCustom
      type: object
    OwnerTransfer:
      description: >
        Information about an order action of type `OwnerTransfer`.


        **Note:** The Owner Transfer feature is in **Limited Availability**. If
        you wish to have access to the feature, submit a request at [Zuora
        Global Support](http://support.zuora.com/).
      properties:
        billToContactId:
          description: >
            The contact id of the bill to contact that the subscription is being
            transferred to.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        clearingExistingBillToContact:
          default: false
          description: >
            Whether to clear the existing bill-to contact ID at the subscription
            level. This field is mutually exclusive with the `billToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          description: >
            Whether to clear the existing invoice group number at the
            subscription level. This field is mutually exclusive with the
            `invoiceGroupNumber` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          description: >
            Whether to clear the existing invoice template ID at the
            subscription level. This field is mutually exclusive with the
            `invoiceTemplateId` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          description: >
            Whether to clear the existing payment term at the subscription
            level. This field is mutually exclusive with the `paymentTerm`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSequenceSet:
          default: false
          description: >
            Whether to clear the existing sequence set ID at the subscription
            level. This field is mutually exclusive with the `sequenceSetId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingShipToContact:
          default: false
          description: >
            Whether to clear the existing ship-to contact ID at the subscription
            level. This field is mutually exclusive with the `shipToContactId`
            field.


            **Note:** 
               To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: boolean
        clearingExistingSoldToContact:
          default: false
          description: >
            Whether to clear the existing sold-to contact ID at the subscription
            level. This field is mutually exclusive with the `soldToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        destinationAccountNumber:
          description: >
            The account number of the account that the subscription is being
            transferred to.
          type: string
        destinationInvoiceAccountNumber:
          description: >
            The account number of the invoice owner account that the
            subscription is being transferred to.
          type: string
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the subscription.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          maxLength: 255
          nullable: true
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        paymentProfile:
          description: >
            Container for payment gateway and payment method details of a
            payment. If you do not set this field, the payment method and
            payment gateway values cannot be set in the subscription.


            **Note:**
              - If multiple order actions are specified, they will be applied in the same order they appear in the API payload.
              - If one or more of these order actions include the `paymentProfile` element, the changes will be applied in sequence, and the result will be consistent with the last `paymentProfile` element.
          properties:
            paymentGatewayId:
              description: |
                The ID of the gateway instance that processes the payment.

                This field remains unset, if you do not provide value.
              type: string
            paymentMethodId:
              description: |
                The ID of the payment method.

                This field remains unset, if you do not provide value.
              type: string
          type: object
        paymentTerm:
          description: >
            Name of the payment term associated with the account. For example,
            "Net 30". The payment term determines the due dates of invoices.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the subscription.

            **Note**:
              To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
      title: ownerTransfer
      type: object
    OrderActionRatePlanChargeRemove:
      description: >
        The JSON object containing the information for a charge update(custom
        fields only) in the

        'RemoveProduct' type order action.

        A custom field of rate plan charge can be updated from a subscription
        through one

        order action.

        - If you update customFields of a charge while removing a rate plan,
        specify the following fields:
          - `chargeNumber`
          - `productRatePlanChargeId`
          - `productRatePlanNumber`
          - `uniqueToken`
          - `customFields`
      example:
        chargeNumber: chargeNumber
        productRatePlanChargeId: productRatePlanChargeId
        productRatePlanNumber: productRatePlanNumber
        uniqueToken: uniqueToken
        customFields:
          key: '{}'
      properties:
        chargeNumber:
          description: |
            Read only. Identifies the charge to be updated.
          type: string
        productRatePlanChargeId:
          description: |
            Identifier of the rate plan that was updated.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        uniqueToken:
          description: >
            A unique string to represent the rate plan charge in the order. The
            unique token is used to perform multiple actions against a newly
            added rate plan. For example, if you want to add and update a
            product in the same order, you would assign a unique token to the
            product rate plan when added and use that token in future order
            actions.
          type: string
        customFields:
          additionalProperties:
            description: >
              Custom fields of the Rate Plan Charge 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.
            type: object
          description: |
            Container for custom fields of a Rate Plan Charge object.
          title: ratePlanChargeFieldsCustom
          type: object
      type: object
    RemoveProduct:
      description: |
        Information about an order action of type `RemoveProduct`.
      properties:
        externalCatalogPlanId:
          description: >
            An external ID of the rate plan to be removed. You can use this
            field to specify an existing rate plan in your subscription. The
            value of the `externalCatalogPlanId` field must match one of the
            values that are predefined in the `externallyManagedPlanIds` field
            on a product rate plan. However, if there are multiple rate plans
            with the same `productRatePlanId` value existing in the
            subscription, you must use the `ratePlanId` field to remove the rate
            plan. The `externalCatalogPlanId` field cannot be used to
            distinguish multiple rate plans in this case.


            **Note:** If both `externalCatalogPlanId` and `ratePlanId` are
            provided. They must point to the same product rate plan. Otherwise,
            the request would fail.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            ID of the rate plan to remove. This can be the latest version or any
            history version of ID.
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
        uniqueToken:
          description: >-
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.
          type: string
        customFields:
          additionalProperties:
            description: >
              Custom fields of the Rate Plan 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.
            type: object
          description: |
            Container for custom fields of a Rate Plan object.
          title: RatePlanCustomFields
          type: object
        chargeUpdates:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeRemove'
          type: array
      title: removeProduct
      type: object
    RenewSubscription:
      description: |
        Information about an order action of type `RenewSubscription`.
      properties:
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        clearingExistingBillToContact:
          default: false
          description: >
            Whether to clear the existing bill-to contact ID at the subscription
            level. This field is mutually exclusive with the `billToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          description: >
            Whether to clear the existing invoice group number at the
            subscription level. This field is mutually exclusive with the
            `invoiceGroupNumber` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          description: >
            Whether to clear the existing invoice template ID at the
            subscription level. This field is mutually exclusive with the
            `invoiceTemplateId` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          description: >
            Whether to clear the existing payment term at the subscription
            level. This field is mutually exclusive with the `paymentTerm`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSequenceSet:
          default: false
          description: >
            Whether to clear the existing sequence set ID at the subscription
            level. This field is mutually exclusive with the `sequenceSetId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingShipToContact:
          default: false
          description: >
            Whether to clear the existing ship-to contact ID at the subscription
            level. This field is mutually exclusive with the `shipToContactId`
            field.


            **Note:** 
               To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: boolean
        clearingExistingSoldToContact:
          default: false
          description: >
            Whether to clear the existing sold-to contact ID at the subscription
            level. This field is mutually exclusive with the `soldToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the subscription.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          maxLength: 255
          nullable: true
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For
            example, `Net 30`. The payment term determines the due dates of
            invoices.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body..
          type: string
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.
              
            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the subscription.

            **Note:**
               To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
      title: RenewSubscription
      type: object
    CreateOrderResume:
      description: |
        Information about an order action of type `Resume`.
      properties:
        extendsTerm:
          description: >
            Specifies whether to extend the subscription term by the length of
            time the suspension is in effect.
          type: boolean
        resumePeriods:
          description: >
            This field is applicable only when the `resumePolicy` field is set
            to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must
            be used together with the `resumePeriodsType` field. 


            The total number of the periods used to specify when a subscription
            resumption takes effect. The subscription resumption will take place
            after the specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          type: integer
        resumePeriodsType:
          description: >
            This field is applicable only when the `resumePolicy` field is set
            to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must
            be used together with the `resumePeriods` field.


            The period type used to specify when a subscription resumption takes
            effect. The subscription suspension will take place after the
            specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
        resumePolicy:
          description: >
            Resume methods. Specify a way to resume a subscription. See [Resume
            Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date)
            for more information.


            If `SuspendDate` is specfied, the resumption will take place on the
            same day as the suspension. 
          enum:
            - Today
            - FixedPeriodsFromSuspendDate
            - FixedPeriodsFromToday
            - SpecificDate
            - SuspendDate
          type: string
        resumeSpecificDate:
          description: >
            This field is applicable only when the `resumePolicy` field is set
            to `SpecificDate`.


            A specific date when the subscription resumption takes effect, in
            YYYY-MM-DD format. The value should not be earlier than the
            subscription suspension date.
          format: date
          type: string
      required:
        - resumePolicy
      title: Resume
      type: object
    CreateOrderSuspend:
      description: |
        Information about an order action of type `Suspend`.
      properties:
        suspendPeriods:
          description: >
            This field is applicable only when the `suspendPolicy` field is set
            to `FixedPeriodsFromToday`. It must be used together with the
            `suspendPeriodsType` field. 


            The total number of the periods used to specify when a subscription
            suspension takes effect. The subscription suspension will take place
            after the specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          type: integer
        suspendPeriodsType:
          description: >
            This field is applicable only when the `suspendPolicy` field is set
            to `FixedPeriodsFromToday`. It must be used together with the
            `suspendPeriods` field.


            The period type used to specify when a subscription suspension takes
            effect. The subscription suspension will take place after the
            specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
        suspendPolicy:
          description: >
            Suspend methods. Specify a way to suspend a subscription. See
            [Suspend
            Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date)
            for more information.
          enum:
            - Today
            - EndOfLastInvoicePeriod
            - FixedPeriodsFromToday
            - SpecificDate
          type: string
        suspendSpecificDate:
          description: >
            This field is applicable only when the `suspendPolicy` field is set
            to `SpecificDate`.


            A specific date when the subscription suspension takes effect, in
            YYYY-MM-DD format. The value should not be earlier than the
            subscription's contract effective date or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            than the subscription's term end date.
          format: date
          type: string
      required:
        - suspendPolicy
      title: Suspend
      type: object
    LastTerm:
      description: The length of the period for the current subscription term.
      properties:
        period:
          description: Specify only when the termType is 'TERMED'.
          minimum: 0
          type: integer
        periodType:
          description: Specify only when the termType is 'TERMED'.
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
        startDate:
          description: >
            The start date of the current term. You can change the term start
            date of a renewed subscription through a T&Cs order action. However,
            when changing it to an earlier date, this date must not be earlier
            than the term start date of the current term before this T&Cs.
          format: date
          type: string
        endDate:
          description: |
            The end date of the current term, in YYYY-MM-DD format.
          format: date
          type: string
        termType:
          enum:
            - TERMED
            - EVERGREEN
          type: string
      required:
        - termType
      type: object
    CreateOrderTermsAndConditions:
      description: |
        Information about an order action of type `TermsAndConditions`.
      properties:
        autoRenew:
          type: boolean
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        clearingExistingBillToContact:
          default: false
          description: >
            Whether to clear the existing bill-to contact ID at the subscription
            level. This field is mutually exclusive with the `billToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          description: >
            Whether to clear the existing invoice group number at the
            subscription level. This field is mutually exclusive with the
            `invoiceGroupNumber` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          description: >
            Whether to clear the existing invoice template ID at the
            subscription level. This field is mutually exclusive with the
            `invoiceTemplateId` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          description: >
            Whether to clear the existing payment term at the subscription
            level. This field is mutually exclusive with the `paymentTerm`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSequenceSet:
          default: false
          description: >
            Whether to clear the existing sequence set ID at the subscription
            level. This field is mutually exclusive with the `sequenceSetId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingShipToContact:
          default: false
          description: >
            Whether to clear the existing ship-to contact ID at the subscription
            level. This field is mutually exclusive with the `shipToContactId`
            field.


            **Note**:
              To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: boolean
        clearingExistingSoldToContact:
          default: false
          description: >
            Whether to clear the existing sold-to contact ID at the subscription
            level. This field is mutually exclusive with the `soldToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        communicationProfileId:
          description: >
            The ID of the communication profile associated with the
            subscription.


            **Note**: This field is available in the request body only if you
            have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
            target="_blank">Flexible Billing Attributes</a>
                feature turned on. The value is `null` in the response body without this feature turned on.
          type: string
        clearingExistingCommunicationProfile:
          default: false
          description: >
            Whether to clear the existing communication profile at the
            subscription

            level. This field is mutually exclusive with the
            `communicationProfileId` field.
          type: boolean
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the subscription.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          description: >-
            Specifies whether the subscription appears on a separate invoice
            while generating invoices.
          type: boolean
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        lastTerm:
          $ref: '#/components/schemas/LastTerm'
        paymentProfile:
          description: >
            Container for payment gateway and payment method details of a
            payment. If you do not set this field, the payment method and
            payment gateway values cannot be set in the subscription.


            **Note:**
              - If multiple order actions are specified, they will be applied in the same order they appear in the API payload.
              - If one or more of these order actions include the `paymentProfile` element, the changes will be applied in sequence, and the result will be consistent with the last `paymentProfile` element.
          properties:
            paymentGatewayId:
              description: |
                The ID of the gateway instance that processes the payment.

                This field remains unset, if you do not provide value.
              type: string
            paymentMethodId:
              description: |
                The ID of the payment method.

                This field remains unset, if you do not provide value.
              type: string
          type: object
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For
            example, `Net 30`. The payment term determines the due dates of
            invoices.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        renewalSetting:
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          type: string
        renewalTerms:
          items:
            $ref: '#/components/schemas/RenewalTerm'
          type: array
        scheduledCancelDate:
          description: >
            The date when the subscription is scheduled to be canceled. The
            subscription is not canceled until the date specified in this field.
          format: date
          type: string
        scheduledSuspendDate:
          description: >
            The date when the subscription is scheduled to be suspended. The
            subscription is not suspended until the date specified in this
            field. 
          format: date
          type: string
        scheduledResumeDate:
          description: >
            The date when the subscription is scheduled to be resumed. The
            subscription is not resumed until the date specified in this field. 
          format: date
          type: string
        clearingScheduledCancelDate:
          default: false
          description: >
            Whether to clear the value of the `scheduledCancelDate` field. 


            **Note**: Do not set this field and the `scheduledCancelDate` field
            simultaneously. 
          type: boolean
        clearingScheduledSuspendDate:
          default: false
          description: >
            Whether to clear the value of the `scheduledSuspendDate` field. 


            **Note**: Do not set this field and the `scheduledSuspendDate` field
            simultaneously. 
          type: boolean
        clearingScheduledResumeDate:
          default: false
          description: >
            Whether to clear the value of the `scheduledResumeDate` field.


            **Note**: Do not set this field and the `scheduledResumeDate` field
            simultaneously. 
          type: boolean
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the subscription.

            **Note**:
              To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
      title: termsAndConditions
      type: object
    TriggerDate:
      properties:
        name:
          description: |
            Name of the trigger date of the order action.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
        triggerDate:
          description: |
            Trigger date in YYYY-MM-DD format.
          format: date
          type: string
      title: triggerDate
      type: object
    BillingUpdate:
      properties:
        billingPeriodAlignment:
          description: |
            **Note**: This field is not supported in one time charges.
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
          type: string
      type: object
    DiscountPricingUpdate:
      properties:
        applyDiscountTo:
          description: |
            Specifies which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        discountLevel:
          description: >
            Application scope of the discount charge. For example, if the value
            of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          description: >
            The amount of the discount as a percentage. This field is only used
            for percentage discounts.
          type: number
        priceChangeOption:
          description: >
            Specifies how Zuora changes the price of the charge each time the
            subscription renews.
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      type: object
    RecurringFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
          type: object
    RecurringPerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
            quantity:
              minimum: 0
              type: number
          type: object
    RecurringTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    RecurringVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    PreviewOrderPricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/ChargeModelDataOverride'
          description: >
            Container for charge model configuration data.


            **Note**: This field is only available if you have the High Water
            Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models
            enabled. The High Water Mark and Pre-Rated Pricing charge models are
            available for customers with Enterprise and Nine editions by
            default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountPricingUpdate'
          description: |
            Pricing information about a discount charge.
        recurringFlatFee:
          allOf:
            - $ref: '#/components/schemas/RecurringFlatFeePricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "flat
            fee" charge model. In this charge model, the charge has a fixed
            price.
        recurringPerUnit:
          allOf:
            - $ref: '#/components/schemas/RecurringPerUnitPricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "per
            unit" charge model. In this charge model, the charge has a fixed
            price per unit purchased.
        recurringTiered:
          allOf:
            - $ref: '#/components/schemas/RecurringTieredPricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "tiered
            pricing" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            purchased.
        recurringVolume:
          allOf:
            - $ref: '#/components/schemas/RecurringVolumePricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "volume
            pricing" charge model. In this charge model, the charge has a
            variable price per unit, depending on how many units are purchased.
      type: object
    PreviewOrderChargeUpdate:
      properties:
        billing:
          $ref: '#/components/schemas/BillingUpdate'
        chargeNumber:
          description: >
            The number of the charge to be updated. The value of this field is
            inherited from the `subscriptions` > `orderActions` > `addProduct` >
            `chargeOverrides` > `chargeNumber` field.
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        description:
          type: string
        effectiveDate:
          $ref: '#/components/schemas/PreviewOrderTriggerParams'
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            The value of this field must be a date within the subscription term.
            The system will then automatically calculate the estimated end date
            for the pending charge. The estimated start and end dates are used
            to manage the estimated charge duration and forecast the revenue for
            the pending charge.


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        negotiatedPriceTable:
          description: >
            Array of negotiated price table information. The rate card entries
            provided in the array will override the existing rate card entries
            in the standard price table to form a negotiated price table that
            will be    

            used during pricing evaluation.



            **Note:** To enable the Negotiated Price Table feature, submit a
            request to <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>. 
          items:
            $ref: '#/components/schemas/NegotiatedItems'
          type: array
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).      
          type: number
        pricingAttributes:
          description: >
            Container for pricing attribute and value that provide additional
            context for dynamic pricing. The pricing attribute values included
            in the array will update the existing values. For the pricing
            attribute mapped to a Zuora object field, Zuora will retrieve the
            value automatically, you don’t need to pass its value explicitly. If
            you pass a value that doesn’t match the actual value of the Zuora
            object, an error will be returned.

            Note that for any pricing attribute mapped to the field of Zuora
            object Usage, because its value is only determined when the usage
            record arrives, you can’t provide a value via Orders API payload and
            Zuora will not retrieve its value automatically.




            **Note:** To enable Dynamic Pricing, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.              
          type: object
          additionalProperties: true
        pricing:
          allOf:
            - $ref: '#/components/schemas/PreviewOrderPricingUpdate'
          description: |
            Pricing information about the charge.
        productRatePlanChargeId:
          description: >
            ID of a product rate plan charge for this subscription. When
            `isAddingSubsetCharges` is set to true, the product rate charge
            specified by `productRatePlanChargeId` is added to the existing rate
            plan specified by `ratePlanId`.
          type: string
        productRatePlanChargeNumber:
          description: >
            Number of a product rate plan charge for this subscription. When
            `isAddingSubsetCharges` is set to true, the product rate charge
            specified by `productRatePlanChargeNumber` is added to the existing
            rate plan specified by `ratePlanId`.
          type: string
        uniqueToken:
          description: >
            A unique string to represent the rate plan charge in the order. The
            unique token is used to perform multiple actions against a newly
            added rate plan charge. For example, if you want to add and update a
            product in the same order, assign a unique token to the newly added
            rate plan charge and use that token in future order actions.
          type: string
      type: object
    PreviewOrderRatePlanUpdate:
      description: |
        Information about an order action of type `UpdateProduct`.
      properties:
        chargeUpdates:
          description: >
            Array of the JSON objects containing the information for a charge
            update in the `updateProduct` type of order action.


            When previewing an `updateProduct` order action, either the
            `chargeNumber` or `uniqueToken` field is required to specify the
            charge to update.
          items:
            $ref: '#/components/schemas/PreviewOrderChargeUpdate'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        isAddingSubsetCharges:
          description: >
            Specifies whether to add a subset of charges to the subscription.



            **Note:** To access this field for adding a subset of charges,
            submit a request at <a href="http://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            The id of the rate plan to be updated. It can be the latest version
            or any history version id.
          type: string
        specificUpdateDate:
          description: >
            The specific date when the Update Product order action takes
            effect.  This field allows you to update a charge before a
            future-dated Update Product order action on the subscription. The
            format of the date is yyyy-mm-dd.


            **Note**: After you use this option, the charge's `TriggerEvent`
            field value will be changed to `SpecificDate`. 


            See [Update a Product on Subscription with Future-dated
            Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates)
            for more information about this feature.
          format: date
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
        uniqueToken:
          description: >
            A unique string to represent the rate plan in the order. The unique
            token is used to perform multiple actions against a newly added rate
            plan. For example, if you want to add and update a product in the
            same order, assign a unique token to the newly added rate plan and
            use that token in future order actions.
          type: string
      title: updateProduct
      type: object
    PreviewOrderOrderAction:
      properties:
        addProduct:
          $ref: '#/components/schemas/PreviewOrderRatePlanOverride'
        cancelSubscription:
          $ref: '#/components/schemas/CancelSubscription'
        changePlan:
          $ref: '#/components/schemas/PreviewOrderCreateChangePlan'
        changeReason:
          description: |
            The change reason set for an order action when an order is created.
          type: string
        createSubscription:
          $ref: '#/components/schemas/PreviewOrderCreateSubscription'
        customFields:
          $ref: '#/components/schemas/OrderActionObjectCustomFields'
        ownerTransfer:
          $ref: '#/components/schemas/OwnerTransfer'
        removeProduct:
          $ref: '#/components/schemas/RemoveProduct'
        renewSubscription:
          $ref: '#/components/schemas/RenewSubscription'
        resume:
          $ref: '#/components/schemas/CreateOrderResume'
        suspend:
          $ref: '#/components/schemas/CreateOrderSuspend'
        termsAndConditions:
          $ref: '#/components/schemas/CreateOrderTermsAndConditions'
        triggerDates:
          description: >
            Container for the contract effective, service activation, and
            customer acceptance dates of the order action. 


            If the service activation date is set as a required field in Default
            Subscription Settings, skipping this field in a `CreateSubscription`
            order action of your JSON request will result in a `Pending` order
            and a `Pending Activation` subscription.


            If the customer acceptance date is set as a required field in
            Default Subscription Settings, skipping this field in a
            `CreateSubscription` order action of your JSON request will result
            in a `Pending` order and a `Pending Acceptance` subscription. If the
            service activation date field is at the same time required and
            skipped (or set as null), it will be a `Pending Activation`
            subscription.
          items:
            $ref: '#/components/schemas/TriggerDate'
          type: array
        type:
          description: >
            Type of order action.


            Unless the type of order action is `RenewSubscription`, you must use
            the corresponding field to provide information about the order
            action. For example, if the type of order action is `AddProduct`,
            you must set the `addProduct` field.


            Zuora returns an error if you set a field that corresponds to a
            different type of order action. For example, if the type of order
            action is `AddProduct`, Zuora returns an error if you set the
            `updateProduct` field.


            **Note**: The change plan type of order action is supported for the 
            <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature. However, it is
            currently not supported for the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> feature. When
            Billing - Revenue Integration is enabled, the change plan type of
            order action will no longer be applicable in Zuora Billing.
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        updateProduct:
          $ref: '#/components/schemas/PreviewOrderRatePlanUpdate'
      required:
        - type
      type: object
    QuoteObjectFields:
      description: >
        The fields populated for a quote when a quote is sent to Zuora Billing
        from Zuora Quote.
      properties:
        OpportunityCloseDate__QT:
          description: >
            The closing date of the Opportunity.


            This field is used in Zuora Reporting Data Sources to report on
            Subscription metrics.


            If the subscription was originated from Zuora Quotes, the value is
            populated with the value from Zuora Quotes.
          type: string
        OpportunityName__QT:
          description: >
            The unique identifier of the Opportunity. 


            This field is used in the Zuora Reporting Data Sources to report on
            Subscription metrics.


            If the subscription was originated from Zuora Quotes, the value is
            populated with the value from Zuora Quotes.


            **Character limit**: 100
          type: string
        QuoteBusinessType__QT:
          description: >
            The specific identifier for the type of business transaction the
            Quote represents such as New, Upsell, Downsell, Renewal or Churn.


            This field is used in the Zuora Reporting Data Sources to report on
            Subscription metrics.


            If the subscription was originated from Zuora Quotes, the value is
            populated with the value from Zuora Quotes.


            **Character limit**: 32
          type: string
        QuoteNumber__QT:
          description: >
            The unique identifier of the Quote.


            This field is used in the Zuora Reporting Data Sources to report on
            Subscription metrics.


            If the subscription was originated from Zuora Quotes, the value is
            populated with the value from Zuora Quotes.


            **Character limit**: 32
          type: string
        QuoteType__QT:
          description: >
            The Quote type that represents the subscription lifecycle stage such
            as New, Amendment, Renew or Cancel.


            This field is used in the Zuora Reporting Data Sources to report on
            Subscription metrics.


            If the subscription was originated from Zuora Quotes, the value is
            populated with the value from Zuora Quotes.


            **Character limit**: 32
          type: string
      title: quote
      type: object
    RampChargeRequest:
      properties:
        chargeNumber:
          description: The number of the rate plan charge.
          type: string
        uniqueToken:
          description: >
            Unique identifier for the charge. This identifier enables you to
            refer to the charge before the charge has an internal identifier in
            Zuora.
          type: string
      title: RampCharge
      type: object
    RampIntervalRequest:
      description: >
        Container for the intervals that the ramp is split into in its timeline.
        Zuora can report metrics for this specific period.
      properties:
        description:
          description: The short description of the interval.
          type: string
        endDate:
          description: The end date of the interval.
          format: date
          type: string
        name:
          description: The name of the interval.
          type: string
        startDate:
          description: The start date of the interval.
          format: date
          type: string
      required:
        - startDate
        - endDate
      title: intervals
      type: object
    RampRequest:
      description: >
        Container of the ramp definitions. It is used to create, update, or
        remove the ramp definition for the new subscription.
      properties:
        charges:
          description: >
            Container for the rate plan charges that are considered as part of
            the ramp deal.


            * If this field is not specified, all the one-time and recurring
            regular charges of the new subscription are automatically considered
            as part of the ramp deal.

            * If this field is specified, either 'chargeNumber' or 'uniqueToken'
            must be specified.
          items:
            $ref: '#/components/schemas/RampChargeRequest'
          type: array
        delete:
          description: >
            Whether to remove the ramp definition from the new subscription. If
            you want to remove the ramp definition, this field is the only
            required field for the `ramp` object.  
          type: boolean
        description:
          description: The short description of the ramp.
          type: string
        intervals:
          description: >
            Container for the intervals that the ramp is split into in its
            timeline. 


            It is required when you want to create or update the ramp
            definition. The ramp intervals cannot have any overlap or gap
            between each other.
          items:
            $ref: '#/components/schemas/RampIntervalRequest'
          type: array
        name:
          description: The name of the ramp.
          type: string
      title: Ramp
      type: object
    POSTOrderPreviewRequestType:
      example:
        existingAccountNumber: A00000097
        orderDate: '2024-07-01'
        previewOptions:
          previewTypes:
            - BillingDocs
          previewThruType: SpecificDate
          specificPreviewThruDate: '2024-07-31'
        subscriptions:
          - orderActions:
              - type: CreateSubscription
                createSubscription:
                  terms:
                    initialTerm:
                      period: 12
                      periodType: Month
                      termType: TERMED
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerms:
                      period: 12
                      periodType: Month
                  subscribeToRatePlans:
                    - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4
                triggerDates:
                  - name: ContractEffective
                    triggerDate: '2024-07-01'
                  - name: ServiceActivation
                    triggerDate: '2024-07-01'
                  - name: CustomerAcceptance
                    triggerDate: '2024-07-01'
      properties:
        category:
          default: NewSales
          description: >
            Category of the order to indicate a product sale or return. Default
            value is `NewSales`.
          enum:
            - NewSales
            - Return
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        description:
          description: A description of the order.
          maxLength: 500
          type: string
        existingAccountId:
          description: >
            The account ID under which this order will be created.  This field
            sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order.  To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field. 


            **Note:** You can specify either the `existingAccountNumber` or
            `existingAccountId` field, but not both.
          type: string
        existingAccountNumber:
          description: >
            The account number under which this order will be created.  This
            field sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order. To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field.
          maxLength: 70
          type: string
        orderDate:
          description: >-
            The date when the order is signed. All of the order actions under
            this order will use this order date as the contract effective date.
          format: date
          type: string
        orderLineItems:
          description: >
            [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            are non subscription based items created by an Order, representing
            transactional charges such as one-time fees, physical goods, or
            professional service charges that are not sold as subscription
            services. 


            With the Order Line Items feature enabled, you can now launch
            non-subscription and unified monetization business models in Zuora,
            in addition to subscription business models. 


            If you do not have the **Create Order Line Items Without Product
            Catalog** billing permission, you can only create order  line items
            from existing products by specifying the product rate plan charge ID
            in the `productRatePlanChargeId` field.  For more information about
            billing permissions, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/System_Management/Administrator_Settings/User_Roles/d_Billing_Roles"
            target="_blank">Billing Roles</a>.


            **Note:** The [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature is now generally available to all Zuora customers. You need
            to enable the
            [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
            feature to access the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature. As of Zuora Billing Release 313 (November 2021), new
            customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            will have the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
            feature enabled by default.        
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          description: >
            The order number of this order.   

            **Note:** The characters `#`, `?`, and `/` are not allowed in this
            field. Additionally, to ensure compatibility with the UI when
            viewing orders, use only the following special characters: `_`,`-`,
            `.`, `~`, `*`, `(`, `)`, and `'`.
          maxLength: 100
          type: string
        previewAccountInfo:
          $ref: '#/components/schemas/PreviewAccountInfo'
        previewOptions:
          $ref: '#/components/schemas/PreviewOptions'
        reasonCode:
          description: >
            Values of reason code configured in **Billing Settings** >
            **Configure Reason Codes** through Zuora UI. Indicates the reason
            when a return order line item occurs.
          maxLength: 255
          type: string
        subscriptions:
          description: >-
            Each item includes a set of order actions, which will be applied to
            the same base subscription. When you create an order that involves
            multiple subscriptions, these subscriptions can have different
            invoice owner accounts or subscription owner accounts. 
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                description: >
                  Notes about the subscription. These notes are only visible to
                  Zuora users. Notes set in this field will override the value
                  of the `notes` field within the createSubscription order
                  action.
                type: string
                maxLength: 1000
              orderActions:
                description: >-
                  The actions to be applied to the subscription. Order actions
                  will be stored with the sequence when it was provided in the
                  request.
                items:
                  $ref: '#/components/schemas/PreviewOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                description: >
                  Leave this field empty to represent new subscription creation,
                  or specify a subscription number to update an existing
                  subscription.
                type: string
            type: object
          type: array
      required:
        - orderDate
        - previewOptions
      type: object
    ChargePreviewMetrics:
      properties:
        chargeNumber:
          type: string
        cmrr:
          properties:
            discount:
              description: >-
                Total discountCmrr of all discount charges which are applied to
                one specific recurring charge. This value is calculated from the
                rating results for the latest subscription version in the order.
                Only selects the applied discount charge when its
                endDateCondition is "Subscription_End".
              type: number
            discountDelta:
              description: >-
                Delta discountCmrr value between the order base and the latest
                subscription version.
              type: number
            regular:
              type: number
            regularDelta:
              type: number
          type: object
        originRatePlanId:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanId:
          type: string
        subscriptionRatePlanNumber:
          type: string
          description: |
            Number of a subscription rate plan for this subscription.
        tax:
          properties:
            discount:
              description: >-
                Total tax amount of all discount charges which are applied to
                one specific recurring charge. This value is calculated from the
                rating results for the latest subscription version in the order.
              type: number
            discountDelta:
              description: >-
                Delta discount TAX value between the base and the latest
                subscription version in the order for the specific recurring
                charge.
              type: number
            regular:
              type: number
            regularDelta:
              description: >-
                Delta tax value between the base and the latest subscription
                version in the order.
              type: number
          type: object
        tcb:
          properties:
            discount:
              description: >-
                Total contract billing amount of all discount charges which are
                applied to one specific recurring charge. This value is
                calculated from the rating results for the latest subscription
                version in the order.
              type: number
            discountDelta:
              description: >-
                Delta discount TCB value between the base and the latest
                subscription version for specific recurring charge in the order.
              type: number
            regular:
              type: number
            regularDelta:
              description: >-
                Delta TCB value between the base and the latest subscription
                version in the order.
              type: number
          type: object
        tcv:
          properties:
            discount:
              description: Always equals to discountTcb.
              type: number
            discountDelta:
              description: Always equals to delta discountTcb.
              type: number
            regular:
              type: number
            regularDelta:
              type: number
          type: object
      type: object
    InvoiceItemPreviewResult:
      properties:
        additionalInfo:
          properties:
            numberOfDeliveries:
              description: >
                The number of deliveries dedicated to the Delivery Pricing
                charges. 

                **Note**: This field is available only if you have the Delivery
                Pricing feature enabled.
              type: number
            quantity:
              type: number
            unitOfMeasure:
              type: string
          type: object
        amountWithoutTax:
          type: number
        appliedToChargeNumber:
          description: >-
            Available when the chargeNumber of the charge that discount applies
            to was specified in the request or when the order is amending an
            existing subscription.
          type: string
        chargeDescription:
          type: string
        chargeName:
          type: string
        chargeNumber:
          description: >-
            Available when the `chargeNumber` field was specified in the request
            or when the order is amending an existing subscription.
          type: string
          nullable: true
        orderLineItemNumber:
          description: >-
            A sequential number auto-assigned for each of order line items in a
            order, used as an index, for example, "1".
          type: string
          nullable: true
        processingType:
          enum:
            - Charge
            - Discount
            - Tax
          type: string
        productName:
          type: string
        productRatePlanChargeId:
          type: string
          description: >
            The product rate plan charge ID in this `productRatePlanChargeId`
            field belongs to a product rate plan specified through the
            `subscribeToRatePlans` > `productRatePlanId` field. 

            Therefore, this `productRatePlanChargeId` field has a value only
            when the `subscribeToRatePlans` > `productRatePlanId` field is
            specified during the subscription creation. 

            This `productRatePlanChargeId` field does not indicate a product
            rate plan charge associated with an order line item.
        serviceEndDate:
          format: date
          type: string
        serviceStartDate:
          format: date
          type: string
        subscriptionNumber:
          type: string
          nullable: true
          description: |
            The number of the subscription.
        taxAmount:
          type: number
        taxationItems:
          description: >
            List of taxation items.


            **Note**: This field is available only if you are on the latest
            Zuora API minor version, or you set the `Zuora-Version` request
            header to `309.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          items:
            properties:
              exemptAmount:
                description: |
                  The calculated tax amount excluded due to the exemption.
                type: number
              id:
                description: |
                  The ID of the taxation item.
                type: string
              jurisdiction:
                description: >
                  The jurisdiction that applies the tax or VAT. This value is
                  typically a state, province, county, or city.
                type: string
              locationCode:
                description: >
                  The identifier for the location based on the value of the
                  taxCode field.
                type: string
              name:
                description: |
                  The name of the taxation item.
                type: string
              taxAmount:
                description: |
                  The amount of the tax applied to the invoice.
                type: number
              taxCode:
                description: >
                  The tax code identifies which tax rules and tax rates to apply
                  to a specific invoice.
                type: string
              taxCodeDescription:
                description: |
                  The description of the tax code.
                type: string
              taxDate:
                description: |
                  The date when the tax is applied to the invoice.
                type: string
              taxRate:
                description: |
                  The tax rate applied to the invoice.
                type: number
              taxRateDescription:
                description: |
                  The description of the tax rate.
                type: string
              taxRateType:
                description: >
                  Enum:"Percentage" "FlatFee". The type of the tax rate applied
                  to the invoice.
                enum:
                  - Percentage
                  - FlatFee
                type: string
            type: object
          type: array
        unitPrice:
          description: |
            The per-unit price of the invoice item.
          type: number
      type: object
    InvoiceItemSummary:
      type: object
      properties:
        previewInvoiceSequence:
          type: number
          description: |
            The sequence number of the invoice to be billed.
        subTotal:
          type: number
          format: double
          description: |
            The aggregated subtotal amount of the invoice.
        discountAmount:
          type: number
          format: double
          description: |
            The aggregated discount amount of the invoice.
        taxAmount:
          type: number
          format: double
          description: |
            The aggregated tax amount of the invoice.
        total:
          type: number
          format: double
          description: |
            The aggregated total amount of the invoice.
        servicePeriodStartDate:
          type: string
          format: date
          description: |
            The start date of the period being billed.
        servicePeriodEndDate:
          type: string
          format: date
          description: |
            The end date of the period being billed.
    OrderDeltaMetric:
      properties:
        chargeNumber:
          description: >
            The charge number for the associated Rate Plan Charge. This field
            can be null if the metric is generated for an Order Line Item.
          type: string
        currency:
          description: |
            ISO 3-letter currency code (uppercase). For example, USD.
          type: string
        endDate:
          description: |
            The end date for the order delta metric.
          format: date
          type: string
        grossAmount:
          description: >
            The gross amount for the metric. The is the amount excluding applied
            discount.
          type: number
        netAmount:
          description: >
            The net amount for the metric. The is the amount with discounts
            applied
          type: number
        orderActionId:
          description: >
            The Id for the related Order Action. This field can be null if the
            metric is generated for an Order Line Item.
          type: string
        orderActionSequence:
          description: >
            The sequence for the related Order Action. This field can be null if
            the metric is generated for an Order Line Item.
          type: string
        orderActionType:
          description: >
            The type for the related Order Action. This field can be null if the
            metric is generated for an Order Line Item.
          type: string
        orderLineItemNumber:
          description: >
            A sequential number auto-assigned for each of order line items in a
            order, used as an index, for example, "1".
          type: string
        productRatePlanChargeId:
          description: >
            The Id for the associated Product Rate Plan Charge. This field can
            be null if the Order Line Item is not associated with a Product Rate
            Plan Charge.
          type: string
        ratePlanChargeId:
          description: >
            The id for the associated Rate Plan Charge. This field can be null
            if the metric is generated for an Order Line Item.
          type: string
        startDate:
          description: |
            The start date for the order delta metric.
          format: date
          type: string
        subscriptionNumber:
          description: >
            The number of the subscription. This field can be null if the metric
            is generated for an Order Line Item.
          type: string
      type: object
    OrderDeltaMrr:
      allOf:
        - $ref: '#/components/schemas/OrderDeltaMetric'
      description: >
        Order Delta Mrr. This is a metric that reflects the change to the TCV on
        rate plan charge object as the result of the order.
      type: object
    OrderDeltaTcb:
      allOf:
        - $ref: '#/components/schemas/OrderDeltaMetric'
        - properties:
            orderLineItemId:
              description: >
                The sytem generated Id for the Order Line Item. This field can
                be null if the metric is generated for a Rate Plan Charge.
              format: UUID
              type: string
          type: object
      description: >
        Order Delta Tcb. This is a metric that reflects the change to the
        estimated billing on Rate Plan Charge object, or the estimated billing
        for an Order Line Item as the result of the order
      type: object
    OrderDeltaTcv:
      allOf:
        - $ref: '#/components/schemas/OrderDeltaMetric'
        - properties:
            orderLineItemId:
              description: >
                The sytem generated Id for the Order Line Item. This field can
                be null if the metric is generated for subscriptions.
              format: UUID
              type: string
          type: object
      description: >
        Order Delta Tcv. This is a metric that reflects the change to the TCV on
        Rate Plan Charge object, or the Total Contracted Value for an Order Line
        Item as the result of the order
      type: object
    OrderItem:
      description: "Represents an order item. An order item is a sales item within an order in the context of the recurring subscription business model. It can be a unit of products or a service, but defined by both quantity and term (the start and end dates).\_\n\nFor the one time and the recurring charge types, if an order action causes a quantity metric creation (when the delta quantity equals to or is greater than zero), an order item is created.\n\nThe following order actions will create an order item for the one time and recurring charges. The other order actions will refer to an existing order item. Also, the Owner Transfer order action always creates an order item whose quantity field is zero.\n\n  * Create Subscription\n  * Terms and Conditions - Extend Term\n  * Renewal\n  * Update Product - Increase Quantity\n  * Add product\n  * Owner Transfer\n\nFor the usage charge type, if the order action causes a usage increase, an order item is created, and the quantity field of the order item is always zero.\n\nThe following order actions will create an order item for for the usage charges.\n\n  * Create Subscription\n  * Terms and Conditions - Extend Term\n  * Renewal\n  * Add product\n  * Owner Transfer\n"
      properties:
        endDate:
          description: >-
            The order item's effective end date, aligned with the end date of an
            increased quantity order metrics.
          format: date
          type: string
        id:
          description: The ID of the order item.
          type: string
        orderActionId:
          description: Specify the order action that creates this order item.
          type: string
        quantity:
          description: >-
            The order item quantity. For the usage charge type, the value of
            this field is always zero. Also, the Owner Transfer order action
            always creates an order item whose Quantity field is zero.
          type: number
        scId:
          description: >-
            The ID of the charge segment that gets newly generated when the
            order item is created.
          type: string
        startDate:
          description: >-
            The order item's effective start date, aligned with the start date
            of an increased quantity order metrics.
          format: date
          type: string
      type: object
    TimeSlicedElpNetMetrics:
      properties:
        amount:
          description: >-
            The extended list price which is calculated by the original product
            catalog list price multiplied by the delta quantity.
          type: number
        endDate:
          description: The latest date that the metric applies.
          format: date
          type: string
        generatedReason:
          description: >
            Specify the reason why the metrics are generated by the certain
            order action.
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          description: >-
            The acount number of the billing account that is billed for the
            subscription.
          type: string
        orderItemId:
          description: The ID of the order item referenced by the order metrics.
          type: string
        startDate:
          description: The earliest date that the metric applies.
          format: date
          type: string
        subscriptionOwner:
          description: The acount number of the billing account that owns the subscription.
          type: string
        tax:
          description: The tax amount in the metric when the tax permission is enabled.
          type: number
        termNumber:
          format: long
          type: number
        type:
          description: The type for ELP is always "Regular".
          enum:
            - Regular
            - Discount
          type: string
      type: object
    TimeSlicedNetMetrics:
      properties:
        amount:
          type: number
        discountChargeNumber:
          type: string
        endDate:
          format: date
          type: string
        generatedReason:
          description: >
            Specify the reason why the metrics are generated by the certain
            order action.


            This field is only available to existing Orders customers who
            already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          description: >-
            The acount number of the billing account that is billed for the
            subscription.
          type: string
        orderItemId:
          description: >
            The ID of the order item referenced by the order metrics.


            This field is only available to existing Orders customers who
            already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          type: string
        startDate:
          format: date
          type: string
        subscriptionOwner:
          description: The acount number of the billing account that owns the subscription.
          type: string
        termNumber:
          format: long
          type: number
        type:
          description: >-
            Indicates whether this metrics is for a regular charge or a discount
            charge.
          enum:
            - Regular
            - Discount
          type: string
      type: object
    TimeSlicedMetrics:
      properties:
        amount:
          type: number
        endDate:
          format: date
          type: string
        generatedReason:
          description: >
            Specify the reason why the metrics are generated by the certain
            order action.


            This field is only available to existing Orders customers who
            already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          description: >-
            The acount number of the billing account that is billed for the
            subscription.
          type: string
        orderItemId:
          description: >
            The ID of the order item referenced by the order metrics.


            This field is only available to existing Orders customers who
            already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          type: string
        startDate:
          format: date
          type: string
        subscriptionOwner:
          description: The acount number of the billing account that owns the subscription.
          type: string
        termNumber:
          format: long
          type: number
      type: object
    TimeSlicedTcbNetMetrics:
      properties:
        amount:
          type: number
        discountChargeNumber:
          type: string
        endDate:
          format: date
          type: string
        generatedReason:
          description: >
            Specify the reason why the metrics are generated by the certain
            order action.


            This field is only available to existing Orders customers who
            already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          enum:
            - IncreaseQuantity
            - DecreaseQuantity
            - ChangePrice
            - Extension
            - Contraction
          type: string
        invoiceOwner:
          description: >-
            The acount number of the billing account that is billed for the
            subscription.
          type: string
        orderItemId:
          description: >
            The ID of the order item referenced by the order metrics.


            This field is only available to existing Orders customers who
            already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          type: string
        startDate:
          format: date
          type: string
        subscriptionOwner:
          description: The acount number of the billing account that owns the subscription.
          type: string
        tax:
          type: number
        termNumber:
          format: long
          type: number
        type:
          description: >-
            Indicates whether this metrics is for a regular charge or a discount
            charge.
          enum:
            - Regular
            - Discount
          type: string
      type: object
    orderMetric:
      description: The set of order metrics for an order action.
      properties:
        chargeNumber:
          type: string
        elp:
          description: >
            The extended list price which is calculated by the original product
            catalog list price multiplied by the delta quantity.


            The `elp` nested field is only available to existing Orders
            customers who already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          items:
            $ref: '#/components/schemas/TimeSlicedElpNetMetrics'
          type: array
        mrr:
          items:
            $ref: '#/components/schemas/TimeSlicedNetMetrics'
          type: array
        originRatePlanId:
          type: string
        productRatePlanChargeId:
          type: string
        productRatePlanId:
          type: string
        subscriptionRatePlanNumber:
          type: string
          description: |
            Number of a subscription rate plan for this subscription.
        quantity:
          items:
            $ref: '#/components/schemas/TimeSlicedMetrics'
          type: array
        tcb:
          description: >-
            Total contracted billing which is the forecast value for the total
            invoice amount.
          items:
            $ref: '#/components/schemas/TimeSlicedTcbNetMetrics'
          type: array
        tcv:
          description: Total contracted value.
          items:
            $ref: '#/components/schemas/TimeSlicedNetMetrics'
          type: array
      type: object
    RampIntervalChargeDeltaMetrics:
      properties:
        chargeNumber:
          description: The number of the rate plan charge.
          type: string
        deltaDiscountTcb:
          description: The discount delta amount for the TCB.
          type: number
        deltaDiscountTcv:
          description: The discount delta amount for the TCV.
          type: number
        deltaGrossTcb:
          description: The TCB delta value before discount charges are applied.
          type: number
        deltaGrossTcv:
          description: The TCV delta value before discount charges are applied.
          type: number
        deltaMrr:
          description: >-
            The MRR changing history of the current rate plan charge in the
            current ramp interval.
          items:
            properties:
              discount:
                description: The discount delta amount for the MRR.
                type: number
              endDate:
                description: The end date.
                format: date
                type: string
              gross:
                description: The MRR delta amount before discounts charges are applied.
                type: number
              net:
                description: The MRR delta amount after discounts charges are applied.
                type: number
              startDate:
                description: The start date.
                format: date
                type: string
            type: object
          type: array
        deltaNetTcb:
          description: The TCB delta value after discount charges are applied.
          type: number
        deltaNetTcv:
          description: The TCV delta value after discount charges are applied.
          type: number
        deltaQuantity:
          description: >-
            The charge quantity changing history of the current rate plan charge
            in the current ramp interval.
          items:
            properties:
              amount:
                description: The delta amount of the charge quantity.
                type: number
              endDate:
                description: The end date.
                format: date
                type: string
              startDate:
                description: The start date.
                format: date
                type: string
            type: object
          type: array
        productRatePlanChargeId:
          description: The ID of the corresponding product rate plan charge.
          type: string
        subscriptionNumber:
          description: >-
            The number of the subscription that the current rate plan charge
            belongs to.
          type: string
      title: intervalDeltaMetrics
      type: object
    RampIntervalChargeMetrics:
      properties:
        chargeNumber:
          description: The number of the charge.
          type: string
        discountTcb:
          description: The discount amount for the TCB.
          type: number
        discountTcv:
          description: The discount amount for the TCV.
          type: number
        endDate:
          description: The end date of the rate plan charge in the current ramp interval.
          format: date
          type: string
        grossTcb:
          description: The gross TCB value before discount charges are applied.
          type: number
        grossTcv:
          description: The gross TCV value before discount charges are applied.
          type: number
        mrr:
          description: >-
            The MRR changing history of the current rate plan charge in the
            current ramp interval.
          items:
            properties:
              discount:
                description: The discount amount for the MRR.
                type: number
              endDate:
                description: The end date.
                format: date
                type: string
              gross:
                description: The gross MRR amount before discounts charges are applied.
                type: number
              net:
                description: The net MRR amount after discounts charges are applied.
                type: number
              startDate:
                description: The start date.
                format: date
                type: string
            type: object
          type: array
        netTcb:
          description: The net TCB value after discount charges are applied.
          type: number
        netTcv:
          description: The net TCV value after discount charges are applied.
          type: number
        productRatePlanChargeId:
          description: The ID of the corresponding product rate plan charge.
          type: string
        quantity:
          description: The quantity of the rate plan charge.
          type: number
        ratePlanChargeId:
          description: The ID of the rate plan charge.
          type: string
        startDate:
          description: The start date of the rate plan charge in the current ramp interval.
          format: date
          type: string
        subscriptionNumber:
          description: >-
            The number of the subscription that the current rate plan charge
            belongs to.
          type: string
      title: intervalMetrics
      type: object
    OrderRampIntervalMetrics:
      properties:
        description:
          description: The short description of the interval.
          type: string
        discountTcb:
          description: The discount amount for the TCB.
          type: number
        discountTcv:
          description: The discount amount for the TCV.
          type: number
        endDate:
          description: The end date of the interval.
          format: date
          type: string
        grossTcb:
          description: The gross TCB value before discount charges are applied.
          type: number
        grossTcv:
          description: The gross TCV value before discount charges are applied.
          type: number
        intervalDeltaMetrics:
          description: >-
            Container for the delta metrics for each rate plan charge in each
            ramp interval. The delta is the difference of the subscription
            metrics between before and after the order.
          items:
            $ref: '#/components/schemas/RampIntervalChargeDeltaMetrics'
          type: array
        intervalMetrics:
          description: >-
            Container for the detailed metrics for each rate plan charge in each
            ramp interval.
          items:
            $ref: '#/components/schemas/RampIntervalChargeMetrics'
          type: array
        name:
          description: The name of the interval.
          type: string
        netTcb:
          description: The net TCB value after discount charges are applied.
          type: number
        netTcv:
          description: The net TCV value after discount charges are applied.
          type: number
        startDate:
          description: The start date of the interval.
          format: date
          type: string
      title: RampIntervalMetrics
      type: object
    OrderRampMetrics:
      properties:
        description:
          description: The short description of the ramp.
          type: string
        discountTcb:
          description: The discount amount for the TCB.
          type: number
        discountTcv:
          description: The discount amount for the TCV.
          type: number
        grossTcb:
          description: The gross TCB value before discount charges are applied.
          type: number
        grossTcv:
          description: The gross TCV value before discount charges are applied.
          type: number
        intervals:
          description: The ramp metrics for each ramp intervals in its timeline.
          items:
            $ref: '#/components/schemas/OrderRampIntervalMetrics'
          type: array
        name:
          description: The name of the ramp.
          type: string
        netTcb:
          description: The net TCB value after discount charges are applied.
          type: number
        netTcv:
          description: The net TCV value after discount charges are applied.
          type: number
        number:
          description: >-
            The number of the ramp. It is automaticcally generated by the
            billing system.
          type: string
      title: RampMetrics
      type: object
    PreviewOrderResult:
      description: >-
        The result of each type of preview. Returned only when the current
        request is preview call.
      properties:
        chargeMetrics:
          items:
            properties:
              charges:
                items:
                  $ref: '#/components/schemas/ChargePreviewMetrics'
                type: array
              subscriptionNumber:
                description: >-
                  The number of the subscription that has been affected by this
                  order. When creating a subscription, this value will not show
                  if the subscription number was not specified in the request.
                type: string
            type: object
          type: array
        creditMemos:
          description: >-
            This field is only available if you have the Invoice Settlement
            feature enabled.
          items:
            properties:
              amount:
                type: number
              amountWithoutTax:
                type: number
              creditMemoItems:
                items:
                  $ref: '#/components/schemas/InvoiceItemPreviewResult'
                type: array
              targetDate:
                format: date
                type: string
              taxAmount:
                type: number
            type: object
          type: array
        invoices:
          items:
            properties:
              amount:
                type: number
                description: |
                  The total amount of the invoice.
              amountWithoutTax:
                type: number
                description: |
                  The amount of the invoice without tax.
              invoiceItems:
                description: |
                  The invoice items on the invoice.
                items:
                  $ref: '#/components/schemas/InvoiceItemPreviewResult'
                type: array
              targetDate:
                format: date
                type: string
                description: |
                  The target date to bill the invoice.
              taxAmount:
                type: number
                description: |
                  The total tax amount of the invoice.
              invoiceItemSummary:
                type: array
                description: >
                  The aggregated summary data for all future invoices to be
                  billed within the preview period.


                  This field is returned only if you set the
                  `summarizeInvoiceItem` query parameter to `true`.
                items:
                  $ref: '#/components/schemas/InvoiceItemSummary'
            type: object
          type: array
        orderDeltaMetrics:
          description: >
            **Note:** As of Zuora Billing Release 306, Zuora has upgraded the
            methodologies for calculating metrics in
            [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders).
            The new methodologies are reflected in the following Order Delta
            Metrics objects. 

            * [Order Delta
            Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)

            * [Order Delta
            Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)

            * [Order Delta
            Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)


            It is recommended that all customers use the new [Order Delta
            Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics).
            If you are an existing [Order
            Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders)
            customer and want to migrate to Order Delta Metrics, submit a
            request at [Zuora Global Support](https://support.zuora.com/).
          properties:
            orderDeltaMrr:
              items:
                $ref: '#/components/schemas/OrderDeltaMrr'
              type: array
            orderDeltaTcb:
              items:
                $ref: '#/components/schemas/OrderDeltaTcb'
              type: array
            orderDeltaTcv:
              items:
                $ref: '#/components/schemas/OrderDeltaTcv'
              type: array
          type: object
        orderMetrics:
          description: >
            **Note:** As of Zuora Billing Release 306, Zuora has upgraded the
            methodologies for calculating metrics in
            [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders).
            The new methodologies are reflected in the following Order Delta
            Metrics objects.  

            * [Order Delta
            Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr) 

            * [Order Delta
            Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv) 

            * [Order Delta
            Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb) 


            It is recommended that all customers use the new [Order Delta
            Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics).
            If you are an existing [Order
            Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders)
            customer and want to migrate to Order Delta Metrics, submit a
            request at [Zuora Global Support](https://support.zuora.com/). 


            Whereas new customers, and existing customers not currently on
            [Order
            Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders),
            will no longer have access to Order Metrics, existing customers
            currently using Order Metrics will continue to be supported.
          items:
            properties:
              orderActions:
                items:
                  properties:
                    orderItems:
                      description: >
                        The `orderItems` nested field is only available to
                        existing Orders customers who already have access to the
                        field.


                        **Note:** The following objects and fields of the Order
                        Metrics are end of support. Any new customers who
                        onboard on
                        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
                        or [Orders
                        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
                        will not get these metrics.

                        * The Order ELP and Order Item objects 

                        * The "Generated Reason" and "Order Item ID" fields in
                        the Order MRR, Order TCB, Order TCV, and Order Quantity
                        objects


                        Zuora no longer provides product support, and bug fixes
                        or security issues are no longer addressed.
                      items:
                        $ref: '#/components/schemas/OrderItem'
                      type: array
                    orderMetrics:
                      description: >
                        The container for order metrics.


                        **Note:** The following objects and fields of the Order
                        Metrics are end of support. Any new customers who
                        onboard on
                        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
                        or [Orders
                        Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
                        will not get these metrics.

                        * The Order ELP and Order Item objects 

                        * The "Generated Reason" and "Order Item ID" fields in
                        the Order MRR, Order TCB, Order TCV, and Order Quantity
                        objects


                        Zuora no longer provides product support, and bug fixes
                        or security issues are no longer addressed.
                      items:
                        $ref: '#/components/schemas/orderMetric'
                      type: array
                    sequence:
                      type: string
                    type:
                      type: string
                  type: object
                type: array
              subscriptionNumber:
                type: string
            type: object
          type: array
        rampMetrics:
          description: >
            **Note**: This field is only available if you have the Ramps feature
            enabled. The
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            feature must be enabled before you can access the
            [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)
            feature. The Ramps feature is available for customers with
            Enterprise and Nine editions by default. If you are a Growth
            customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information coming October 2020.


            The ramp metrics.
          items:
            $ref: '#/components/schemas/OrderRampMetrics'
          type: array
      type: object
    PostOrderPreviewResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            previewResult:
              $ref: '#/components/schemas/PreviewOrderResult'
          type: object
    POSTOrderPreviewAsyncRequestType:
      example:
        existingAccountNumber: A00000097
        orderDate: '2024-07-01'
        previewOptions:
          previewTypes:
            - BillingDocs
          previewThruType: SpecificDate
          specificPreviewThruDate: '2024-07-31'
        subscriptions:
          - orderActions:
              - type: CreateSubscription
                createSubscription:
                  terms:
                    initialTerm:
                      period: 12
                      periodType: Month
                      termType: TERMED
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerms:
                      - period: 12
                        periodType: Month
                  subscribeToRatePlans:
                    - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4
                triggerDates:
                  - name: ContractEffective
                    triggerDate: '2024-07-01'
                  - name: ServiceActivation
                    triggerDate: '2024-07-01'
                  - name: CustomerAcceptance
                    triggerDate: '2024-07-01'
      properties:
        category:
          default: NewSales
          description: >
            Category of the order to indicate a product sale or return. Default
            value is `NewSales`.
          enum:
            - NewSales
            - Return
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        description:
          description: A description of the order.
          maxLength: 500
          type: string
        existingAccountId:
          description: >
            The account ID under which this order will be created.  This field
            sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order.  To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field. 


            **Note:** You can specify either the `existingAccountNumber` or
            `existingAccountId` field, but not both.
          type: string
        existingAccountNumber:
          description: >
            The account number under which this order will be created.  This
            field sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order. To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field.
          maxLength: 70
          type: string
        orderDate:
          description: >-
            The date when the order is signed. All of the order actions under
            this order will use this order date as the contract effective date.
          format: date
          type: string
        orderLineItems:
          description: >
            [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            are non subscription based items created by an Order, representing
            transactional charges such as one-time fees, physical goods, or
            professional service charges that are not sold as subscription
            services. 


            With the Order Line Items feature enabled, you can now launch
            non-subscription and unified monetization business models in Zuora,
            in addition to subscription business models. 


            If you do not have the **Create Order Line Items Without Product
            Catalog** billing permission, you can only create order  line items
            from existing products by specifying the product rate plan charge ID
            in the `productRatePlanChargeId` field.  For more information about
            billing permissions, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/System_Management/Administrator_Settings/User_Roles/d_Billing_Roles"
            target="_blank">Billing Roles</a>.


            **Note:** The [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature is now generally available to all Zuora customers. You need
            to enable the
            [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
            feature to access the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature. As of Zuora Billing Release 313 (November 2021), new
            customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            will have the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
            feature enabled by default.       
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          description: >
            The order number of this order.   

            **Note:** The characters `#`, `?`, and `/` are not allowed in this
            field. Additionally, to ensure compatibility with the UI when
            viewing orders, use only the following special characters: `_`,`-`,
            `.`, `~`, `*`, `(`, `)`, and `'`.
          maxLength: 100
          type: string
        previewAccountInfo:
          $ref: '#/components/schemas/PreviewAccountInfo'
        previewOptions:
          $ref: '#/components/schemas/PreviewOptions'
        reasonCode:
          description: >
            Values of reason code configured in **Billing Settings** >
            **Configure Reason Codes** through Zuora UI. Indicates the reason
            when a return order line item occurs.
          maxLength: 255
          type: string
        subscriptions:
          description: >-
            Each item includes a set of order actions, which will be applied to
            the same base subscription. When you create an order that involves
            multiple subscriptions, these subscriptions can have different
            invoice owner accounts or subscription owner accounts. 
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                description: >
                  Notes about the subscription. These notes are only visible to
                  Zuora users. Notes set in this field will override the value
                  of the `notes` field within the createSubscription order
                  action.
                type: string
                maxLength: 1000
              orderActions:
                description: >-
                  The actions to be applied to the subscription. Order actions
                  will be stored with the sequence when it was provided in the
                  request.
                items:
                  $ref: '#/components/schemas/PreviewOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                description: >
                  Leave this field empty to represent new subscription creation,
                  or specify a subscription number to update an existing
                  subscription.
                type: string
            type: object
          type: array
      required:
        - orderDate
        - previewOptions
      type: object
    CommitmentTypeEnum:
      type: string
      enum:
        - MinCommitment
        - MaxCommitment
      description: |
        The type of the commitment.
    PeriodAlignmentOptionEnum:
      type: string
      default: CommitmentStartDate
      enum:
        - CommitmentStartDate
        - SpecificDate
      description: |
        Options for aligning the commitment periods within a commitment.
    AmountBaseEnum:
      title: AmountBaseEnum
      type: string
      description: The level for which the committed amount applies to.
      default: CommitmentPeriod
      enum:
        - CommitmentPeriod
    PeriodTypeEnum:
      title: PeriodTypeEnum
      type: string
      default: Month
      enum:
        - Month
        - Quarter
        - SemiAnnual
        - Year
        - SpecificMonths
        - SinglePeriod
      description: |
        The frequency type of the period of the commitment schedule.
    CommitmentBaseAttributesListOrders:
      type: object
      title: CommitmentBaseAttributesListOrders
      properties:
        commitmentNumber:
          description: |
            The commitment number.
          type: string
          maxLength: 100
        id:
          description: ID of the Commitment.
          type: string
        name:
          description: |
            The name of the commitment. 
          type: string
          maxLength: 255
        type:
          $ref: '#/components/schemas/CommitmentTypeEnum'
        description:
          description: |
            The description of the commitment. 
          type: string
          maxLength: 500
        priority:
          description: >
            It defines the evaluation order of the commitment. The lower the
            number, the higher the priority.

            When two commitments have the same priority, the commitment that was
            created initially will be evaluated first.
          type: integer
        customFields:
          type: object
          additionalProperties: true
          description: Container for custom fields of a Commitment object.
          title: CommitmentCustomFields
        specificPeriodAlignmentDate:
          type: string
          description: >-
            The specific date for the period alignment. This field is required
            only if the `periodAlignmentOption` is set to `SpecificDate`.
          format: date
          example: '2020-01-15'
        periodAlignmentOption:
          $ref: '#/components/schemas/PeriodAlignmentOptionEnum'
        schedules:
          description: |
            A list of Commitment schedule objects.
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The ID of the schedule.
              startDate:
                type: string
                description: The start date of the schedule.
              endDate:
                type: string
                description: The end date of the schedule.
              totalAmount:
                type: number
                format: double
                description: The total amount of the schedule.
              amountBase:
                $ref: '#/components/schemas/AmountBaseEnum'
              periodType:
                $ref: '#/components/schemas/PeriodTypeEnum'
              specificPeriodLength:
                type: integer
                description: The specific period length of each period in the schedule.
    CommonRevenueAttributes:
      type: object
      properties:
        accountReceivableAccountingCode:
          description: |
            The accounting code on the Commitment object for customers. 
          type: string
          maxLength: 100
        adjustmentLiabilityAccountingCode:
          description: >
            The accounting code on the commitment for customers.



            **Note:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          type: string
          maxLength: 100
        adjustmentRevenueAccountingCode:
          description: >
            The accounting code on the commitment for customers.



            **Note:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          type: string
          maxLength: 100
        contractAssetAccountingCode:
          description: >
            The accounting code on the commitment for customers.



            **Notes:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          type: string
          maxLength: 100
        contractLiabilityAccountingCode:
          description: >
            The accounting code on the commitment for customers.



            **Notes:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          type: string
          maxLength: 100
        contractRecognizedRevenueAccountingCode:
          description: >
            The accounting code on the commitment for customers.



            **Notes:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          maxLength: 100
        deferredRevenueAccountingCode:
          description: |
            The deferred revenue accounting code for the commitment.
          type: string
          maxLength: 100
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude commitment related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.



            **Note:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          type: boolean
        isAllocationEligible:
          description: >
            This field is used to identify if the commitment is allocation
            eligible in revenue recognition.



            **Note:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue recognition.



            **Note:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
          type: boolean
        recognizedRevenueAccountingCode:
          description: |
            The recognized revenue accounting code for the commitment.
          type: string
          maxLength: 100
        revenueAmortizationMethod:
          description: >
            This field is used to dictate the type of revenue amortization
            method.
          type: string
          maxLength: 200
        revenueRecognitionRule:
          description: |
            The revenue recognition rule for the commitment.
          type: string
          maxLength: 255
        revenueRecognitionTiming:
          description: >
            This field is used to dictate the type of revenue recognition
            timing.
          type: string
          maxLength: 200
        unbilledReceivablesAccountingCode:
          description: >
            The accounting code on the commitment for customers.



            **Note:** This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. 
          type: string
          maxLength: 100
    CommonTaxationAttributes:
      type: object
      properties:
        taxable:
          type: boolean
          description: >
            The flag to indicate whether the charge is taxable. If this field is
            set to `true`, both the fields `taxCode` and `taxMode` are required.
        taxCode:
          type: string
          description: >
            The tax code of a charge.



            **Note:** This field is available when the `taxable` field is set to
            `true`.
          maxLength: 100
        taxMode:
          type: string
          description: >
            The tax mode of a charge. This field is available when the `taxable`
            field is set to `true`.
          enum:
            - TaxInclusive
            - TaxExclusive
    EligibleAccountCondition:
      type: object
      description: The conditions for account level filters for the commitment.
      properties:
        field:
          type: string
          description: |
            The field name of a single condition.
        operator:
          type: string
          description: |
            The operator of a single condition.

            Example: 

              - eq: equal, field = value 
              - neq: not equal, field != value 
              - gt: greater than, field > value 
              - lt: less than, field < value 
              - gte: greater than or equal, field >= value 
              - lte: less than or equal, field <= value - lk: like, field like value 
              - in: in, field in value, multiple values are separated by commas 
              - nl: null, field is null 
              - nnl: not null, field is not null
          enum:
            - eq
            - neq
            - gt
            - lt
            - gte
            - lte
            - lk
            - in
            - nl
            - nnl
        value:
          type: string
          description: >
            The value of a single condition, which can be a list of values
            separated by commas.



            **Notes:** Account Condition only contains account related fields.
            Support is provided only for the indexed custom fields.
        conditions:
          type: array
          description: |
            The conditions will be combined by the relation.
          items:
            $ref: '#/components/schemas/EligibleAccountCondition'
        relation:
          type: string
          description: |
            The relation among the conditions.
          enum:
            - and
            - or
    EligibleChargeCondition:
      type: object
      description: The conditions for charge level filters for the commitment.
      properties:
        field:
          type: string
          description: |
            The field name of a single condition.
        operator:
          type: string
          description: |
            The operator of a single condition.

            Example: 
              
              - eq: equal, field = value 
              - neq: not equal, field != value 
              - gt: greater than, field > value 
              - lt: less than, field < value 
              - gte: greater than or equal, field >= value 
              - lte: less than or equal, field <= value 
              - lk: like, field like value 
              - in: in, field in value, multiple values are separated by commas 
              - nl: null, field is null 
              - nnl: not null, field is not null
          enum:
            - eq
            - neq
            - gt
            - lt
            - gte
            - lte
            - lk
            - in
            - nl
            - nnl
        value:
          type: string
          description: >
            The value of a single condition, which can be a list of values
            separated by commas.



            **Notes:**  

            - PPDD (PrePaid DrawDown) charge will not be loaded during
            evaluation. 

            - Charge condition only contains charge related fields. Support is
            provided only for the indexed custom fields.

            - Charge types supports only the OneTime, Recurring and Usage
            values. 

            - Charge models supports only the FlatFee, PerUnit, Overage, Volume
            Tiered, TieredWithOverage, and Calculated values. 
        conditions:
          type: array
          description: |
            The conditions will be combined by the relation.
          items:
            $ref: '#/components/schemas/EligibleChargeCondition'
        relation:
          type: string
          description: |
            The relation among the conditions.
          enum:
            - and
            - or
    GetCommitmentOutputListOrders:
      type: object
      allOf:
        - $ref: '#/components/schemas/CommitmentBaseAttributesListOrders'
        - $ref: '#/components/schemas/CommonRevenueAttributes'
        - $ref: '#/components/schemas/CommonTaxationAttributes'
        - properties:
            id:
              type: string
              description: |
                ID of the commitment.
            version:
              type: integer
              description: |
                Version of the commitment.
            currency:
              type: string
              description: |
                Currency of the commitment.
            excludeItemBookingFromRevenueAccounting:
              type: boolean
              default: true
              description: The flag to exclude Commitment period from revenue accounting.
            eligibleAccountConditions:
              $ref: '#/components/schemas/EligibleAccountCondition'
            eligibleChargeConditions:
              $ref: '#/components/schemas/EligibleChargeCondition'
    OrderLineItemCommonRetrieveOrder:
      properties:
        UOM:
          description: |
            Specifies the units to measure usage.
          type: string
        accountingCode:
          description: |
            The accounting code for the Order Line Item.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        amountPerUnit:
          description: |
            The actual charged amount per unit for the Order Line Item.
          type: number
        billTargetDate:
          description: >
            The target date for the Order Line Item to be picked up by bill run
            for billing.
          format: date
          type: string
        billTo:
          description: >
            The ID of the bill-to contact of an order line item. An existing
            contact under the billing account is specified as the bill-to
            contact of the order line item. The billing account is the order
            account.
          type: string
        billToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the bill-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `billToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        billingRule:
          description: |
            The billing rule of the Order Line Item.
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        currency:
          description: >
            The currency for the order line item. You can specify a currency
            when creating an order line item through the "Create an order"
            operation.
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFields'
        deferredRevenueAccountingCode:
          description: |
            The deferred revenue accounting code for the Order Line Item.
          type: string
        description:
          description: |
            The description of the Order Line Item.
          type: string
        discount:
          description: >
            This field shows the total discount amount that is applied to an
            order line item after the `inlineDiscountType`,
            `inlineDiscountPerUnit` and `quantity` fields are set.


            The inline discount is applied to the list price of an order line
            item (see the `listPrice` field).
          type: number
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude Order Line Item related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          description: >
            The flag to exclude Order Line Item from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        inlineDiscountPerUnit:
          description: >
            This field is used in accordance with the `inlineDiscountType`
            field, in the following manner:

            * If the `inlineDiscountType` field is set as `Percentage`, this
            field specifies the discount percentage for each unit of the order
            line item. For exmaple, if you specify `5` in this field, the
            discount percentage is 5%.

            * If the `inlineDiscountType` field is set as `FixedAmount`, this
            field specifies the discount amount on each unit of the order line
            item. For exmaple, if you specify `10` in this field, the discount
            amount on each unit of the order line item is 10.


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          type: number
        inlineDiscountType:
          description: >
            This field is used to specify the inline discount type, which can be
            `Percentage`, `FixedAmount`, or `None`. The default value is
            `Percentage`.


            This field is used together with the `inlineDiscountPerUnit` field
            to specify inline discounts for order line items. The inline
            discount is applied to the list price of an order line item. 


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        invoiceOwnerAccountId:
          description: |
            The account ID of the invoice owner of the order line item.
          type: string
        invoiceOwnerAccountName:
          description: |
            The account name of the invoice owner of the order line item.
          type: string
        invoiceOwnerAccountNumber:
          description: |
            The account number of the invoice owner of the order line item.
          type: string
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        itemCategory:
          default: Sales
          description: >
            The category of the Order Line Item, to indicate a product sale or
            return.
          enum:
            - Sales
            - Return
          type: string
        itemName:
          description: |
            The name of the Order Line Item.
          type: string
        itemState:
          description: >
            The state of an Order Line Item. See [State transitions for an
            order, order line item, and
            fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          description: |
            The type of the Order Line Item. 
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPrice:
          description: >
            The extended list price for an order line item, calculated by the
            formula: listPrice = listPricePerUnit * quantity
          type: number
        listPricePerUnit:
          description: |
            The list price per unit for the Order Line Item.
          type: number
        originalOrderId:
          description: |
            The ID of the original sale order for a return order line item. 
          type: string
        originalOrderLineItemId:
          description: >
            The ID of the original sale order line item for a return order line
            item. 
          type: string
        originalOrderLineItemNumber:
          description: >
            The number of the original sale order line item for a return order
            line item. 
          type: string
        originalOrderNumber:
          description: |
            The number of the original sale order for a return order line item. 
          type: string
        ownerAccountId:
          description: |
            The account ID of the owner of the order line item.
          type: string
        ownerAccountName:
          description: |
            The account name of the owner of the order line item.
          type: string
        ownerAccountNumber:
          description: |
            The account number of the owner of the order line item.
          type: string
        productCode:
          description: |
            The product code for the Order Line Item.
          type: string
        productRatePlanChargeId:
          description: >
            Id of a Product Rate Plan Charge. Only one-time charges are
            supported.
          type: string
        purchaseOrderNumber:
          description: >
            Used by customers to specify the Purchase Order Number provided by
            the buyer.
          type: string
        quantity:
          description: >
            The quantity of units, such as the number of authors in a hosted
            wiki service.
          type: number
        quantityAvailableForReturn:
          description: |
            The quantity that can be returned for an order line item. 
          type: number
        quantityFulfilled:
          description: |
            The fulfilled quantity for an order line item.
          type: number
        quantityPendingFulfillment:
          description: |
            The quantity to fulfill for an order line item. 
          type: number
        recognizedRevenueAccountingCode:
          description: |
            The recognized revenue accounting code for the Order Line Item.
          type: string
        relatedSubscriptionNumber:
          description: >
            Use this field to relate an order line item to a subscription when
            you create the order line item.


            * To relate an order line item to a new subscription which is yet to
            create in the same "Create an order" call, use this field in
            combination with the `subscriptions` > `subscriptionNumber` field in
            the "Create order" operation. Specify this field to the same value
            as that of the 'subscriptions' > `subscriptionNumber` field when you
            make the "Create order" call.

            * To relate an order line item to an existing subscription, specify
            this field to the subscription number of the existing subscription.
          type: string
        requiresFulfillment:
          description: >
            The flag to show whether fulfillment is needed or not. It's derived
            from billing rule of the Order Line Item.
          type: boolean
        revenueRecognitionRule:
          description: |
            The Revenue Recognition rule for the Order Line Item.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the OrderLineItem.
          type: string
          nullable: true
        shipTo:
          description: >
            The ID of a contact that belongs to the owner acount or billing
            account of the order line item. Use this field to assign an existing
            account as the ship-to contact of an order line item. The billing
            account is the order account.
          type: string
        shipToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the ship-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `shipToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        soldTo:
          description: >
            The ID of a contact that belongs to the owner acount or billing
            account of the order line item. Use this field to assign an existing
            account as the sold-to contact of an order line item. The billing
            account is the order account.
          type: string
        soldToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the sold-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `soldToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        taxCode:
          description: |
            The tax code for the Order Line Item.
          type: string
        taxMode:
          description: |
            The tax mode for the Order Line Item.
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          description: >
            The date a transaction is completed. The default value of this field
            is the transaction start date. Also, the value of this field should
            always equal or be later than the value of the
            `transactionStartDate` field.
          format: date
          type: string
        transactionStartDate:
          description: >
            The date a transaction starts. The default value of this field is
            the order date.
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
      title: OrderLineItem
      type: object
    OrderLineItemRetrieveOrder:
      allOf:
        - properties:
            amendedByOrderOn:
              description: >
                The date when the rate plan charge is amended through an order
                or amendment. This field is to standardize the booking date
                information to increase audit ability and traceability of data
                between Zuora Billing and Zuora Revenue. It is mapped as the
                booking date for a sale order line in Zuora Revenue.
              type: string
            amount:
              description: |
                The calculated gross amount for the Order Line Item.
              type: number
            amountWithoutTax:
              description: >
                The calculated gross amount for an order line item excluding
                tax. If the tax mode is tax exclusive, the value of this field
                equals that of the `amount` field.


                If the tax mode of an order line item is not set, the system
                treats it as tax exclusive by default. The value of the
                `amountWithoutTax` field equals that of the `amount` field.


                If you create an order line item from the product catalog, the
                tax mode and tax code of the product rate plan charge are used
                for the order line item by default. You can still overwrite this
                default set-up by setting the tax mode and tax code of the order
                line item.
              type: number
            id:
              description: |
                The sytem generated Id for the Order Line Item.
              format: UUID
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the order line
                item. 


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            sequenceSetId:
              description: >
                The ID of the sequence set associated with the order line item.



                The value of this field is `null` if you have the [Flexible
                Billing

                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)

                feature disabled.
              type: string
            communicationProfileId:
              description: >
                The ID of the communication profile associated with the order
                line item.


                **Note**: This field is available in the request body only if
                you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a>

                feature turned on. The value is `null` in the response body
                without this feature turned on.
              type: string
              nullable: true
            paymentTerm:
              description: >
                The payment term name associated with the order line item.


                The value of this field is `null` if you have the [Flexible
                Billing

                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)

                feature disabled.
              type: string
            invoiceTemplateId:
              description: >
                The ID of the invoice template associated with the order line
                item.


                The value of this field is `null` if you have the [Flexible
                Billing

                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)

                feature disabled.
              type: string
            itemNumber:
              description: |
                The number for the Order Line Item.
              type: string
            originalOrderDate:
              description: >
                The date when the rate plan charge is created through an order
                or amendment. This field is to standardize the booking date
                information to increase audit ability and traceability of data
                between Zuora Billing and Zuora Revenue. It is mapped as the
                booking date for a sale order line in Zuora Revenue.
              format: date
              type: string
            quantityFulfilled:
              description: >
                The quantity that has been fulfilled by fulfillments for the
                order line item. This field will be updated automatically when
                related fulfillments become 'SentToBilling' or 'Complete' state.
              type: number
            quantityPendingFulfillment:
              description: >
                The quantity that's need to be fulfilled by fulfillments for the
                order line item. This field will be updated automatically when
                related fulfillments become 'SentToBilling' or 'Complete' state.
              type: number
          type: object
        - $ref: '#/components/schemas/OrderLineItemCommonRetrieveOrder'
    CommitmentOutput:
      type: object
      description: >
        The Commitment object in the "Create an order" or "Update an order"
        response.
      title: UpsertOrderCommitmentResponse
      properties:
        id:
          type: string
          description: |
            ID of the commitment
        commitmentNumber:
          type: string
          description: |
            Number of the commitment.
        type:
          $ref: '#/components/schemas/CommitmentTypeEnum'
        startDate:
          type: string
          format: date
          description: |
            The start date of the commitment.
        endDate:
          type: string
          format: date
          description: |
            The end date of the commitment.
        status:
          type: string
          description: The status of the commitment.
          enum:
            - Canceled
            - Active
        totalAmount:
          type: number
          format: double
          description: The total amount of the commitment.
        schedules:
          description: |
            A list of Commitment schedule objects.
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: The ID of the schedule.
              startDate:
                type: string
                description: The start date of the schedule.
              endDate:
                type: string
                description: The end date of the schedule.
              totalAmount:
                type: number
                format: double
                description: The total amount of the schedule.
              status:
                type: string
                description: The status of the schedule.
                enum:
                  - Active
                  - Evaluated
                  - Canceled
    CreateOrderResult:
      properties:
        accountId:
          description: >-
            The account ID for the order. This field is returned instead of the
            `accountNumber` field if the `returnIds` query parameter is set to
            `true`.
          maxLength: 32
          type: string
        accountNumber:
          description: The account number for the order.
          maxLength: 50
          type: string
        commitments:
          description: The commitments created by this order request.
          items:
            $ref: '#/components/schemas/CommitmentOutput'
          type: array
        creditMemoIds:
          description: >-
            An array of the credit memo IDs generated in this order request. The
            credit memo is only available if you have the Invoice Settlement
            feature enabled. This field is returned instead of the
            `creditMemoNumbers` field if the `returnIds` query parameter is set
            to `true`.
          items:
            type: string
            maxLength: 32
          type: array
        creditMemoNumbers:
          description: >-
            An array of the credit memo numbers generated in this order request.
            The credit memo is only available if you have the Invoice Settlement
            feature enabled.
          items:
            type: string
            maxLength: 255
          type: array
        invoiceIds:
          description: >-
            An array of the invoice IDs generated in this order request.
            Normally it includes one invoice ID only, but can include multiple
            items when a subscription was tagged as invoice separately. This
            field is returned instead of the `invoiceNumbers` field if the
            `returnIds` query parameter is set to `true`.
          items:
            type: string
            maxLength: 32
          type: array
        invoiceNumbers:
          description: >-
            An array of the invoice numbers generated in this order request.
            Normally it includes one invoice number only, but can include
            multiple items when a subscription was tagged as invoice separately.
          items:
            type: string
            maxLength: 255
          type: array
        orderId:
          description: >-
            The ID of the order created. This field is returned instead of the
            `orderNumber` field if the `returnIds` query parameter is set to
            `true`.
          maxLength: 32
          type: string
        orderLineItems:
          description: >
            [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            are non subscription based items created by an Order, representing
            transactional charges such as one-time fees, physical goods, or
            professional service charges that are not sold as subscription
            services. 


            With the Order Line Items feature enabled, you can now launch
            non-subscription and unified monetization business models in Zuora,
            in addition to subscription business models. 


            **Note:** The [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature is now generally available to all Zuora customers. You need
            to enable the
            [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
            feature to access the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature. As of Zuora Billing Release 313 (November 2021), new
            customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            will have the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
            feature enabled by default.
          items:
            properties:
              id:
                description: The sytem generated Id for the Order Line Item.
                maxLength: 32
                type: string
              itemNumber:
                description: The number for the Order Line Item.
                maxLength: 100
                type: string
            type: object
          type: array
        orderNumber:
          description: The order number of the order created.
          maxLength: 100
          type: string
        paidAmount:
          description: The total amount collected in this order request.
          maxLength: 22
          minLength: 9
          type: string
        paymentId:
          description: >-
            The payment Id that is collected in this order request. This field
            is returned instead of the `paymentNumber` field if the `returnIds`
            query parameter is set to `true`.
          maxLength: 32
          type: string
        paymentNumber:
          description: The payment number that is collected in this order request.
          maxLength: 32
          type: string
        ramps:
          description: >
            **Note**: This field is only available if you have the Ramps feature
            enabled. The
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            feature must be enabled before you can access the
            [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)
            feature. The Ramps feature is available for customers with
            Enterprise and Nine editions by default. If you are a Growth
            customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information coming October 2020.


            The ramp definitions created by this order request.
          items:
            properties:
              rampNumber:
                description: The number of the ramp definition.
                maxLength: 50
                type: string
              subscriptionNumber:
                description: >-
                  The number of the subscription that this ramp deal definition
                  is applied to.
                maxLength: 150
                type: string
            type: object
          type: array
        refunds:
          description: Container for refunds.
          items:
            properties:
              number:
                description: The refund number.
                example: R-00009564
                maxLength: 32
                type: string
              refundInvoiceNumbers:
                description: >-
                  An array of the refunded invoice numbers generated in this
                  order request.
                items:
                  type: string
                  maxLength: 255
                type: array
              status:
                description: The status of the refund.
                enum:
                  - Success
                  - Error
                type: string
            type: object
          type: array
        status:
          description: >-
            Status of the order. `Pending` is only applicable for an order that
            contains a `CreateSubscription` order action.
          enum:
            - Draft
            - Pending
            - Completed
            - Scheduled
          type: string
        subscriptionIds:
          description: >-
            Container for the subscription IDs of the subscriptions in an order.
            This field is returned if the `returnIds` query parameter is set to
            `true`.
          items:
            type: string
            maxLength: 32
          type: array
        subscriptions:
          description: >
            This field is available only if you are on the latest Zuora API
            minor

            version, or you set the `Zuora-Version` request header to `223.0` or
            a

            later available version. To use this field in the method, you must
            set the `Zuora-Version` parameter to the minor version number in the
            request header.

            Container for the subscription numbers and statuses in an order.
          items:
            properties:
              status:
                description: >-
                  Status of the subscription. `Pending Activation` and `Pending
                  Acceptance` are only applicable for an order that contains a
                  `CreateSubscription` order action.
                enum:
                  - Active
                  - Pending Activation
                  - Pending Acceptance
                  - Cancelled
                  - Suspended
                type: string
              subscriptionId:
                description: >-
                  Subscription ID of the subscription included in this order.
                  This field is returned instead of the `subscriptionNumber`
                  field if the `returnIds` query parameter is set to `true`.
                maxLength: 32
                type: string
              subscriptionNumber:
                description: >
                  Subscription number of the subscription included in this
                  order.
                maxLength: 150
                type: string
              subscriptionOwnerId:
                description: |
                  Subscription owner account id of the subscription.
                type: string
              subscriptionOwnerNumber:
                description: |
                  Subscription owner account number of the subscription.
                type: string
            type: object
        writeOff:
          description: Container for write-offs.
          items:
            properties:
              amount:
                description: The amount written off from the invoice balance.
                maximum: 22
                minimum: 9
                type: number
              failedReason:
                description: The reason of write-off failure.
                type: string
              invoiceNumber:
                description: The number of the invoice that is written off.
                example: INV00051208
                maxLength: 255
                type: string
              status:
                description: The status of the write-off.
                enum:
                  - Success
                  - Failed
                type: string
              writeOffCreditMemoNumber:
                description: The number of the credit memo that is written off.
                maxLength: 255
                type: string
            type: object
          type: array
      type: object
    PostOrderResponseType:
      description: Response information of orders.
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - $ref: '#/components/schemas/CreateOrderResult'
    UsageFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              description: |
                Price of the charge.
              type: number
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "flat fee" charge
        model. In this charge model, the charge has a fixed price.
      title: usageFlatFee
    UsageOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            includedUnits:
              description: |
                Number of free units that may be consumed.
              minimum: 0
              type: number
            numberOfPeriods:
              description: >
                Number of periods that Zuora considers when calculating overage
                charges with overage smoothing.
              minimum: 1
              type: integer
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
            overagePrice:
              description: |
                Price per overage unit consumed.
              type: number
            overageUnusedUnitsCreditOption:
              description: >
                Specifies whether to credit the customer for unused units.


                If the value of this field is `CreditBySpecificRate`, use the
                `unusedUnitsCreditRates` field to specify the rate at which to
                credit the customer for unused units.
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            unusedUnitsCreditRates:
              description: >
                Per-unit rate at which to credit the customer for unused units.
                Only applicable if the value of the
                `overageUnusedUnitsCreditOption` field is
                `CreditBySpecificRate`.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "overage" charge
        model. In this charge model, the charge has an allowance of free units
        and a fixed price per additional unit consumed.
      title: usageOverage
    UsagePerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              description: |
                Per-unit price of the charge.
              type: number
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
            ratingGroup:
              description: >
                Specifies how Zuora groups usage records when rating usage. See
                [Usage Rating by
                Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)
                for more information.
                  * ByBillingPeriod (default): The rating is based on all the usages in a billing period.
                  * ByUsageStartDate: The rating is based on all the usages on the same usage start date. 
                  * ByUsageRecord: The rating is based on each usage record.
                  * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            uom:
              description: >
                Unit of measure of the standalone charge.


                **Note:** This field is available when the <a
                href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
                target="_blank">Standalone Orders</a> feature is enabled.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "per unit" charge
        model. In this charge model, the charge has a fixed price per unit
        consumed.
      title: usagePerUnit
    UsageTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            ratingGroup:
              description: >
                Specifies how Zuora groups usage records when rating usage. See
                [Usage Rating by
                Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)
                for more information.
                  * ByBillingPeriod (default): The rating is based on all the usages in a billing period.
                  * ByUsageStartDate: The rating is based on all the usages on the same usage start date. 
                  * ByUsageRecord: The rating is based on each usage record.
                  * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              description: |
                List of cumulative pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              description: >
                Unit of measure of the standalone charge.


                **Note:** This field is available when the <a
                href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
                target="_blank">Standalone Orders</a> feature is enabled.
              type: string
          type: object
      description: >
        Pricing information about a usage charge that uses the "tiered pricing"
        charge model. In this charge model, the charge has cumulative pricing
        tiers that become effective as units are consumed.
      title: usageTiered
    UsageTieredWithOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            numberOfPeriods:
              description: >
                Number of periods that Zuora considers when calculating overage
                charges with overage smoothing.
              minimum: 1
              type: integer
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or
                retailer.        
              type: number
            overagePrice:
              description: |
                Price per overage unit consumed.
              type: number
            overageUnusedUnitsCreditOption:
              description: >
                Specifies whether to credit the customer for unused units.


                If the value of this field is `CreditBySpecificRate`, use the
                `unusedUnitsCreditRates` field to specify the rate at which to
                credit the customer for unused units.
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            tiers:
              description: |
                List of cumulative pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            unusedUnitsCreditRates:
              description: >
                Per-unit rate at which to credit the customer for unused units.
                Only applicable if the value of the
                `overageUnusedUnitsCreditOption` field is
                `CreditBySpecificRate`.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "tiered with
        overage" charge model. In this charge model, the charge has cumulative
        pricing tiers that become effective as units are consumed. The charge
        also has a fixed price per unit consumed beyond the limit of the final
        tier.
      title: usageTieredWithOverage
    UsageVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            ratingGroup:
              description: >
                Specifies how Zuora groups usage records when rating usage. See
                [Usage Rating by
                Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)
                for more information.
                  * ByBillingPeriod (default): The rating is based on all the usages in a billing period.
                  * ByUsageStartDate: The rating is based on all the usages on the same usage start date. 
                  * ByUsageRecord: The rating is based on each usage record.
                  * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              description: |
                List of variable pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
            uom:
              description: >
                Unit of measure of the standalone charge.


                **Note:** This field is available when the <a
                href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
                target="_blank">Standalone Orders</a> feature is enabled.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "volume pricing"
        charge model. In this charge model, the charge has a variable price per
        unit, depending on how many units are consumed.
      title: usageVolume
    TriggerParams:
      description: |
        Specifies when a charge becomes active.
      properties:
        periodsAfterChargeStart:
          description: >
            Duration of the discount charge in days, weeks, months, or years,
            depending on the value of the `startPeriodsType` field. Only
            applicable if the value of the `startDatePolicy` field is
            `FixedPeriodAfterApplyToChargeStartDate`.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          type: integer
        specificTriggerDate:
          description: >
            Date in YYYY-MM-DD format. Only applicable if the value of the
            `triggerEvent` field is `SpecificDate`. 


            While this field is applicable, if this field is not set, your
            `CreateSubscription` order action creates a `Pending` order and a
            `Pending Acceptance` subscription. If at the same time the service
            activation date is required and not set, a `Pending Activation`
            subscription is created.


            While this field is applicable, if this field is not set, the
            following order actions create a `Pending` order but do not impact
            the subscription status. **Note**: This feature is in **Limited
            Availability**. If you want to have access to the feature, submit a
            request at [Zuora Global Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions
          format: date
          type: string
        startDatePolicy:
          description: >
            Start date policy of the discount charge to become active when the
            **Apply to billing period partially** checkbox is selected from the
            product catalog UI or the `applyToBillingPeriodPartially` field is
            set as true from the "CRUD: Create a product rate plan charge"
            operation. 


            - If the value of this field is `SpecificDate`, use the
            `specificTriggerDate` field to specify the date when the charge
            becomes active.

            - If the value of this field is
            `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a
            predefined duration based on the value of the `upToPeriodsType` and
            `upToPeriods` fields.


            **Notes**: 
              - You must enable the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature to access this field. 
              - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.
          enum:
            - AlignToApplyToCharge
            - SpecificDate
            - EndOfLastInvoicePeriodOfApplyToCharge
            - FixedPeriodAfterApplyToChargeStartDate
          type: string
        startPeriodsType:
          description: >
            Unit of time that the discount charge duration is measured in. Only
            applicable if the value of the `startDatePolicy` field is
            `FixedPeriodAfterApplyToChargeStartDate`.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
          enum:
            - Days
            - Weeks
            - Months
            - Years
          type: string
        triggerEvent:
          description: >
            Condition for the charge to become active.


            If the value of this field is `SpecificDate`, use the
            `specificTriggerDate` field to specify the date when the charge
            becomes active.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    ChargeOverride:
      description: |
        Charge associated with a rate plan.
      properties:
        accountReceivableAccountingCode:
          description: >
            The accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The adjustmentLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The adjustmentRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        billing:
          description: |
            Billing information about the charge.
          properties:
            billCycleDay:
              description: >
                Day of the month that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofMonth`.
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              description: >
                Specifies how Zuora determines the day that each billing period
                begins on.

                  * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
                  * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
                  * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
                  * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
                  * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              description: >
                Billing frequency of the charge. The value of this field
                controls the duration of each billing period.


                If the value of this field is `Specific_Days`, `Specific_Months`
                or `Specific_Weeks`, use the `specificBillingPeriod` field to
                specify the duration of each billing period.
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              description: >
                Specifies how Zuora determines when to start new billing
                periods. You can use this field to align the billing periods of
                different charges.


                * `AlignToCharge` - Zuora starts a new billing period on the
                first billing day that falls on or after the date when the
                charge becomes active.

                * `AlignToSubscriptionStart` - Zuora starts a new billing period
                on the first billing day that falls on or after the start date
                of the subscription.

                * `AlignToTermStart` - For each term of the subscription, Zuora
                starts a new billing period on the first billing day that falls
                on or after the start date of the term.


                See the `billCycleType` field for information about how Zuora
                determines the billing day.


                **Note**: This field is not supported in one time charges. 
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              description: >
                Specifies whether to invoice for a billing period on the first
                day of the billing period (billing in advance) or the first day
                of the next billing period (billing in arrears).
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              description: >
                Duration of each billing period in months or weeks, depending on
                the value of the `billingPeriod` field. Only applicable if the
                value of the `billingPeriod` field is `Specific_Months` or
                `Specific_Weeks`.
              type: integer
            weeklyBillCycleDay:
              description: >
                Day of the week that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofWeek`.
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines what type of charge it is:

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge. 

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the type of the commitment for both the
            commitment true-up charge and credit commitment charge, and so you
            must define the type as `CURRENCY`.
          enum:
            - CURRENCY
          type: string
        creditOption:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          description: >
            The chargeModel of a standalone charge.



            Supported charge models:


            * `FlatFee`


            * `PerUnit`


            * `Volume`


            * `Tiered`


            * `DiscountFixedAmount`


            * `DiscountPercentage`



            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        chargeNumber:
          description: >
            Charge number of the charge. For example, C-00000307.


            * If you do not set this field, Zuora will generate a charge number
            starting with a default prefix, for example, C-. This default prefix
            is predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**.

            * If you want to use a custom charge number, do not use the default
            prefix predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**. Use your own prefix, for example,
            SC-.
          maxLength: 50
          type: string
        chargeType:
          description: >
            The chargeType of a standalone charge.



            Supported charge types:


            * `OneTime`


            * `Recurring`


            * `Usage`



            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        contractAssetAccountingCode:
          description: >
            The contractAssetAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractLiabilityAccountingCode:
          description: >
            The contractLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The contractRecognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          description: >
            The deferredRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        description:
          description: |
            Description of the charge.
          maxLength: 500
          type: string
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            The value must be a date within the subscription term. The system
            will then automatically calculate the estimated end date for the
            pending charge. The estimated start and end dates are used to manage
            the estimated charge duration and forecast the revenue for the
            pending charge. 


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charge related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBillingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge. In addition, if the
            `excludeItemBookingFromRevenueAccounting` field in an Create
            Subscription or Add Product order action is set to `false`, you must
            also set the `excludeItemBillingFromRevenueAccounting` field in this
            order action to `false`.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charges from revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBookingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isRollover:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The value is either "True" or "False". It determines whether the
            rollover fields are needed.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        name:
          description: >
            The name of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        negotiatedPriceTable:
          description: >
            Array of negotiated price table rate card entries in the order
            request.



            **Note:** To enable the Negotiated Price Table feature, submit a
            request to <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.                 
          items:
            $ref: '#/components/schemas/NegotiatedItems'
          type: array
        pobPolicy:
          description: >
            The pobPolicy of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
        pricing:
          description: |
            Pricing information about the charge.
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDelivery:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
            usageFlatFee:
              $ref: '#/components/schemas/UsageFlatFeePricingOverride'
            usageOverage:
              $ref: '#/components/schemas/UsageOveragePricingOverride'
            usagePerUnit:
              $ref: '#/components/schemas/UsagePerUnitPricingOverride'
            usageTiered:
              $ref: '#/components/schemas/UsageTieredPricingOverride'
            usageTieredWithOverage:
              $ref: '#/components/schemas/UsageTieredWithOveragePricingOverride'
            usageVolume:
              $ref: '#/components/schemas/UsageVolumePricingOverride'
          type: object
        pricingAttributes:
          description: >
            Container for pricing attribute and value in the order request.



            **Note:** To enable Dynamic Pricing, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          type: object
          additionalProperties: true
        productCategory:
          description: >
            The productCategory of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productClass:
          description: >
            The productClass of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productFamily:
          description: >
            The productFamily of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productLine:
          description: >
            The productLine of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productRatePlanChargeNumber:
          description: |
            Number of a product rate-plan charge for this subscription.
          type: string
        productRateplanChargeId:
          description: >
            Internal identifier of the product rate plan charge that the charge
            is based on.
          type: string
        prorationOption:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
            target="_blank">Usage charge proration</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            You can use this field to specify the charge-level proration option
            for a usage charge or recurring charge when you creating or adding a
            subscription rate plan charge through an order. The tenant-level
            proration option will be overridden.
              * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
              * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
              * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
              * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field.
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            This field is used only when the value of the `prorationOption`
            field is set to `CustomizeProrationOptionOverrides`. 


            Use this field to specify more customized proration options for a
            recurring charge when you creating or adding a subscription rate
            plan charge through an order. The tenant-level proration option will
            be overridden.
          type: object
          properties:
            isProratePartialMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify whether to prorate the recurring
                charge for a partial month. The tenant-level proration option
                will be overridden.
              type: boolean
            prorationUnit:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the unit of proration for a recurring
                charge. The tenant-level proration option will be overridden.
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the number of days counted for a month
                when prorating a recurring charge. The tenant-level proration
                option will be overridden. See more details for each of the
                following enum values in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Common_subscription_information/F_Proration#When_prorating_a_month.2C_assume_30_days_in_a_month_or_use_actual_days.3F"
                target="_blank">Proration</a>.
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          description: >
            The recognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        revRecCode:
          description: |
            Revenue Recognition Code
          maxLength: 70
          type: string
        revRecTriggerCondition:
          description: |
            Specifies the revenue recognition trigger condition.

              * `Contract Effective Date` 
              * `Service Activation Date`
              * `Customer Acceptance Date`
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          description: >
            Specifies the revenue recognition rule, such as `Recognize upon
            invoicing` or `Recognize daily over time`.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. In this
            case, you must set the `rolloverPeriods` field to 1. For example,
            you can define the rollover fund's period length as 5 months,
            shorter than the prepayment charge's validity period: a year.
          type: integer
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: number
        startDate:
          $ref: '#/components/schemas/TriggerParams'
        taxCode:
          description: >
            The tax code of a charge. This field is available when the `taxable`
            field is set to `true`.
          type: string
        taxMode:
          description: >
            The tax mode of a charge.  This field is available when the
            `taxable` field is set to `true`.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxable:
          description: >
            The flag indicates whether the charge is taxable. If this field is
            set to `true`, the `taxCode` and `taxMode` fields must be specified.
          type: boolean
        unBilledReceivablesAccountingCode:
          description: >
            The unBilledReceivablesAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        uniqueToken:
          description: >
            Unique identifier for the charge. This identifier enables you to
            refer to the charge before the charge has an internal identifier in
            Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the charge.
            Then when you update the product, you can use the same unique
            identifier to specify which charge to modify.
          maxLength: 50
          type: string
        validityPeriodType:
          description: >
            **Note**: This field is only available if you have enabled either of
            the following:

            * <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            * <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a>

            * Both <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>


            You can use this field in the following scenarios: 

            * When you create a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge),
            use this field to define the period in which the prepayment units
            are valid to use.


            * When you override the setting of <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment#Commitment_true-up_charge_specific_settings"
            target="_blank">commitment true-up charge</a> from the product
            catalog, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.


            * When you use a standalone order to create a commitment true-up
            charge, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRateplanChargeId
      title: charge
      type: object
    RatePlanFeatureOverride:
      description: |
        Information about feature in rate plan.
      properties:
        customFields:
          $ref: '#/components/schemas/RatePlanFeatureOverrideCustomFields'
        description:
          description: A description of the feature.
          maxLength: 500
          type: string
        featureId:
          description: |
            Internal identifier of the feature in the product catalog.
          type: string
        id:
          description: |
            Internal identifier of the rate plan feature override.
          type: string
      title: ratePlanFeature
      type: object
    RatePlanOverride:
      description: |
        Rate plan associated with a subscription.
      properties:
        chargeOverrides:
          description: |
            List of charges associated with the rate plan.
          items:
            $ref: '#/components/schemas/ChargeOverride'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externallyManagedPlanId:
          description: >
            Indicates the unique identifier for the rate plan purchased on a
            third-party store. This field is used to represent a subscription
            rate plan created through third-party stores.
          type: string
        isFromExternalCatalog:
          description: >
            Indicates whether the rate plan is created from the Zuora product
            catalog or from an external product catalog.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: boolean
        newRatePlanId:
          description: |
            Internal identifier of the rate plan.
          type: string
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanName:
          description: >
            Name of the standalone rate plan.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.    
          items:
            $ref: '#/components/schemas/RatePlanFeatureOverride'
          type: array
        uniqueToken:
          description: >
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the rate
            plan. Then when you update the product, you can use the same unique
            identifier to specify which rate plan to modify.
          maxLength: 50
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a subscription rate plan for this subscription.
          maxLength: 50
          type: string
      required:
        - productRatePlanId
      title: ratePlan
      type: object
    ChangePlanChargeOverride:
      description: |
        Charge associated with a rate plan.
      properties:
        accountReceivableAccountingCode:
          description: >
            The accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The adjustmentLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The adjustmentRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        billing:
          description: |
            Billing information about the charge.
          properties:
            billCycleDay:
              description: >
                Day of the month that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofMonth`.
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              description: >
                Specifies how Zuora determines the day that each billing period
                begins on.

                  * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
                  * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
                  * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
                  * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
                  * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              description: >
                Billing frequency of the charge. The value of this field
                controls the duration of each billing period.


                If the value of this field is `Specific_Days`, `Specific_Months`
                or `Specific_Weeks`, use the `specificBillingPeriod` field to
                specify the duration of each billing period.
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              description: >
                Specifies how Zuora determines when to start new billing
                periods. You can use this field to align the billing periods of
                different charges.


                * `AlignToCharge` - Zuora starts a new billing period on the
                first billing day that falls on or after the date when the
                charge becomes active.

                * `AlignToSubscriptionStart` - Zuora starts a new billing period
                on the first billing day that falls on or after the start date
                of the subscription.

                * `AlignToTermStart` - For each term of the subscription, Zuora
                starts a new billing period on the first billing day that falls
                on or after the start date of the term.


                See the `billCycleType` field for information about how Zuora
                determines the billing day.


                **Note**: This field is not supported in one time charges. 
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              description: >
                Specifies whether to invoice for a billing period on the first
                day of the billing period (billing in advance) or the first day
                of the next billing period (billing in arrears).
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              description: >
                Duration of each billing period in months or weeks, depending on
                the value of the `billingPeriod` field. Only applicable if the
                value of the `billingPeriod` field is `Specific_Months` or
                `Specific_Weeks`.
              type: integer
            weeklyBillCycleDay:
              description: >
                Day of the week that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofWeek`.
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines what type of charge it is:

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge. 

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the type of the commitment for both the
            commitment true-up charge and credit commitment charge, and so you
            must define the type as `CURRENCY`.
          enum:
            - CURRENCY
          type: string
        creditOption:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          description: >
            The chargeModel of a standalone charge.



            Supported charge models:


            * `FlatFee`


            * `PerUnit`


            * `Volume`


            * `Tiered`


            * `DiscountFixedAmount`


            * `DiscountPercentage`



            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        chargeNumber:
          description: >
            Charge number of the charge. For example, C-00000307.


            * If you do not set this field, Zuora will generate a charge number
            starting with a default prefix, for example, C-. This default prefix
            is predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**.

            * If you want to use a custom charge number, do not use the default
            prefix predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**. Use your own prefix, for example,
            SC-. 
          maxLength: 50
          type: string
        chargeType:
          description: >
            The chargeType of a standalone charge.


            Supported charge types:


            * `OneTime`


            * `Recurring`


            * `Usage`


            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        contractAssetAccountingCode:
          description: >
            The contractAssetAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractLiabilityAccountingCode:
          description: >
            The contractLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The contractRecognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          description: >
            The deferredRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        description:
          description: |
            Description of the charge.
          maxLength: 500
          type: string
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            If you specify `SpecificDate` in the `startDate` > `triggerEvent`
            field and want to create a completed order and an active
            subscription, you must specify either the `estimatedStartDate` or
            `startDate` > `specificTriggerDate` field:


            - `estimatedStartDate`: The charge will be in pending status.


            - `specificTriggerDate`: The charge will be in active status.


            The value of this field must be a date within the subscription term.
            The system will then automatically calculate the estimated end date
            for the pending charge. The estimated start and end dates are used
            to manage the estimated charge duration and forecast the revenue for
            the pending charge.


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charge related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charges from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.


            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isRollover:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The value is either "True" or "False". It determines whether the
            rollover fields are needed.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue recognition.


            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        name:
          description: >
            The name of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        negotiatedPriceTable:
          description: >
            Array of negotiated price table information. The rate card entries
            provided in the array will override the existing rate card entries
            in the standard price table to form a negotiated price table that
            will be    

            used during pricing evaluation.



            **Note:** To enable the Negotiated Price Table feature, submit a
            request to <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          items:
            $ref: '#/components/schemas/NegotiatedItems'
          type: array
          additionalProperties: true
        pobPolicy:
          description: >
            The pobPolicy of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
        pricing:
          description: |
            Pricing information about the charge.
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
            usageFlatFee:
              $ref: '#/components/schemas/UsageFlatFeePricingOverride'
            usageOverage:
              $ref: '#/components/schemas/UsageOveragePricingOverride'
            usagePerUnit:
              $ref: '#/components/schemas/UsagePerUnitPricingOverride'
            usageTiered:
              $ref: '#/components/schemas/UsageTieredPricingOverride'
            usageTieredWithOverage:
              $ref: '#/components/schemas/UsageTieredWithOveragePricingOverride'
            usageVolume:
              $ref: '#/components/schemas/UsageVolumePricingOverride'
          type: object
        pricingAttributes:
          description: >
            Container for pricing attribute and value that provide additional
            context for dynamic pricing. The pricing attribute values are used
            to get the charge’s list price from the product catalog. For the
            pricing attribute mapped to a Zuora object field, Zuora will
            retrieve the value automatically, you don’t need to pass its value
            explicitly. If you pass a value that doesn’t match the actual value
            of the Zuora object, an error will be returned. 

            Note that for any pricing attribute mapped to the field of Zuora
            object Usage, because its value is only determined when the usage
            record arrives, you can’t provide a value via Orders API payload and
            Zuora will not retrieve its value automatically.    



            **Note:** To enable Dynamic Pricing, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          type: object
          additionalProperties: true
        productCategory:
          description: >
            The productCategory of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productClass:
          description: >
            The productClass of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productFamily:
          description: >
            The productFamily of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productLine:
          description: >
            The productLine of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productRatePlanChargeId:
          description: >
            Internal identifier of the product rate plan charge that the charge
            is based on. You can specify either `productRatePlanChargeId` or
            `productRatePlanChargeNumber`.
          type: string
        productRatePlanChargeNumber:
          description: >
            Number of a product rate-plan charge for this subscription. You can
            specify either `productRatePlanChargeId` or
            `productRatePlanChargeNumber`.
          type: string
        prorationOption:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
            target="_blank">Usage charge proration</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            You can use this field to specify the charge-level proration option
            for a usage charge or recurring charge when you creating or adding a
            subscription rate plan charge through an order. The tenant-level
            proration option will be overridden.
              * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
              * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
              * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
              * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field.
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            This field is used only when the value of the `prorationOption`
            field is set to `CustomizeProrationOptionOverrides`. 


            Use this field to specify more customized proration options for a
            recurring charge when you creating or adding a subscription rate
            plan charge through an order. The tenant-level proration option will
            be overridden.
          type: object
          properties:
            isProratePartialMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify whether to prorate the recurring
                charge for a partial month. The tenant-level proration option
                will be overridden.
              type: boolean
            prorationUnit:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the unit of proration for a recurring
                charge. The tenant-level proration option will be overridden.
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the number of days counted for a month
                when prorating a recurring charge. The tenant-level proration
                option will be overridden. See more details for each of the
                following enum values in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Common_subscription_information/F_Proration#When_prorating_a_month.2C_assume_30_days_in_a_month_or_use_actual_days.3F"
                target="_blank">Proration</a>.
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          description: >
            The recognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        revRecCode:
          description: |
            Revenue Recognition Code
          maxLength: 70
          type: string
        revRecTriggerCondition:
          description: |
            Specifies the revenue recognition trigger condition.

              * `Contract Effective Date` 
              * `Service Activation Date`
              * `Customer Acceptance Date`
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          description: >
            Specifies the revenue recognition rule, such as `Recognize upon
            invoicing` or `Recognize daily over time`.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. In this
            case, you must set the `rolloverPeriods` field to 1. For example,
            you can define the rollover fund's period length as 5 months,
            shorter than the prepayment charge's validity period: a year.
          type: integer
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: number
        startDate:
          $ref: '#/components/schemas/CreateOrderTriggerParams'
        taxCode:
          description: >
            The taxCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        taxMode:
          description: >
            The taxMode of a standalone charge. 


            Values:

            * `TaxExclusive`

            * `TaxInclusive`


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        unBilledReceivablesAccountingCode:
          description: >
            The unBilledReceivablesAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        uniqueToken:
          description: >
            Unique identifier for the charge. This identifier enables you to
            refer to the charge before the charge has an internal identifier in
            Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the charge.
            Then when you update the product, you can use the same unique
            identifier to specify which charge to modify.
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          description: >
            The identifier of the original upselling charge associated with the
            current charge.


            For a termed subscription, you can now use the "Create an order" API
            operation to perform an Add Product order action to make a product
            quantity upsell for per unit recurring charges. The benefit is that
            the charge added by this approach will be automatically combined
            with the original existing charge for which you want to upsell when
            the subscription is renewed. The approach is as follows:

            * Use an Add Product order action to add a charge that is of the
            same charge type, charge model, and charge end date as the existing
            per unit recurring charge for which you want to make a quantity
            upsell.


            * In the preceding charge to add, use the `upsellOriginChargeNumber`
            field to specify the existing rate plan charge for which you want to
            make the quantity upsell.


            Note that a termed subscription with such upsell charges can not be
            changed to an evergreen subscription.   


            **Note**: The Quantity Upsell feature is in the **Early Adopter**
            phase. We are actively soliciting feedback from a small set of early
            adopters before releasing it as generally available. If you want to
            join this early adopter program, submit a request at [Zuora Global
              Support](https://support.zuora.com).  
          type: string
        validityPeriodType:
          description: >
            **Note**: This field is only available if you have enabled either of
            the following:

            * <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            * <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a>

            * Both <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>


            You can use this field in the following scenarios: 

            * When you create a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge),
            use this field to define the period in which the prepayment units
            are valid to use.


            * When you override the setting of <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment#Commitment_true-up_charge_specific_settings"
            target="_blank">commitment true-up charge</a> from the product
            catalog, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.


            * When you use a standalone order to create a commitment true-up
            charge, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    ChangePlanRatePlanOverride:
      description: |
        Information about the new product rate plan to add. 
      properties:
        chargeOverrides:
          description: |
            List of charges associated with the rate plan.
          items:
            $ref: '#/components/schemas/ChangePlanChargeOverride'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externallyManagedPlanId:
          description: >
            Indicates the unique identifier for the rate plan purchased on a
            third-party store. This field is used to represent a subscription
            rate plan created through third-party stores.
          type: string
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/RatePlanFeatureOverride'
          type: array
        uniqueToken:
          description: >
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the rate
            plan. Then when you update the product, you can use the same unique
            identifier to specify which rate plan to modify.
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    ChangePlan:
      description: >
        Information about an order action of type `ChangePlan`.


        **Note**: The change plan type of order action is supported for the  <a
        href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
        target="_blank">Order to Revenue</a> feature. However, it is currently
        not supported for the <a
        href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
        target="_blank">Billing - Revenue Integration</a> feature. When Billing
        - Revenue Integration is enabled, the change plan type of order action
        will no longer be applicable in Zuora Billing.
      properties:
        effectivePolicy:
          description: >
            * If the rate plan change (from old to new) is an upgrade, the
            effective policy is `EffectiveImmediately` by default.

            * If the rate plan change (from old to new) is a downgrade, the
            effective policy is `EffectiveEndOfBillingPeriod` by default.

            * Otherwise, the effective policy is `SpecificDate` by default.
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        newProductRatePlan:
          $ref: '#/components/schemas/ChangePlanRatePlanOverride'
        productRatePlanId:
          description: >
            ID of the rate plan to remove. This can be the latest version or any
            history version of ID.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            ID of the rate plan to remove. This can be the latest version or any
            history version of ID.
          type: string
        subType:
          description: >
            This field is used to choose the sub type for your change plan order
            action.


            However, if you do not set this field, the field will be
            automatically generated by the system according to the following
            rules:


            When the old and new rate plans are within the same Grading catalog
            group:

            * If the grade of new plan is greater than that of the old plan,
            this is an "Upgrade".

            * If the grade of new plan is less than that of the old plan, this
            is a "Downgrade".

            * If the grade of new plan equals that of the old plan, this is a
            "Crossgrade".


            When the old and new rate plans are not in the same Grading catalog
            group, or either has no group, this is "PlanChanged".
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
      title: changePlan
      type: object
    BillToContact:
      allOf:
        - description: |
            Contact details associated with an account.
          properties:
            address1:
              description: >
                First line of the contact's address. This is often a street
                address or a business name.
              maxLength: 255
              type: string
            address2:
              description: |
                Second line of the contact's address.
              maxLength: 255
              type: string
            city:
              description: |
                City of the contact's address.
              maxLength: 40
              type: string
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the bill-to contact to
                calculate tax.
              maxLength: 64
              type: string
            county:
              description: |
                County of the contact's address.
              maxLength: 32
              type: string
            fax:
              description: |
                Fax number of the contact.
              maxLength: 40
              type: string
            firstName:
              description: |
                First name of the contact.
              maxLength: 100
              type: string
            homePhone:
              description: |
                Home phone number of the contact.
              maxLength: 40
              type: string
            lastName:
              description: |
                Last name of the contact.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                Mobile phone number of the contact.
              maxLength: 40
              type: string
            nickname:
              description: |
                Nickname of the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: >
                Additional phone number of the contact. Use the `otherPhoneType`
                field to specify the type of phone number.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                Specifies the type of phone number in the `otherPhone` field.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                Personal email address of the contact.
              format: email
              maxLength: 80
              type: string
            postalCode:
              description: |
                ZIP code or other postal code of the contact's address.
              maxLength: 20
              type: string
            state:
              description: |
                State or province of the contact's address.
              maxLength: 40
              type: string
            taxRegion:
              description: >
                Region defined in your taxation rules. Only applicable if you
                use Zuora Tax.
              maxLength: 32
              type: string
            workEmail:
              description: |
                Business email address of the contact.
              format: email
              maxLength: 80
              type: string
            workPhone:
              description: |
                Business phone number of the contact.
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    SoldToContact:
      allOf:
        - description: |
            Contact details associated with an account.
          properties:
            address1:
              description: >
                First line of the contact's address. This is often a street
                address or a business name.
              maxLength: 255
              type: string
            address2:
              description: |
                Second line of the contact's address.
              maxLength: 255
              type: string
            city:
              description: |
                City of the contact's address.
              maxLength: 40
              type: string
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the sold-to contact to
                calculate tax. A bill-to contact may be used if no sold-to
                contact is provided.
              maxLength: 64
              type: string
            county:
              description: |
                County of the contact's address.
              maxLength: 32
              type: string
            fax:
              description: |
                Fax number of the contact.
              maxLength: 40
              type: string
            firstName:
              description: |
                First name of the contact.
              maxLength: 100
              type: string
            homePhone:
              description: |
                Home phone number of the contact.
              maxLength: 40
              type: string
            lastName:
              description: |
                Last name of the contact.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                Mobile phone number of the contact.
              maxLength: 40
              type: string
            nickname:
              description: |
                Nickname of the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: >
                Additional phone number of the contact. Use the `otherPhoneType`
                field to specify the type of phone number.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                Specifies the type of phone number in the `otherPhone` field.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                Personal email address of the contact.
              format: email
              maxLength: 80
              type: string
            postalCode:
              description: |
                ZIP code or other postal code of the contact's address.
              maxLength: 20
              type: string
            state:
              description: |
                State or province of the contact's address.
              maxLength: 40
              type: string
            taxRegion:
              description: >
                Region defined in your taxation rules. Only applicable if you
                use Zuora Tax.
              maxLength: 32
              type: string
              nullable: true
            workEmail:
              description: |
                Business email address of the contact.
              format: email
              maxLength: 80
              type: string
            workPhone:
              description: |
                Business phone number of the contact.
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    CreateSubscription:
      description: |
        Information about an order action of type `CreateSubscription`.
      properties:
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        currency:
          description: >
            The code of currency that is used for this subscription. If the
            currency is not selected, the default currency from the account will
            be used.


            All subscriptions in the same order must use the same currency. The
            currency for a subscription cannot be changed.

            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currencies</a> feature enabled.
          maxLength: 3
          type: string
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the subscription.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          description: >
            Specifies whether the subscription appears on a separate invoice
            when Zuora generates invoices.
          type: boolean
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        newSubscriptionOwnerAccount:
          description: >
            Information about a new account that will own the subscription. Only
            available if you have enabled the Owner Transfer feature.


            **Note:** The Owner Transfer feature is in **Limited Availability**.
            If you wish to have access to the feature, submit a request at
            [Zuora Global Support](http://support.zuora.com/).


            If you do not set this field or the `subscriptionOwnerAccountNumber`
            field, the account that owns the order will also own the
            subscription. Zuora will return an error if you set this field and
            the `subscriptionOwnerAccountNumber` field.
          properties:
            accountNumber:
              description: |
                Account number. For example, A00000001.
              maxLength: 70
              type: string
            autoPay:
              description: >
                Specifies whether future payments are automatically billed when
                they are due.
              type: boolean
            batch:
              description: >
                Name of the billing batch that the account belongs to. For
                example, Batch1.
              type: string
            billCycleDay:
              description: >
                Day of the month that the account prefers billing periods to
                begin on. If set to 0, the bill cycle day will be set as
                "AutoSet".
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContact'
            communicationProfileId:
              description: >
                Internal identifier of the communication profile that Zuora uses
                when sending notifications to the account's contacts.
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            crmId:
              description: |
                External identifier of the account in a CRM system.
              maxLength: 100
              type: string
            currency:
              description: |
                ISO 3-letter currency code (uppercase). For example, USD.
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            hpmCreditCardPaymentMethodId:
              description: >
                The ID of the payment method associated with this account. The
                payment method specified for this field will be set as the
                default payment method of the account.


                If the `autoPay` field is set to `true`, you must provide the
                credit card payment method ID for either this field or the
                `creditCard` field,

                but not both.


                For the Credit Card Reference Transaction payment method, you
                can specify the payment method ID in this field or use the
                `paymentMethod` field to create a CC Reference Transaction
                payment method for an account.
              type: string
            invoiceDeliveryPrefsEmail:
              description: >
                Specifies whether to turn on the invoice delivery method 'Email'
                for the new account. 

                Values are: 


                * `true` (default). Turn on the invoice delivery method 'Email'
                for the new account.

                * `false`. Turn off the invoice delivery method 'Email' for the
                new account.         
              type: boolean
            invoiceDeliveryPrefsPrint:
              description: >
                Specifies whether to turn on the invoice delivery method 'Print'
                for the new account.

                Values are: 


                * `true`. Turn on the invoice delivery method 'Print' for the
                new account.

                * `false` (default). Turn off the invoice delivery method
                'Print' for the new account.
              type: boolean
            invoiceTemplateId:
              description: >
                Internal identifier of the invoice template that Zuora uses when
                generating invoices for the account.
              type: string
            name:
              description: |
                Account name.
              maxLength: 70
              type: string
            notes:
              description: >
                Notes about the account. These notes are only visible to Zuora
                users.
              maxLength: 65535
              type: string
            parentId:
              description: >-
                Identifier of the parent customer account for this Account
                object. Use this field if you have <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
                target="_blank">Customer Hierarchy</a> enabled.
              type: string
            paymentGateway:
              description: >
                The payment gateway that Zuora uses when processing electronic
                payments and refunds for the account. If you do not specify this
                field or if the value of this field is null, Zuora uses your
                default payment gateway.
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              description: >
                Name of the payment term associated with the account. For
                example, "Net 30". The payment term determines the due dates of
                invoices.
              type: string
            soldToContact:
              $ref: '#/components/schemas/SoldToContact'
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        notes:
          description: >
            Notes about the subscription. These notes are only visible to Zuora
            users.
          maxLength: 500
          type: string
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For
            example, `Net 30`. The payment term determines the due dates of
            invoices.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the subscription.


            **Note:** 
               To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        subscribeToRatePlans:
          description: |
            List of rate plans associated with the subscription.
          items:
            $ref: '#/components/schemas/RatePlanOverride'
          type: array
        subscriptionNumber:
          description: >
            Subscription number of the subscription. For example, A-S00000001.


            If you do not set this field, Zuora will generate the subscription
            number.
          maxLength: 100
          type: string
        subscriptionOwnerAccountNumber:
          description: >
            Account number of an existing account that will own the
            subscription. For example, A00000001.


            If you do not set this field or the `newSubscriptionOwnerAccount`
            field, the account that owns the order will also own the
            subscription. Zuora will return an error if you set this field and
            the `newSubscriptionOwnerAccount` field.
          maxLength: 70
          type: string
        invoiceOwnerAccountNumber:
          description: >
            Account number of an existing account that will own the invoice. For
            example, A00000001. If you do not set this field, the account that
            owns the order will also own this invoice.
          maxLength: 70
          type: string
        terms:
          description: |
            Container for the terms and renewal settings of the subscription.
          properties:
            autoRenew:
              description: >
                Specifies whether the subscription automatically renews at the
                end of the each term. Only applicable if the type of the first
                term is `TERMED`.
              type: boolean
            initialTerm:
              description: |
                Information about the first term of the subscription.
              properties:
                period:
                  description: >
                    Duration of the first term in months, years, days, or weeks,
                    depending on the value of the `periodType` field. Only
                    applicable if the value of the `termType` field is `TERMED`.
                  type: integer
                periodType:
                  description: >
                    Unit of time that the first term is measured in. Only
                    applicable if the value of the `termType` field is `TERMED`.
                  enum:
                    - Month
                    - Year
                    - Day
                    - Week
                  type: string
                startDate:
                  description: |
                    Start date of the first term, in YYYY-MM-DD format.
                  format: date
                  type: string
                termType:
                  description: >
                    Type of the first term. If the value of this field is
                    `TERMED`, the first term has a predefined duration based on
                    the value of the `period` field. If the value of this field
                    is `EVERGREEN`, the first term does not have a predefined
                    duration.
                  enum:
                    - TERMED
                    - EVERGREEN
                  type: string
              required:
                - termType
              type: object
            renewalSetting:
              description: >
                Specifies the type of the terms that follow the first term if
                the subscription is renewed. Only applicable if the type of the
                first term is `TERMED`.


                * `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a
                predefined duration. The first entry in `renewalTerms` specifies
                the duration of the second term of the subscription, the second
                entry in `renewalTerms` specifies the duration of the third term
                of the subscription, and so on. The last entry in `renewalTerms`
                specifies the ultimate duration of each renewal term.

                * `RENEW_TO_EVERGREEN` - The second term of the subscription
                does not have a predefined duration.
              enum:
                - RENEW_WITH_SPECIFIC_TERM
                - RENEW_TO_EVERGREEN
              type: string
            renewalTerms:
              description: >
                List of renewal terms of the subscription. Only applicable if
                the type of the first term is `TERMED` and the value of the
                `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.
              items:
                $ref: '#/components/schemas/RenewalTerm'
              type: array
          required:
            - initialTerm
            - renewalTerms
          type: object
      title: createSubscription
      type: object
    GetOrderResume:
      description: |
        Information about an order action of type `Resume`.
      properties:
        extendsTerm:
          description: >
            Specifies whether to extend the subscription term by the length of
            time the suspension is in effect. Note this field is not applicable
            in a Resume order action auto-created by the Order Metrics
            migration.
          type: boolean
        resumeDate:
          description: |
            The resume date when the resumption takes effect.
          format: date
          type: string
        resumePeriods:
          description: >
            This field is applicable only when the `resumePolicy` field is set
            to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must
            be used together with the `resumePeriodsType` field. Note this field
            is not applicable in a Resume order action auto-created by the Order
            Metrics migration.


            The total number of the periods used to specify when a subscription
            resumption takes effect. The subscription resumption will take place
            after the specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          type: integer
        resumePeriodsType:
          description: >
            This field is applicable only when the `resumePolicy` field is set
            to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must
            be used together with the `resumePeriods` field. Note this field is
            not applicable in a Resume order action auto-created by the Order
            Metrics migration.


            The period type used to specify when a subscription resumption takes
            effect. The subscription suspension will take place after the
            specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
        resumePolicy:
          description: >
            Resume methods. Specify a way to resume a subscription. See [Resume
            Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date)
            for more information. Note this field is not applicable in a Resume
            order action auto-created by the Order Metrics migration.


            If `SuspendDate` is specfied, the resumption will take place on the
            same day as the suspension. 
          enum:
            - Today
            - FixedPeriodsFromSuspendDate
            - FixedPeriodsFromToday
            - SpecificDate
            - SuspendDate
          type: string
        resumeSpecificDate:
          description: >
            This field is applicable only when the `resumePolicy` field is set
            to `SpecificDate`. Note this field is not applicable in a Resume
            order action auto-created by the Order Metrics migration.


            A specific date when the subscription resumption takes effect, in
            YYYY-MM-DD format. The value should not be earlier than the
            subscription suspension date.
          format: date
          type: string
          nullable: true
      title: Resume
      type: object
    GetOrderSuspend:
      description: |
        Information about an order action of type `Suspend`.
      properties:
        suspendDate:
          description: |
            The suspend date when the suspension takes effect. 
          format: date
          type: string
        suspendPeriods:
          description: >
            This field is applicable only when the `suspendPolicy` field is set
            to `FixedPeriodsFromToday`. It must be used together with the
            `suspendPeriodsType` field. Note this field is not applicable in a
            Suspend order action auto-created by the Order Metrics migration.


            The total number of the periods used to specify when a subscription
            suspension takes effect. The subscription suspension will take place
            after the specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          type: integer
          nullable: true
        suspendPeriodsType:
          description: >
            This field is applicable only when the `suspendPolicy` field is set
            to `FixedPeriodsFromToday`. It must be used together with the
            `suspendPeriods` field. Note this field is not applicable in a
            Suspend order action auto-created by the Order Metrics migration.


            The period type used to specify when a subscription suspension takes
            effect. The subscription suspension will take place after the
            specified time frame (`suspendPeriods` multiplied by
            `suspendPeriodsType`) from today's date. 
          enum:
            - Day
            - Week
            - Month
            - Year
          type: string
          nullable: true
        suspendPolicy:
          description: >
            Suspend methods. Specify a way to suspend a subscription. See
            [Suspend
            Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date)
            for more information. Note this field is not applicable in a Suspend
            order action auto-created by the Order Metrics migration.
          enum:
            - Today
            - EndOfLastInvoicePeriod
            - FixedPeriodsFromToday
            - SpecificDate
          type: string
          nullable: true
        suspendSpecificDate:
          description: >
            This field is applicable only when the `suspendPolicy` field is set
            to `SpecificDate`. Note this field is not applicable in a Suspend
            order action auto-created by the Order Metrics migration.


            A specific date when the subscription suspension takes effect, in
            YYYY-MM-DD format. The value should not be earlier than the
            subscription's contract effective date or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            than the subscription's term end date.
          format: date
          type: string
          nullable: true
      title: Suspend
      type: object
    InitialTerm:
      description: The length of the period for the current subscription term.
      properties:
        period:
          description: Specify only when the termType is 'TERMED'.
          minimum: 0
          type: integer
        periodType:
          description: Specify only when the termType is 'TERMED'.
          enum:
            - Month
            - Year
            - Day
            - Week
          type: string
        startDate:
          description: |
            The start date of the current term.
          format: date
          type: string
        termType:
          enum:
            - TERMED
            - EVERGREEN
          type: string
      required:
        - termType
      type: object
    TermsAndConditions:
      description: |
        Information about an order action of type `TermsAndConditions`.
      properties:
        autoRenew:
          type: boolean
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        clearingExistingBillToContact:
          default: false
          description: >
            Whether to clear the existing bill-to contact ID at the subscription
            level. This field is mutually exclusive with the `billToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceGroupNumber:
          default: false
          description: >
            Whether to clear the existing invoice group number at the
            subscription level. This field is mutually exclusive with the
            `invoiceGroupNumber` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          description: >
            Whether to clear the existing invoice template ID at the
            subscription level. This field is mutually exclusive with the
            `invoiceTemplateId` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingPaymentTerm:
          default: false
          description: >
            Whether to clear the existing payment term at the subscription
            level. This field is mutually exclusive with the `paymentTerm`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSequenceSet:
          default: false
          description: >
            Whether to clear the existing sequence set ID at the subscription
            level. This field is mutually exclusive with the `sequenceSetId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingShipToContact:
          default: false
          description: >
            Whether to clear the existing ship-to contact ID at the subscription
            level. This field is mutually exclusive with the `shipToContactId`
            field.


            To access this field, you must have the <b>ShipToContactSupport</b>
            permission. If you want to enable this permission, submit a request
            at <a href="http://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          type: boolean
        clearingExistingSoldToContact:
          default: false
          description: >
            Whether to clear the existing sold-to contact ID at the subscription
            level. This field is mutually exclusive with the `soldToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        initialTerm:
          $ref: '#/components/schemas/InitialTerm'
        communicationProfileId:
          description: >
            The ID of the communication profile associated with the
            subscription.


            **Note**: This field is available in the request body only if you
            have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
            target="_blank">Flexible Billing Attributes</a>
                feature turned on. The value is `null` in the response body without this feature turned on.
          type: string
          nullable: true
        clearingExistingCommunicationProfile:
          default: false
          description: >
            Whether to clear the existing communication profile at the
            subscription

            level. This field is mutually exclusive with the
            `communicationProfileId` field.
          type: boolean
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the subscription.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          maxLength: 255
          nullable: true
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For
            example, `Net 30`. The payment term determines the due dates of
            invoices.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        scheduledCancelDate:
          description: >-
            The date when the subscription is scheduled to be canceled. The
            subscription is not canceled until the date specified in this field.
          type: string
          format: date
        scheduledSuspendDate:
          description: >-
            The date when the subscription is scheduled to be suspended. The
            subscription is not suspended until the date specified in this
            field.
          type: string
          format: date
        scheduledResumeDate:
          description: >-
            The date when the subscription is scheduled to be resumed. The
            subscription is not resumed until the date specified in this field.
          type: string
          format: date
        clearingScheduledCancelDate:
          description: Whether to clear the value of the `scheduledCancelDate` field.
          type: boolean
        clearingScheduledSuspendDate:
          description: Whether to clear the value of the `scheduledSuspendDate` field.
          type: boolean
        clearingScheduledResumeDate:
          description: Whether to clear the value of the `scheduledResumeDate` field.
          type: boolean
        renewalSetting:
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          type: string
        renewalTerms:
          items:
            $ref: '#/components/schemas/RenewalTerm'
          type: array
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.
              
            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the subscription.

            **Note:** 
                To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
      title: termsAndConditions
      type: object
    RecurringDeliveryPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              type: number
          type: object
    UsageFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
          type: object
    UsageOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            includedUnits:
              description: >
                A certain quantity of units for free in the overage charge
                model. It cannot be negative. It must be 0 and above. Decimals
                are allowed.
              type: number
            overagePrice:
              type: number
          type: object
    UsagePerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            listPrice:
              type: number
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.
              type: number
          type: object
    UsageTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    UsageTieredWithOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            overagePrice:
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    UsageVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/PriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/ChargeTier'
              type: array
          type: object
    PricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/ChargeModelDataOverride'
          description: >
            Container for charge model configuration data.


            **Note**: This field is only available if you have the High Water
            Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models
            enabled. The High Water Mark and Pre-Rated Pricing charge models are
            available for customers with Enterprise and Nine editions by
            default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountPricingUpdate'
          description: |
            Pricing information about a discount charge.
        recurringDelivery:
          allOf:
            - $ref: '#/components/schemas/RecurringDeliveryPricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the
            "delivery" charge model. This field is only available if you have
            the Delivery Pricing charge model enabled.
        recurringFlatFee:
          allOf:
            - $ref: '#/components/schemas/RecurringFlatFeePricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "flat
            fee" charge model. In this charge model, the charge has a fixed
            price.
        recurringPerUnit:
          allOf:
            - $ref: '#/components/schemas/RecurringPerUnitPricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "per
            unit" charge model. In this charge model, the charge has a fixed
            price per unit purchased.
        recurringTiered:
          allOf:
            - $ref: '#/components/schemas/RecurringTieredPricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "tiered
            pricing" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            purchased.
        recurringVolume:
          allOf:
            - $ref: '#/components/schemas/RecurringVolumePricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "volume
            pricing" charge model. In this charge model, the charge has a
            variable price per unit, depending on how many units are purchased.
        usageFlatFee:
          allOf:
            - $ref: '#/components/schemas/UsageFlatFeePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "flat fee"
            charge model. In this charge model, the charge has a fixed price.
        usageOverage:
          allOf:
            - $ref: '#/components/schemas/UsageOveragePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "overage"
            charge model. In this charge model, the charge has an allowance of
            free units and a fixed price per additional unit consumed.
        usagePerUnit:
          allOf:
            - $ref: '#/components/schemas/UsagePerUnitPricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "per unit"
            charge model. In this charge model, the charge has a fixed price per
            unit consumed.
        usageTiered:
          allOf:
            - $ref: '#/components/schemas/UsageTieredPricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "tiered
            pricing" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            consumed.
        usageTieredWithOverage:
          allOf:
            - $ref: '#/components/schemas/UsageTieredWithOveragePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "tiered with
            overage" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            consumed. The charge also has a fixed price per unit consumed beyond
            the limit of the final tier.
        usageVolume:
          allOf:
            - $ref: '#/components/schemas/UsageVolumePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "volume
            pricing" charge model. In this charge model, the charge has a
            variable price per unit, depending on how many units are consumed.
      type: object
    ChargeUpdate:
      description: >-
        The JSON object containing the information for a charge update in the
        'UpdateProduct' type order action.
      properties:
        billing:
          $ref: '#/components/schemas/BillingUpdate'
        chargeNumber:
          description: >
            The number of the charge to be updated. The value of this field is
            inherited from the `subscriptions` > `orderActions` > `addProduct` >
            `chargeOverrides` > `chargeNumber` field. 
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        description:
          type: string
        effectiveDate:
          $ref: '#/components/schemas/TriggerParams'
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            The value must be a date within the subscription term. The system
            will then automatically calculate the estimated end date for the
            pending charge. The estimated start and end dates are used to manage
            the estimated charge duration and forecast the revenue for the
            pending charge. 


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        pricing:
          allOf:
            - $ref: '#/components/schemas/PricingUpdate'
          description: |
            Pricing information about the charge.
        uniqueToken:
          description: |
            description: |
              A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.
          type: string
      type: object
    RatePlanUpdate:
      description: |
        Information about an order action of type `UpdateProduct`.
      properties:
        chargeUpdates:
          description: >
            Array of the JSON objects containing the information for a charge
            update in the `updateProduct` type of order action.
          items:
            $ref: '#/components/schemas/ChargeUpdate'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externallyManagedPlanId:
          description: >
            Indicates the unique identifier for the rate plan purchased on a
            third-party store. This field is used to represent a subscription
            rate plan created through third-party stores.
          type: string
        newRatePlanId:
          description: >
            Internal identifier of the updated rate plan in the new subscription
            version.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            Internal identifier of the rate plan that was updated. It can be the
            latest version or any history version id.
          type: string
        specificUpdateDate:
          description: >
            The specific date when the Update Product order action takes
            effect.  This field allows you to update a charge before a
            future-dated Update Product order action on the subscription. The
            format of the date is yyyy-mm-dd.


            **Note**: After you use this option, the charge's `TriggerEvent`
            field value will be changed to `SpecificDate`. 


            See [Update a Product on Subscription with Future-dated
            Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates)
            for more information about this feature.
          format: date
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/RatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
        uniqueToken:
          description: >
            A unique string to represent the rate plan in the order. The unique
            token is used to perform multiple actions against a newly added rate
            plan. For example, if you want to add and update a product in the
            same order, assign a unique token to the newly added rate plan and
            use that token in future order actions.
          type: string
      title: updateProduct
      type: object
    OrderAction:
      description: Represents the processed order action.
      properties:
        addProduct:
          $ref: '#/components/schemas/RatePlanOverride'
        cancelSubscription:
          $ref: '#/components/schemas/CancelSubscription'
        changePlan:
          $ref: '#/components/schemas/ChangePlan'
        changeReason:
          description: |
            The change reason set for an order action when an order is created.
          type: string
        createSubscription:
          $ref: '#/components/schemas/CreateSubscription'
        customFields:
          $ref: '#/components/schemas/OrderActionObjectCustomFields'
        id:
          description: The Id of the order action processed in the order.
          type: string
        orderItems:
          description: >
            The `orderItems` nested field is only available to existing Orders
            customers who already have access to the field.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.
          items:
            $ref: '#/components/schemas/OrderItem'
          type: array
        orderMetrics:
          description: >
            The container for order metrics.


            **Note:** The following objects and fields of the Order Metrics are
            end of support. Any new customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            or [Orders
            Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization)
            will not get these metrics.

            * The Order ELP and Order Item objects 

            * The "Generated Reason" and "Order Item ID" fields in the Order
            MRR, Order TCB, Order TCV, and Order Quantity objects


            Zuora no longer provides product support, and bug fixes or security
            issues are no longer addressed.


            **Note:** As of Zuora Billing Release 306, Zuora has upgraded the
            methodologies for calculating metrics in
            [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders).
            The new methodologies are reflected in the following Order Delta
            Metrics objects. 

            * [Order Delta
            Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)

            * [Order Delta
            Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)

            * [Order Delta
            Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)


            It is recommended that all customers use the new [Order Delta
            Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics).
            If you are an existing [Order
            Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders)
            customer and want to migrate to Order Delta Metrics, submit a
            request at [Zuora Global Support](https://support.zuora.com/).


            Whereas new customers, and existing customers not currently on
            [Order
            Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders),
            will no longer have access to Order Metrics, existing customers
            currently using Order Metrics will continue to be supported.
          items:
            $ref: '#/components/schemas/orderMetric'
          type: array
        ownerTransfer:
          $ref: '#/components/schemas/OwnerTransfer'
        removeProduct:
          $ref: '#/components/schemas/RemoveProduct'
        renewSubscription:
          $ref: '#/components/schemas/RenewSubscription'
        resume:
          $ref: '#/components/schemas/GetOrderResume'
        sequence:
          description: The sequence of the order actions processed in the order.
          type: integer
        suspend:
          $ref: '#/components/schemas/GetOrderSuspend'
        termsAndConditions:
          $ref: '#/components/schemas/TermsAndConditions'
        triggerDates:
          description: >
            Container for the contract effective, service activation, and
            customer acceptance dates of the order action. 


            If [Zuora is configured to require service
            activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F)
            and the `ServiceActivation` field is not set for a
            `CreateSubscription` order action, a `Pending` order and a `Pending
            Activation` subscription are created.


            If [Zuora is configured to require customer
            acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F)
            and the `CustomerAcceptance` field is not set for a
            `CreateSubscription` order action, a `Pending` order and a `Pending
            Acceptance` subscription are created. At the same time, if the
            service activation date field is also required and not set, a
            `Pending` order and a `Pending Activation` subscription are created
            instead.


            If [Zuora is configured to require service
            activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F)
            and the `ServiceActivation` field is not set for either of the
            following order actions, a `Pending` order is created. The
            subscription status is not impacted. **Note:** This feature is in
            **Limited Availability**. If you want to have access to the feature,
            submit a request at [Zuora Global
            Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions

            If [Zuora is configured to require customer
            acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F)
            and the `CustomerAcceptance` field is not set for either of the
            following order actions, a `Pending` order is created. The
            subscription status is not impacted. **Note:** This feature is in
            **Limited Availability**. If you want to have access to the feature,
            submit a request at [Zuora Global
            Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions
          items:
            $ref: '#/components/schemas/TriggerDate'
          type: array
        type:
          description: >
            Type of the order action.


            **Note**: The change plan type of order action is supported for the 
            <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature. However, it is
            currently not supported for the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> feature. When
            Billing - Revenue Integration is enabled, the change plan type of
            order action will no longer be applicable in Zuora Billing.
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        updateProduct:
          $ref: '#/components/schemas/RatePlanUpdate'
          description: ''
      type: object
    RampChargeResponse:
      properties:
        chargeNumber:
          description: The number of the rate plan charge.
          type: string
      title: charges
      type: object
    RampIntervalResponse:
      properties:
        description:
          description: The short description of the interval.
          type: string
        endDate:
          description: The end date of the interval.
          format: date
          type: string
        name:
          description: The name of the interval.
          type: string
        startDate:
          description: The start date of the interval.
          format: date
          type: string
      title: intervals
      type: object
    RampResponse:
      properties:
        charges:
          description: >-
            Container for the rate plan charges that are considered as part of
            the ramp deal.
          items:
            $ref: '#/components/schemas/RampChargeResponse'
          type: array
        description:
          description: The short description of the ramp.
          type: string
        id:
          description: The ID of the ramp.
          type: string
        intervals:
          description: >-
            Container for the intervals that the ramp is split into in its
            timeline.
          items:
            $ref: '#/components/schemas/RampIntervalResponse'
          type: array
        name:
          description: The name of the ramp.
          type: string
        number:
          description: >-
            The number of the ramp. It is automaticcally generated by the
            billing system.
          type: string
        subscriptionNumber:
          description: >-
            The number of the subscription that is considered as part of the
            ramp deal.
          type: string
      title: Ramp
      type: object
      description: >
        **Note**: This field is only available if you have the Ramps feature

        enabled. The

        [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)

        feature must be enabled before you can access the

        [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics)

        feature. The Ramps feature is available for customers with

        Enterprise and Nine editions by default. If you are a Growth

        customer, see [Zuora

        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)

        for pricing information coming October 2020.



        The ramp definition.
    Order:
      description: Represents the order information that will be returned in the GET call.
      properties:
        category:
          default: NewSales
          description: >
            Category of the order to indicate a product sale or return. Default
            value is `NewSales`.
          enum:
            - NewSales
            - Return
          type: string
        commitments:
          items:
            $ref: '#/components/schemas/GetCommitmentOutputListOrders'
          type: array
          description: |
            A list of commitments.
        createdBy:
          description: The ID of the user who created this order.
          type: string
        createdDate:
          description: >-
            The time that the order gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
        currency:
          description: Currency code.
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        description:
          description: A description of the order.
          maxLength: 500
          type: string
        existingAccountNumber:
          description: |
            The account number that this order has been created under.
          type: string
        existingAccountDetails:
          description: >
            The account basic information that this order has been created
            under.
          properties:
            basicInfo:
              $ref: '#/components/schemas/GETAccountTypeBasicInfo'
            billToContact:
              $ref: '#/components/schemas/GETAccountTypeBillToContact'
          type: object
        invoiceScheduleId:
          description: >
            The ID of the invoice schedule associated with the order.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
          type: integer
        orderDate:
          description: >-
            The date when the order is signed. All the order actions under this
            order will use this order date as the contract effective date if no
            additinal contractEffectiveDate is provided.
          format: date
          type: string
        orderLineItems:
          description: >
            [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            are non subscription based items created by an Order, representing
            transactional charges such as one-time fees, physical goods, or
            professional service charges that are not sold as subscription
            services. 


            With the Order Line Items feature enabled, you can now launch
            non-subscription and unified monetization business models in Zuora,
            in addition to subscription business models. 


            **Note:** The [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature is now generally available to all Zuora customers. You need
            to enable the
            [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
            feature to access the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature. As of Zuora Billing Release 313 (November 2021), new
            customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            will have the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
            feature enabled by default.       
          items:
            $ref: '#/components/schemas/OrderLineItemRetrieveOrder'
          type: array
        orderNumber:
          description: The order number of the order.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        reasonCode:
          description: >
            Values of reason code configured in **Billing Settings** >
            **Configure Reason Codes** through Zuora UI. Indicates the reason
            when a return order line item occurs.
          maxLength: 255
          type: string
        schedulingOptions:
          description: |
            Information of scheduled order.
          properties:
            scheduledDate:
              description: |
                The date for the order scheduled.
              format: date
              type: string
            scheduledDatePolicy:
              description: Date policy of the scheduled order.
              enum:
                - SpecificDate
              type: string
          type: object
        scheduledOrderActivationResponse:
          $ref: '#/components/schemas/PostOrderResponseType'
        status:
          description: >
            The status of the order. If the order contains any `Pending
            Activation` or `Pending Acceptance` subscription, the order status
            will be `Pending`; If the order is in draft status, the order status
            will be `Draft`; otherwise the order status is `Completed`.


            The available order statuses are as follow:

            - `Draft`: The order is in draft status.

            - `Pending`: The order is in pending status.

            - `Completed`: The order is in completed status.

            - `Cancelled`: The draft or scheduled order is cancelled.

            - `Scheduled`: The order is in scheduled status and it is only valid
            if the Scheduled Orders feature is enabled.

            - `Executing`: The scheduled order is executed by a scheduler and it
            is only valid if the Scheduled Orders feature is enabled.

            - `Failed`: The scheduled order has failed.

            - `Reverted`: The order is reverted. This status is only available
            to the orders that include single version subscriptions. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/Single_Version_Subscription"
            target="_blank">Single Version Subscription</a>.
          enum:
            - Draft
            - Pending
            - Completed
            - Cancelled
            - Scheduled
            - Executing
            - Failed
            - Reverted
          type: string
        subscriptions:
          description: >-
            Represents a processed subscription, including the origin request
            (order actions) that create this version of subscription and the
            processing result (order metrics). The reference part in the request
            will be overridden with the info in the new subscription version.
          items:
            properties:
              baseVersion:
                description: The base version of the subscription.
                type: integer
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              externallyManagedBy:
                description: >
                  An enum field on the Subscription object to indicate the name
                  of a third-party store. This field is used to represent
                  subscriptions created through third-party stores.
                enum:
                  - Amazon
                  - Apple
                  - Google
                  - Roku
                type: string
                nullable: true
              newVersion:
                description: The latest version of the subscription.
                type: integer
              notes:
                description: Notes about the subscription.
                type: string
              orderActions:
                items:
                  $ref: '#/components/schemas/OrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampResponse'
              sequence:
                description: >-
                  The sequence number of a certain subscription processed by the
                  order.
                type: integer
              subscriptionNumber:
                description: >-
                  The new subscription number for a new subscription created, or
                  the existing subscription number. Unlike the order request,
                  the subscription number here always has a value.
                type: string
              subscriptionOwnerAccountNumber:
                description: The number of the account that owns the subscription.
                type: string
              subscriptionOwnerAccountDetails:
                description: >
                  The account basic information that this order has been created
                  under. This is

                  also the invoice owner of the subscriptions included in this
                  order.
                properties:
                  basicInfo:
                    $ref: '#/components/schemas/GETAccountTypeBasicInfo'
                  soldToContact:
                    $ref: '#/components/schemas/GETAccountTypeSoldToContact'
                type: object
            type: object
          type: array
        updatedBy:
          description: The ID of the user who updated this order.
          type: string
        updatedDate:
          description: >-
            The time that the order gets updated in the system(for example, an
            order description update), in the `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
      type: object
    GetAllOrdersResponseType:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        orders:
          items:
            $ref: '#/components/schemas/Order'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    CommitmentBaseAttributesRequest:
      type: object
      title: UpsertOrderCommitmentBaseAttributes
      properties:
        commitmentNumber:
          description: |
            The commitment number.
          type: string
          maxLength: 100
        name:
          description: |
            The name of the commitment. 
          type: string
          maxLength: 255
        type:
          $ref: '#/components/schemas/CommitmentTypeEnum'
        description:
          description: |
            The description of the commitment. 
          type: string
          maxLength: 500
        priority:
          description: >
            It defines the evaluation order of the commitment. The lower the
            number, the higher the priority.

            When two commitments have the same priority, the commitment that was
            created initially will be evaluated first.
          type: integer
        customFields:
          type: object
          additionalProperties: true
          description: |
            Custom fields of an Commitment object.
          title: CommitmentCustomFields
        specificPeriodAlignmentDate:
          type: string
          description: >-
            The specific date for the period alignment. This field is required
            only if the `periodAlignmentOption` is set to `SpecificDate`.
          format: date
          example: '2020-01-15'
        periodAlignmentOption:
          $ref: '#/components/schemas/PeriodAlignmentOptionEnum'
      required:
        - name
        - type
        - priority
    CommitmentInput:
      type: object
      title: CreateCommitmentRequest
      allOf:
        - $ref: '#/components/schemas/CommitmentBaseAttributesRequest'
        - $ref: '#/components/schemas/CommonRevenueAttributes'
        - $ref: '#/components/schemas/CommonTaxationAttributes'
        - properties:
            currency:
              type: string
              description: |
                Currency of the commitment.
            eligibleAccountConditions:
              $ref: '#/components/schemas/EligibleAccountCondition'
            eligibleChargeConditions:
              $ref: '#/components/schemas/EligibleChargeCondition'
      required:
        - eligibleAccountConditions
        - currency
    ActionTypeCreate:
      type: string
      enum:
        - create
      description: |
        Indicates whether to create a commitment.
    CommitmentScheduleAttributes:
      title: CommitmentScheduleAttributes
      type: object
      properties:
        amount:
          type: number
          description: The amount of each period in the schedule.
        amountBase:
          $ref: '#/components/schemas/AmountBaseEnum'
        periodType:
          $ref: '#/components/schemas/PeriodTypeEnum'
        specificPeriodLength:
          type: integer
          description: The specific period length of each period in the schedule.
        startDate:
          description: Ths start date of the schedule.
          type: string
          format: date
        endDate:
          description: |-
            The end date of the schedule.

            **Notes:** A commitment can contain a maximum of 100 periods.
          type: string
          format: date
      required:
        - startDate
        - endDate
        - amount
    CommitmentScheduleInput:
      title: CommitmentScheduleInput
      allOf:
        - $ref: '#/components/schemas/CommitmentScheduleAttributes'
    UpsertCreateCommitmentInput:
      title: UpsertCreateCommitmentInput
      description: create a new Commitment.
      properties:
        action:
          $ref: '#/components/schemas/ActionTypeCreate'
        schedules:
          description: The new schedules which are required when creating a new commitment.
          type: array
          items:
            type: object
            properties:
              action:
                type: string
                enum:
                  - create
            allOf:
              - $ref: '#/components/schemas/CommitmentScheduleInput'
      allOf:
        - $ref: '#/components/schemas/CommitmentInput'
      required:
        - action
        - schedules
    ActionType:
      type: string
      enum:
        - create
        - update
      description: |
        The action type of the commitment.
    ActionTypeSchedule:
      type: string
      enum:
        - create
        - update
      description: |
        The action type of the schedule.
    UpsertCreateCommitmentScheduleInput:
      description: Create a new schedule.
      type: object
      required:
        - action
      allOf:
        - $ref: '#/components/schemas/CommitmentScheduleInput'
        - properties:
            action:
              $ref: '#/components/schemas/ActionTypeSchedule'
    UpsertUpdateCommitmentScheduleInput:
      description: Update an existing commitment schedule.
      required:
        - action
        - id
      type: object
      properties:
        id:
          type: string
          description: The ID of the schedule.
        action:
          $ref: '#/components/schemas/ActionTypeSchedule'
        amount:
          type: number
          format: double
          description: >
            The amount of each period in the schedule.



            **Notes:**

            - If none of the periods in a schedule have drawdown, you can update
            the amount. 

            - If any period in a schedule has drawdown (but none are evaluated),
            you can update the amount. 

            - If any period in a schedule has been evaluated, you cannot update
            the amount.  
        status:
          type: string
          description: >-
            The status of the schedule.


            **Notes:** Schedules which are evaluated cannot be canceled. When
            the status of the commitment is updated as canceled, a commitment or
            schedule can be canceled only if none of its periods have been
            drawdowned.
          enum:
            - Canceled
    UpsertCommitmentScheduleInput:
      title: UpsertCommitmentSheduleInput
      description: >
        Upsert an schedule, when the action is create, create a new schedule,
        when the action is update, update the schedule.



        **Notes:** 

        - If none of the periods in a schedule has drawdown, you can not only
        update the schedule amount, but also delete the schedule. 

        - If any period in a schedule has drawdown, you can update the schedule
        amount, but you cannot delete the schedule.

        - If any period in a schedule has been evaluated, you cannot update the
        schedule amount. Also, you cannot delete the schedule.
      type: object
      discriminator:
        propertyName: action
        mapping:
          create: '#/components/schemas/UpsertCreateCommitmentScheduleInput'
          update: '#/components/schemas/UpsertUpdateCommitmentScheduleInput'
      oneOf:
        - $ref: '#/components/schemas/UpsertCreateCommitmentScheduleInput'
        - $ref: '#/components/schemas/UpsertUpdateCommitmentScheduleInput'
    UpsertUpdateCommitmentInput:
      type: object
      description: Update the existing commitment by the commitment number.
      required:
        - action
        - commitmentNumber
      properties:
        action:
          $ref: '#/components/schemas/ActionType'
        commitmentNumber:
          type: string
          description: The number of the Commitment.
        name:
          description: The value to update. Set to null to clear the existing value.
          type: string
        description:
          description: The value to update. Set to null to clear the existing value.
          type: string
        customFields:
          type: object
          additionalProperties: true
          description: Container for custom fields of an commitment object.
          title: CommitmentSegmentCustomFields
        status:
          type: string
          description: >-
            The status of the commitment.


            **Notes:** When the status of the commitment is updated as canceled,
            a commitment or schedule can be canceled only if none of its periods
            have been drawdowned.
          enum:
            - Canceled
        schedules:
          $ref: '#/components/schemas/UpsertCommitmentScheduleInput'
    UpsertCommitmentInput:
      title: UpsertCommitmentInput
      description: Using the action to indicate whether to create or update the commitment.
      type: object
      required:
        - action
      properties:
        action:
          $ref: '#/components/schemas/ActionType'
      oneOf:
        - $ref: '#/components/schemas/UpsertCreateCommitmentInput'
        - $ref: '#/components/schemas/UpsertUpdateCommitmentInput'
      discriminator:
        propertyName: action
        mapping:
          create: '#/components/schemas/UpsertCreateCommitmentInput'
          update: '#/components/schemas/UpsertUpdateCommitmentInput'
    ShipToContactPostOrder:
      allOf:
        - description: |
            Contact details associated with an account.
          properties:
            address1:
              description: >
                First line of the contact's address. This is often a street
                address or a business name.
              maxLength: 255
              type: string
            address2:
              description: |
                Second line of the contact's address.
              maxLength: 255
              type: string
            city:
              description: |
                City of the contact's address.
              maxLength: 100
              type: string
            contactDescription:
              description: |
                A description for the contact.          
              maxLength: 100
              type: string
            country:
              description: |
                Country; must be a valid country name or abbreviation.
              maxLength: 64
              type: string
            county:
              description: |
                County of the contact's address.
              maxLength: 100
              type: string
            fax:
              description: |
                Fax number of the contact.
              maxLength: 40
              type: string
            firstName:
              description: |
                First name of the contact.
              maxLength: 100
              type: string
            homePhone:
              description: |
                Home phone number of the contact.
              maxLength: 40
              type: string
            lastName:
              description: |
                Last name of the contact.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                Mobile phone number of the contact.
              maxLength: 40
              type: string
            nickname:
              description: |
                Nickname of the contact.
              maxLength: 100
              type: string
            otherPhone:
              description: >
                Additional phone number of the contact. Use the `otherPhoneType`
                field to specify the type of phone number.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                Specifies the type of phone number in the `otherPhone` field.
              enum:
                - Work
                - Mobile
                - Home
                - Other
              type: string
            personalEmail:
              description: |
                Personal email address of the contact.
              format: email
              maxLength: 80
              type: string
            postalCode:
              description: |
                ZIP code or other postal code of the contact's address.
              maxLength: 20
              type: string
            state:
              description: |
                State or province of the contact's address.
              maxLength: 100
              type: string
            taxRegion:
              description: >
                Region defined in your taxation rules. Only applicable if you
                use Zuora Tax.
              maxLength: 100
              type: string
              nullable: true
            workEmail:
              description: |
                Business email address of the contact.
              format: email
              maxLength: 80
              type: string
            workPhone:
              description: |
                Business phone number of the contact.
              maxLength: 40
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactObjectCustomFields'
    DataAccessControlField:
      additionalProperties:
        description: >
          Field for data access control. The name of the data access control
          field has the form <code>*customField*__h</code>. The data access
          control field is case sensitive. See [Data Access
          Control](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/Data_Access_Control)
          for more information.
        type: string
      description: |
        Container for the data access control field.
      title: dataAccessControlField
      type: object
    CreateOrderNewAccount:
      allOf:
        - description: >
            The information of the new account to be created with the order. To
            create the new account, either a **creditCard** structure or the
            **hpmCreditCardPaymentMethodId** field (but not both) should be
            provided. The one provided becomes the default payment method for
            this account. If the credit card information is declined or can't be
            verified, then the account is not created.
          properties:
            accountNumber:
              maxLength: 70
              type: string
            additionalEmailAddresses:
              description: >
                List of additional email addresses to receive emailed invoices.
                Values should be a comma-separated list of email addresses.
              maxLength: 1200
              type: string
            allowInvoiceEdit:
              description: |
                Indicates if associated invoices can be edited.
                Values are: 

                * `true`
                * `false` (default)
              type: boolean
            autoPay:
              description: >-
                Specifies whether future payments are to be automatically billed
                when they are due. Possible values are `true`, `false`.
              type: boolean
            batch:
              description: >
                **Note**: By default, you have 50 configurable account batches.
                To increase the limit to 200 batches, you must have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite"
                target="_blank">Performance Booster Elite</a> package.
              type: string
            billCycleDay:
              description: >-
                Day of the month that the account prefers billing periods to
                begin on. If set to 0, the bill cycle day will be set as
                "AutoSet".
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContactPostOrder'
            communicationProfileId:
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            creditMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the credit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08a6246fdf101626b1b3fe0144b.
              type: string
            crmId:
              maxLength: 100
              type: string
            currency:
              description: >
                3 uppercase character currency code.


                For payment method authorization, if the `paymentMethod` >
                `currencyCode` field is specified, `currencyCode` is used.
                Otherwise, this `currency` field is used for payment method
                authorization. If no currency is specified for the account, the
                default currency of the account is then used.
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            customerServiceRepName:
              description: >
                Name of the account's customer service representative, if
                applicable.
              maxLength: 50
              type: string
            debitMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the debit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08d62470a8501626b19d24f19e2.
              type: string
            hpmCreditCardPaymentMethodId:
              description: >
                The ID of the payment method associated with this account. The
                payment method specified for this field will be set as the
                default payment method of the account.


                If the `autoPay` field is set to `true`, you must provide the
                credit card payment method ID for either this field or the
                `creditCard` field,

                but not both.


                For the Credit Card Reference Transaction payment method, you
                can specify the payment method ID in this field or use the
                `paymentMethod` field to create a CC Reference Transaction
                payment method for an account.
              type: string
            invoiceDeliveryPrefsEmail:
              description: >
                Specifies whether to turn on the invoice delivery method 'Email'
                for the new account. 

                Values are: 


                * `true` (default). Turn on the invoice delivery method 'Email'
                for the new account.

                * `false`. Turn off the invoice delivery method 'Email' for the
                new account.
              type: boolean
            invoiceDeliveryPrefsPrint:
              description: >
                Specifies whether to turn on the invoice delivery method 'Print'
                for the new account.

                Values are: 


                * `true`. Turn on the invoice delivery method 'Print' for the
                new account.

                * `false` (default). Turn off the invoice delivery method
                'Print' for the new account.
              type: boolean
            invoiceTemplateId:
              type: string
            name:
              maxLength: 255
              type: string
            notes:
              maxLength: 65535
              type: string
            organizationLabel:
              description: >
                Name of the organization that the account belongs to.  


                This field is only required when you have already turned on
                Multi-Org feature.    
              type: string
            parentId:
              description: >-
                Identifier of the parent customer account for this Account
                object. Use this field if you have <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
                target="_blank">Customer Hierarchy</a> enabled.
              type: string
            partnerAccount:
              default: false
              description: >
                Whether the customer account is a partner, distributor, or
                reseller. 



                You can set this field to `true` if you have business with
                distributors or resellers, or operating in B2B model to manage
                numerous subscriptions through concurrent API requests. After
                this field is set to `true`, the calculation of account metrics
                is performed asynchronously during operations such as
                subscription creation, order changes, invoice generation, and
                payments.



                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"
                target="_blank">Reseller Account</a> feature enabled.
              type: boolean
            paymentGateway:
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              description: >
                **Note**: If you want to specify a payment term when creating a
                new account, you must set a value in this field. If you do not
                set a value in this field, Zuora will use the default value set
                in **Billing Settings** > **Payment Terms** from Zuora UI.
              type: string
            purchaseOrderNumber:
              description: >
                The number of the purchase order associated with this account.
                Purchase order information generally comes from customers.
              maxLength: 100
              type: string
            salesRep:
              description: >
                The name of the sales representative associated with this
                account, if applicable.
              maxLength: 50
              type: string
            sequenceSetId:
              description: >
                The ID of the sequence set to assign to the customer account. 


                The billing documents to generate for this account will adopt
                the prefix and starting document number configured in the
                sequence set.
              type: string
              nullable: true
            shipToContact:
              $ref: '#/components/schemas/ShipToContactPostOrder'
            shipToSameAsBillTo:
              description: >
                Whether the ship-to contact and bill-to contact are the same
                entity. 


                The created account has the same bill-to contact and ship-to
                contact entity only when all the following conditions are met in
                the request body:


                - This field is set to `true`. 


                - A bill-to contact is specified.


                - No ship-to contact is specified.
              type: boolean
            soldToContact:
              $ref: '#/components/schemas/SoldToContactPostOrder'
            soldToSameAsBillTo:
              description: >
                Whether the sold-to contact and bill-to contact are the same
                entity. 


                The created account has the same bill-to contact and sold-to
                contact entity only when all the following conditions are met in
                the request body:


                - This field is set to `true`. 

                - A bill-to contact is specified.

                - No sold-to contact is specified.
              type: boolean
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        - $ref: '#/components/schemas/DataAccessControlField'
    processingOptionsOrdersWithDelayedCapturePayment:
      description: >
        The container for billing processing options and payment processing
        options.


        **Note:**

        - This field is not supported in draft orders.

        - When you use the "Create an order" operation to create an account,
        create a subscription, run billing, and collect payment in a single
        call, if any error occurs during the call, such as a payment processing
        failure and a tax engine failure, then all the other steps will be
        rolled back. In this case, neither the invoice will be generated, nor
        the subscription nor the account will be created.

        - When you use the "Create an order" operation to cancel a subscription
        with `refund` and `writeOff`, if the `refund` or `writeOff` fails,
        `cancelSubscription`, `runBilling`, and `collectPayment` still can
        succeed.

        - When you use the "Create an order" operation, the `collectPayment` and
        `refund` fields cannot be set to `true` simultaneously.  Otherwise, the
        order will not be proceeded.
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to an invoice. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
          items:
            type: string
          type: array
        applyCredit:
          description: >
            Whether to automatically apply credit memos or unapplied payments,
            or both to an invoice.


            If the value is true, the credit memo or unapplied payment on the
            order account will be automatically applied to the invoices
            generated by this order. The credit memo generated by this order
            will not be automatically applied to any invoices.          



            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: boolean
        applyCreditBalance:
          description: >
            Indicates if any credit balance on a customer's account is
            automatically applied to invoices. If no value is specified then
            this field defaults to false. This feature is not available if you
            have enabled the Invoice Settlement feature.
          type: boolean
        billingOptions:
          properties:
            creditMemoReasonCode:
              description: >-
                A code identifying the reason for the credit memo transaction
                that is generated by the request. The value must be an existing
                reason code. If you do not pass the field or pass the field with
                empty value, Zuora uses the default reason code.
              type: string
            documentDate:
              description: |
                The invoice date displayed on the invoice.
              format: date
              type: string
            generateDraftInvoice:
              description: >
                Indicates if the current request needs to generate a draft
                invoice.


                Values are:


                * `true`

                * `false` (default)
              type: boolean
            targetDate:
              description: >
                Date through which to calculate charges if an invoice is
                generated. See [What is a Target
                Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).



                **Note**: If you do not specify this field, today's date is used
                by default.   
              format: date
              type: string
            chargeTypeToExclude:
              description: >
                The types of the charges to be excluded from the generation of
                billing documents.
              items:
                type: string
                enum:
                  - OneTime
                  - Recurring
                  - Usage
              type: array
          type: object
        collectPayment:
          description: >
            Indicates if the current request needs to collect payments. This
            value can not be 'true' when 'runBilling' flag is 'false'.
          type: boolean
        electronicPaymentOptions:
          description: |
            Container for the electronic payment options.
          properties:
            authTransactionId:
              description: >
                The authorization transaction ID from the payment gateway.


                When you create a payment to capture the funds that have been
                authorized through [Create
                authorization](https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/),
                pass in the `authTransactionId` field. It is highly recommended
                to also pass in `gatewayOrderId` that you used when authorizing
                the funds. `authTransactionId` is required, while
                `gatewayOrderId` is optional.
              maxLength: 50
              type: string
            gatewayOrderId:
              description: >
                A merchant-specified natural key value that can be passed to the
                electronic payment gateway when a payment is created. If not
                specified, the payment number will be passed in instead.


                Gateways check duplicates on the gateway order ID to ensure that
                the same transaction is not entered twice accidentally. 


                This ID can also be used to do reconciliation and tie the
                payment to a natural key in external systems. The source of this
                ID varies by merchant. Some merchants use shopping cart order
                IDs, and others use something different. Merchants use this ID
                to track transactions in their eCommerce systems.


                When you create a payment to capture the funds that have been
                authorized through [Create
                authorization](https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/),
                pass in the `authTransactionId` field. It is highly recommended
                to also pass in `gatewayOrderId` that you used when authorizing
                the funds. `authTransactionId` is required, while
                `gatewayOrderId` is optional.
              maxLength: 50
              type: string
            paymentGatewayId:
              description: >
                Specifies the ID of a payment gateway to override the default
                gateway.


                If <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
                target="_blank">Payment Gateway Routing</a> is enabled: 
                  - If this field is not specified, gateway routing rules will be invoked.
                  - If this field is specified, the specified gateway will be used to process the payment.

                If Payment Gateway Routing is disabled:
                  - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.
                  - If this field is specified, the specified gateway will be used to process the payment.
              type: string
            paymentMethodId:
              description: >
                Specifies an electronic payment method. It can be one that has
                already been associated with an invoice owner, or an orphan
                payment method, which is not associated with any invoice owner.
                For an orphan payment method, this operation will then associate
                it with the account that this order will be created under.
              type: string
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values.

                The fields supported by gateways vary. For more information, see
                the

                overview topic of each gateway integration in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways"
                target="_blank">Zuora Knowledge Center</a>.


                Zuora sends all the information that you specified to the
                gateway. If you

                specify any unsupported gateway option parameters, they will be
                ignored

                without error prompts.
              type: object
              title: gatewayOptions
              additionalProperties:
                type: string
                description: |
                  The gateway options specification consists of key-value pairs:
                    - Field name: The name of a gateway-specific parameter.
                    - Field value: The value of the gateway-specific parameter.
            mitTransactionSource:
              description: >
                Payment transaction source used by the Chase payment gateway to
                differentiate the transaction source in Stored Credential
                Transaction framework.
                  - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
                  - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.
                  - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
              enum:
                - C_Unscheduled
                - M_Recurring
                - M_Unscheduled
              type: string
          type: object
        refund:
          description: >
            Indicates whether to refund after subscription cancelation. Default
            is `false`. 


            **Note**: When refunding a subscription that is not invoiced
            separately, if you do not enable the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement"
            target="_blank">Invoice Item Settlement</a> feature, you will
            encounter the following error during the cancel and refund process:
            “Cancellation/Refund failed because of the following reason: Invoice
            is linked to multiple subscriptions. Cancellation was not
            processed.”
          type: boolean
        refundAmount:
          description: >
            Indicates the amount to be refunded. Required if the `refund` field
            is `true`.
          type: number
        refundReasonCode:
          description: >
            A code identifying the reason for the refund transaction. The value
            must be an existing payment refund reason code listed in **Payments
            Settings** > **Configure Reason Codes**. If you do not specify the
            field or leave the field with an empty value, Zuora uses the default
            payment refund reason code.
          type: string
        runBilling:
          description: >
            Indicates if the current request needs to generate an invoice. The
            invoice will be generated against all subscriptions included in this
            order. 
          type: boolean
        writeOff:
          description: >
            Indicates whether to write off the outstanding balance on the
            invoice after refund. Default is `false`.


            **Note**: 

            - When refunding a subscription that is not invoiced separately, if
            you do not enable the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement"
            target="_blank">Invoice Item Settlement</a> feature, you will
            encounter the following error during the cancel and refund process:
            “Cancellation/Refund failed because of the following reason: Invoice
            is linked to multiple subscriptions. Cancellation was not
            processed.”

            - The <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement"
            target="_blank">Invoice Settlement</a> feature must have been
            enabled for write-off.

            - When this field is set to `true`, the generated credit memos have
            a reason code of `Write-off` and it cannot be overridden.
          type: boolean
        writeOffBehavior:
          description: >
            The financial information of the credit memo items generated to
            write off the invoice balance. 


            **Note:** 
              - All the credit memo items that are used to write off the invoice will be applied with the same financial information.
              - Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here.
          properties:
            financeInformation:
              description: >
                Container for the finance information related to the credit memo
                items that are created for invoice write-off.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
          type: object
      type: object
    CreateOrderChargeOverride:
      description: |
        Charge associated with a rate plan.
      properties:
        accountReceivableAccountingCode:
          description: >
            The accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The adjustmentLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The adjustmentRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        billing:
          description: |
            Billing information about the charge.
          properties:
            billCycleDay:
              description: >
                Day of the month that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofMonth`.
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              description: >
                Specifies how Zuora determines the day that each billing period
                begins on.

                  * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
                  * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
                  * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
                  * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
                  * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              description: >
                Billing frequency of the charge. The value of this field
                controls the duration of each billing period.


                If the value of this field is `Specific_Days`, `Specific_Months`
                or `Specific_Weeks`, use the `specificBillingPeriod` field to
                specify the duration of each billing period.
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
                - Specific_Days
              type: string
            billingPeriodAlignment:
              description: >
                Specifies how Zuora determines when to start new billing
                periods. You can use this field to align the billing periods of
                different charges.


                * `AlignToCharge` - Zuora starts a new billing period on the
                first billing day that falls on or after the date when the
                charge becomes active.

                * `AlignToSubscriptionStart` - Zuora starts a new billing period
                on the first billing day that falls on or after the start date
                of the subscription.

                * `AlignToTermStart` - For each term of the subscription, Zuora
                starts a new billing period on the first billing day that falls
                on or after the start date of the term.


                See the `billCycleType` field for information about how Zuora
                determines the billing day.


                **Note**: This field is not supported in one time charges. 
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              description: >
                Specifies whether to invoice for a billing period on the first
                day of the billing period (billing in advance) or the first day
                of the next billing period (billing in arrears).
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              description: >
                Duration of each billing period in months or weeks, depending on
                the value of the `billingPeriod` field. Only applicable if the
                value of the `billingPeriod` field is `Specific_Months` or
                `Specific_Weeks`.
              type: integer
            weeklyBillCycleDay:
              description: >
                Day of the week that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofWeek`.
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeFunction:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines what type of charge it is:

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge. 

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - CommitmentTrueUp
            - CreditCommitment
          type: string
        commitmentType:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the type of the commitment for both the
            commitment true-up charge and credit commitment charge, and so you
            must define the type as `CURRENCY`.
          enum:
            - CURRENCY
          type: string
        creditOption:
          description: >
            **Note**: This field is only available if you have both the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> features enabled.


            With this field, you can use a standalone order to subscribe to a
            minimum commitment subscription.


            This field defines the way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
          type: string
        chargeModel:
          description: >
            The chargeModel of a standalone charge.



            Supported charge models:


            * `FlatFee`


            * `PerUnit`


            * `Volume`


            * `Tiered`


            * `DiscountFixedAmount`


            * `DiscountPercentage`


            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        chargeNumber:
          description: >
            Charge number of the charge. For example, C-00000307.


            * If you do not set this field, Zuora will generate a charge number
            starting with a default prefix, for example, C-. This default prefix
            is predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**.

            * If you want to use a custom charge number, do not use the default
            prefix predefined in **Billing Settings** > **Define Default
            Subscription and Order Settings**. Use your own prefix, for example,
            SC-.
          maxLength: 50
          type: string
        chargeType:
          description: >
            The chargeType of a standalone charge.



            Supported charge types:


            * `OneTime`


            * `Recurring`


            * `Usage`


            **Note:** This field is available when the <a

            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"

            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        contractAssetAccountingCode:
          description: >
            The contractAssetAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractLiabilityAccountingCode:
          description: >
            The contractLiabilityAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The contractRecognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        deferredRevenueAccountingCode:
          description: >
            The deferredRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        description:
          description: |
            Description of the charge.
          maxLength: 500
          type: string
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
        endDate:
          $ref: '#/components/schemas/EndConditions'
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            If you specify `SpecificDate` in the `startDate` > `triggerEvent`
            field and want to create a completed order and an active
            subscription, you must specify either the `estimatedStartDate` or
            `startDate` > `specificTriggerDate` field:


            - `estimatedStartDate`: The charge will be in pending status.


            - `specificTriggerDate`: The charge will be in active status.


            The value of this field must be a date within the subscription term.
            The system will then automatically calculate the estimated end date
            for the pending charge. The estimated start and end dates are used
            to manage the estimated charge duration and forecast the revenue for
            the pending charge.


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charge related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBillingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge. In addition, if the
            `excludeItemBookingFromRevenueAccounting` field in a Create
            Subscription or Add Product order action is set to `false`, you must
            also set the `excludeItemBillingFromRevenueAccounting` field in this
            order action to `false`.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charges from revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBookingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isRollover:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The value is either "True" or "False". It determines whether the
            rollover fields are needed.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        name:
          description: >
            The name of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        negotiatedPriceTable:
          description: >
            Array of negotiated price table information. The rate card entries
            provided in the array will override the existing rate card entries
            in the standard price table to form a negotiated price table that
            will be used during pricing evaluation.



            **Note:** To enable the Negotiated Price Table feature, submit a
            request to <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.                     
          items:
            $ref: '#/components/schemas/NegotiatedItems'
          type: array
        pobPolicy:
          description: >
            The pobPolicy of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
        pricing:
          description: |
            Pricing information about the charge.
          properties:
            chargeModelData:
              $ref: '#/components/schemas/ChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/DiscountPricingOverride'
            oneTimeFlatFee:
              $ref: '#/components/schemas/OneTimeFlatFeePricingOverride'
            oneTimePerUnit:
              $ref: '#/components/schemas/OneTimePerUnitPricingOverride'
            oneTimeTiered:
              $ref: '#/components/schemas/OneTimeTieredPricingOverride'
            oneTimeVolume:
              $ref: '#/components/schemas/OneTimeVolumePricingOverride'
            recurringDeliveryBased:
              $ref: '#/components/schemas/RecurringDeliveryPricingOverride'
            recurringFlatFee:
              $ref: '#/components/schemas/RecurringFlatFeePricingOverride'
            recurringPerUnit:
              $ref: '#/components/schemas/RecurringPerUnitPricingOverride'
            recurringTiered:
              $ref: '#/components/schemas/RecurringTieredPricingOverride'
            recurringVolume:
              $ref: '#/components/schemas/RecurringVolumePricingOverride'
            usageFlatFee:
              $ref: '#/components/schemas/UsageFlatFeePricingOverride'
            usageOverage:
              $ref: '#/components/schemas/UsageOveragePricingOverride'
            usagePerUnit:
              $ref: '#/components/schemas/UsagePerUnitPricingOverride'
            usageTiered:
              $ref: '#/components/schemas/UsageTieredPricingOverride'
            usageTieredWithOverage:
              $ref: '#/components/schemas/UsageTieredWithOveragePricingOverride'
            usageVolume:
              $ref: '#/components/schemas/UsageVolumePricingOverride'
          type: object
        pricingAttributes:
          description: >
            Container for pricing attribute and value that provide additional
            context for dynamic pricing. The pricing attribute values are used
            to get the charge’s list price from the product catalog. For the
            pricing attribute mapped to a Zuora object field, Zuora will
            retrieve the value automatically, you don’t need to pass its value
            explicitly. If you pass a value that doesn’t match the actual value
            of the Zuora object, an error will be returned. 

            Note that for any pricing attribute mapped to the field of Zuora
            object Usage, because its value is only determined when the usage
            record arrives, you can’t provide a value via Orders API payload and
            Zuora will not retrieve its value automatically.    



            **Note:** To enable Dynamic Pricing, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          type: object
          additionalProperties: true
        productCategory:
          description: >
            The productCategory of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productClass:
          description: >
            The productClass of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productFamily:
          description: >
            The productFamily of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productLine:
          description: >
            The productLine of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        productRatePlanChargeId:
          description: >
            Internal identifier of the product rate plan charge that the charge
            is based on. You can specify either `productRatePlanChargeId` or
            `productRatePlanChargeNumber`. When `isAddingSubsetCharges` is set
            to true, the product rate charge specified by
            `productRatePlanChargeId` is added to the existing rate plan
            specified by `ratePlanId`.
          type: string
        productRatePlanChargeNumber:
          description: >
            Number of a product rate-plan charge for this subscription. You can
            specify either `productRatePlanChargeId` or
            `productRatePlanChargeNumber`.
          type: string
        prorationOption:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage/Usage_charge_proration"
            target="_blank">Usage charge proration</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            You can use this field to specify the charge-level proration option
            for a usage charge or recurring charge when you creating or adding a
            subscription rate plan charge through an order. The tenant-level
            proration option will be overridden.
              * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.
              * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.
              * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.
              * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.
              * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field.
          enum:
            - NoProration
            - TimeBasedProration
            - DefaultFromTenantSetting
            - ChargeFullPeriod
            - CustomizeProrationOptionOverrides
          type: string
        ratingPropertiesOverride:
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
            target="_blank">Charge level proration option for a recurring
            charge</a>.


            This field is used only when the value of the `prorationOption`
            field is set to `CustomizeProrationOptionOverrides`. 


            Use this field to specify more customized proration options for a
            recurring charge when you creating or adding a subscription rate
            plan charge through an order. The tenant-level proration option will
            be overridden.
          type: object
          properties:
            isProratePartialMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify whether to prorate the recurring
                charge for a partial month. The tenant-level proration option
                will be overridden.
              type: boolean
            prorationUnit:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the unit of proration for a recurring
                charge. The tenant-level proration option will be overridden.
              enum:
                - ProrateByDay
                - ProrateByMonthFirst
              type: string
            daysInMonth:
              description: >
                **Note**: This field is only available if you have the Charge
                Level Proration feature enabled. For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Set_up_product_catalog/Create_product_rate_plan_charges#Charge_level_proration_option_for_a_recurring_charge"
                target="_blank">Charge level proration option for a recurring
                charge</a>.


                Use this field to specify the number of days counted for a month
                when prorating a recurring charge. The tenant-level proration
                option will be overridden. See more details for each of the
                following enum values in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Common_subscription_information/F_Proration#When_prorating_a_month.2C_assume_30_days_in_a_month_or_use_actual_days.3F"
                target="_blank">Proration</a>.
              enum:
                - UseActualDays
                - Assume30Days
                - Assume30DaysStrict
              type: string
        recognizedRevenueAccountingCode:
          description: >
            The recognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        revRecCode:
          description: |
            Revenue Recognition Code
          maxLength: 70
          type: string
        revRecTriggerCondition:
          description: |
            Specifies the revenue recognition trigger condition.

              * `Contract Effective Date` 
              * `Service Activation Date`
              * `Customer Acceptance Date`
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          description: >
            Specifies the revenue recognition rule, such as `Recognize upon
            invoicing` or `Recognize daily over time`.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have both the Order to
            Revenue feature and the Standalone Orders feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. In this
            case, you must set the `rolloverPeriods` field to 1. For example,
            you can define the rollover fund's period length as 5 months,
            shorter than the prepayment charge's validity period: a year.
          type: integer
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: number
        startDate:
          $ref: '#/components/schemas/CreateOrderTriggerParams'
        taxCode:
          description: >
            The tax code of a charge. This field is available when the `taxable`
            field is set to `true`.
          type: string
        taxMode:
          description: >
            The tax mode of a charge.  This field is available when the
            `taxable` field is set to `true`.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxable:
          type: boolean
          description: >
            The flag indicates whether the charge is taxable. If this field is
            set to `true`, you must specify the `taxCode` and `taxMode` fields.
        unBilledReceivablesAccountingCode:
          description: >
            The unBilledReceivablesAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature and the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> or <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature are enabled.
          type: string
        uniqueToken:
          description: >
            Unique identifier for the charge. This identifier enables you to
            refer to the charge before the charge has an internal identifier in
            Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the charge.
            Then when you update the product, you can use the same unique
            identifier to specify which charge to modify.
          maxLength: 50
          type: string
        upsellOriginChargeNumber:
          description: >
            The identifier of the original upselling charge associated with the
            current charge.


            For a termed subscription, you can now use the "Create an order" API
            operation to perform an Add Product order action to make a product
            quantity upsell for per unit recurring charges. The benefit is that
            the charge added by this approach will be automatically combined
            with the original existing charge for which you want to upsell when
            the subscription is renewed. The approach is as follows:

            * Use an Add Product order action to add a charge that is of the
            same charge type, charge model, and charge end date as the existing
            per unit recurring charge for which you want to make a quantity
            upsell.


            * In the preceding charge to add, use the `upsellOriginChargeNumber`
            field to specify the existing rate plan charge for which you want to
            make the quantity upsell.


            Note that a termed subscription with such upsell charges can not be
            changed to an evergreen subscription.   


            **Note**: The Quantity Upsell feature is in the **Early Adopter**
            phase. We are actively soliciting feedback from a small set of early
            adopters before releasing it as generally available. If you want to
            join this early adopter program, submit a request at [Zuora Global
              Support](https://support.zuora.com).  
          type: string
        validityPeriodType:
          description: >
            **Note**: This field is only available if you have enabled either of
            the following:

            * <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            * <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a>

            * Both <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment"
            target="_blank">Minimum Commitment</a> and <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>


            You can use this field in the following scenarios: 

            * When you create a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge),
            use this field to define the period in which the prepayment units
            are valid to use.


            * When you override the setting of <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Minimum_Commitment#Commitment_true-up_charge_specific_settings"
            target="_blank">commitment true-up charge</a> from the product
            catalog, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.


            * When you use a standalone order to create a commitment true-up
            charge, set this field consistently with the value of the `billing`
            > `billingPeriod` field in this charge.
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    CreateOrderRatePlanOverride:
      description: >
        Information about an order action of type `AddProduct`. 


        If you want to create a pending order through the "Add product" order
        action, and if the charge's trigger condition is `Specific Date`, you
        must set a charge number in the `chargeNumber` field for the "Add
        product" order action. In this case, if you do not set it, Zuora will
        not generate the charge number for you.


        See more information about pending orders in <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/Pending_orders_and_subscriptions"
        target="_blank">Pending orders and subscriptions</a>. 
      properties:
        chargeOverrides:
          description: |
            List of charges associated with the rate plan.
          items:
            $ref: '#/components/schemas/CreateOrderChargeOverride'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          description: >
            An external ID of the product rate plan to be added. You can use
            this field to specify a product rate plan that is imported from an
            external system. The value of the `externalCatalogPlanId` field must
            match one of the values that are predefined in the
            `externallyManagedPlanIds` field on a product rate plan.


            **Note:** If both `externalCatalogPlanId` and `productRatePlanId`
            are provided. They must point to the same product rate plan.
            Otherwise, the request would fail.
          type: string
        externallyManagedPlanId:
          description: >
            Indicates the unique identifier for the rate plan purchased on a
            third-party store. This field is used to represent a subscription
            rate plan created through third-party stores.
          type: string
        isAddingSubsetCharges:
          description: >
            Specifies whether to add a subset of charges to the subscription.



            **Note:** To access this field for adding a subset of charges,
            submit a request at <a href="http://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isFromExternalCatalog:
          description: >
            Indicates whether the rate plan is created from the Zuora product
            catalog or from an external product catalog.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: boolean
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanName:
          description: >
            Name of the standalone rate plan.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          description: |
            Number of a subscription rate plan for this subscription.
          maxLength: 50
          type: string
        uniqueToken:
          description: >
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the rate
            plan. Then when you update the product, you can use the same unique
            identifier to specify which rate plan to modify.
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    CreateOrderChangePlanRatePlanOverride:
      description: |
        Information about the new product rate plan to add. 
      properties:
        chargeOverrides:
          description: |
            List of charges associated with the rate plan.
          items:
            $ref: '#/components/schemas/ChangePlanChargeOverride'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          description: >
            An external ID of the product rate plan to be added. You can use
            this field to specify a product rate plan that is imported from an
            external system. The value of the `externalCatalogPlanId` field must
            match one of the values that are predefined in the
            `externallyManagedPlanIds` field on a product rate plan.


            **Note:** If both `externalCatalogPlanId` and `productRatePlanId`
            are provided. They must point to the same product rate plan.
            Otherwise, the request would fail.
          type: string
        externallyManagedPlanId:
          description: >
            Indicates the unique identifier for the rate plan purchased on a
            third-party store. This field is used to represent a subscription
            rate plan created through third-party stores.
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a subscription rate plan for this subscription.
          maxLength: 50
          type: string
        isFromExternalCatalog:
          description: >
            Indicates whether the rate plan is created from the Zuora product
            catalog or from an external product catalog.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: boolean
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanName:
          description: >
            Name of the standalone rate plan.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> feature is enabled.
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        uniqueToken:
          description: >
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the rate
            plan. Then when you update the product, you can use the same unique
            identifier to specify which rate plan to modify.
          maxLength: 50
          type: string
      title: ratePlan
      type: object
    CreateChangePlan:
      description: >
        Information about an order action of type `ChangePlan`. 


        Use the change plan type of order action to replace the existing rate
        plans in a subscription with other rate plans.


        **Note**: The change plan type of order action is supported for the  <a
        href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
        target="_blank">Order to Revenue</a> feature. However, it is currently
        not supported for the <a
        href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
        target="_blank">Billing - Revenue Integration</a> feature. When Billing
        - Revenue Integration is enabled, the change plan type of order action
        will no longer be applicable in Zuora Billing.


        If you want to create a pending order through the "change plan" order
        action, and if the charge's trigger condition is `Specific Date`, you
        must set a charge number in the `chargeNumber` field for the "change
        plan" order action. In this case, if you do not set it, Zuora will not
        generate the charge number for you.


        See more information about pending orders in <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/Pending_orders_and_subscriptions"
        target="_blank">Pending orders and subscriptions</a>.
      properties:
        effectivePolicy:
          description: |
            The default value for the `effectivePolicy` field is as follows:
              * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
              * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
              * Otherwise, the effective policy is `SpecificDate` by default.

            **Notes**: 
              * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates" target="_blank">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period, and you cannot set the following billing trigger date settings to `Yes`:
                * <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Customer_Acceptance_of_Orders.3F" target="_blank">Require Customer Acceptance of Orders?</a>
                * <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Default_Subscription_and_Order_Settings#Require_Service_Activation_of_Orders.3F" target="_blank">Require Service Activation of Orders?</a>
              
              * When setting this field to `SpecificDate`, you must also set the contract effective date in the `triggerDates` field as follows:
                * Set the `name` field as `ContractEffective`
                * Specify a date for the `triggerDate` field
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        externalCatalogPlanId:
          description: >
            An external ID of the rate plan to be removed. You can use this
            field to specify an existing rate plan in your subscription. The
            value of the `externalCatalogPlanId` field must match one of the
            values that are predefined in the `externallyManagedPlanIds` field
            on a product rate plan. However, if there are multiple rate plans
            with the same `productRatePlanId` value existing in the
            subscription, you must use the `ratePlanId` field to remove the rate
            plan. The `externalCatalogPlanId` field cannot be used to
            distinguish multiple rate plans in this case.


            **Note:** Please provide only one of `externalCatalogPlanId`,
            `ratePlanId` or `productRatePlanId`. If more than 1 field is
            provided then the request would fail.
          type: string
        newProductRatePlan:
          $ref: '#/components/schemas/CreateOrderChangePlanRatePlanOverride'
        productRatePlanId:
          description: |
            ID of the product rate plan that the removed rate plan is based on.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            ID of the rate plan to remove. This can be the latest version or any
            history version of ID. Note that the removal of a rate plan through
            the Change Plan order action supports the function of <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/Order_actions_tutorials/E2_Remove_rate_plan_on_subscription_before_future-dated_removals"
            target="_blank">removal before future-dated removals</a>, as in a
            Remove Product order action.
          type: string
        resetBcd:
          default: false
          description: >
            If resetBcd is true then reset the Account BCD to the effective
            date; if it is false keep the original BCD. 


            **Note**: If the rate plan change is an upgrade (the `subType` field
            is `Upgrade`), then the effective policy is `EffectiveImmediately`
            by default. In this case, if you do not specify the `resetBcd`
            field, the system sets this field to `true` while BCD is the
            effective date. 
          type: boolean
        subType:
          description: >
            Use this field to choose the sub type for your change plan order
            action.


            However, if you do not set this field, the field will be
            automatically generated by the system according to the following
            rules:


            When the old and new rate plans are within the same Grading catalog
            group:

            * If the grade of new plan is greater than that of the old plan,
            this is an "Upgrade".

            * If the grade of new plan is less than that of the old plan, this
            is a "Downgrade".

            * If the grade of new plan equals that of the old plan, this is a
            "Crossgrade".


            When the old and new rate plans are not in the same Grading catalog
            group, or either has no group, this is "PlanChanged".
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
      required:
        - newProductRatePlan
      title: createChangePlan
      type: object
    CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount:
      allOf:
        - description: >
            Information about a new account that will own the subscription. Only
            available if you have enabled the Owner Transfer feature.


            **Note:** The Owner Transfer feature is in **Limited Availability**.
            If you wish to have access to the feature, submit a request at
            [Zuora Global Support](http://support.zuora.com/).


            If you do not set this field or the `subscriptionOwnerAccountNumber`
            field, the account that owns the order will also own the
            subscription. Zuora will return an error if you set this field and
            the `subscriptionOwnerAccountNumber` field.
          properties:
            accountNumber:
              description: |
                Account number. For example, A00000001.
              maxLength: 70
              type: string
            additionalEmailAddresses:
              description: >
                List of additional email addresses to receive emailed invoices.
                Values should be a comma-separated list of email addresses.
              maxLength: 1200
              type: string
            allowInvoiceEdit:
              description: |
                Indicates if associated invoices can be edited.
                Values are: 

                * `true`
                * `false` (default)
              type: boolean
            autoPay:
              description: >
                Specifies whether future payments are automatically billed when
                they are due.
              type: boolean
            batch:
              description: >
                Name of the billing batch that the account belongs to. For
                example, Batch1.
              type: string
            billCycleDay:
              description: >
                Day of the month that the account prefers billing periods to
                begin on. If set to 0, the bill cycle day will be set as
                "AutoSet".
              maximum: 31
              minimum: 0
              type: integer
            billToContact:
              $ref: '#/components/schemas/BillToContactPostOrder'
            communicationProfileId:
              description: >
                Internal identifier of the communication profile that Zuora uses
                when sending notifications to the account's contacts.
              type: string
            creditCard:
              $ref: '#/components/schemas/creditCard'
            creditMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the credit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08a6246fdf101626b1b3fe0144b.
              type: string
            crmId:
              description: |
                External identifier of the account in a CRM system.
              maxLength: 100
              type: string
            currency:
              description: |
                ISO 3-letter currency code (uppercase). For example, USD.
              type: string
            customFields:
              $ref: '#/components/schemas/AccountObjectCustomFields'
            customerServiceRepName:
              description: >
                Name of the account's customer service representative, if
                applicable.
              maxLength: 50
              type: string
            debitMemoTemplateId:
              description: >
                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.


                The unique ID of the debit memo template, configured in
                **Billing Settings** > **Manage Billing Document Configuration**
                through the Zuora UI. For example,
                2c92c08d62470a8501626b19d24f19e2.
              type: string
            hpmCreditCardPaymentMethodId:
              description: >
                The ID of the payment method associated with this account. The
                payment method specified for this field will be set as the
                default payment method of the account.


                If the `autoPay` field is set to `true`, you must provide the
                credit card payment method ID for either this field or the
                `creditCard` field,

                but not both.


                For the Credit Card Reference Transaction payment method, you
                can specify the payment method ID in this field or use the
                `paymentMethod` field to create a CC Reference Transaction
                payment method for an account.
              type: string
            invoiceDeliveryPrefsEmail:
              description: >
                Specifies whether to turn on the invoice delivery method 'Email'
                for the new account. 

                Values are: 


                * `true` (default). Turn on the invoice delivery method 'Email'
                for the new account.

                * `false`. Turn off the invoice delivery method 'Email' for the
                new account.         
              type: boolean
            invoiceDeliveryPrefsPrint:
              description: >
                Specifies whether to turn on the invoice delivery method 'Print'
                for the new account.

                Values are: 


                * `true`. Turn on the invoice delivery method 'Print' for the
                new account.

                * `false` (default). Turn off the invoice delivery method
                'Print' for the new account.
              type: boolean
            invoiceTemplateId:
              description: >
                Internal identifier of the invoice template that Zuora uses when
                generating invoices for the account.
              type: string
            name:
              description: |
                Account name.
              maxLength: 255
              type: string
            notes:
              description: >
                Notes about the account. These notes are only visible to Zuora
                users.
              maxLength: 65535
              type: string
            parentId:
              description: >-
                Identifier of the parent customer account for this Account
                object. Use this field if you have <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
                target="_blank">Customer Hierarchy</a> enabled.
              type: string
            paymentGateway:
              description: >
                The payment gateway that Zuora uses when processing electronic
                payments and refunds for the account. If you do not specify this
                field or if the value of this field is null, Zuora uses your
                default payment gateway.
              maxLength: 40
              type: string
            paymentMethod:
              $ref: '#/components/schemas/POSTPaymentMethodRequest'
            paymentTerm:
              description: >
                Name of the payment term associated with the account. For
                example, "Net 30". The payment term determines the due dates of
                invoices.
              type: string
            purchaseOrderNumber:
              description: >
                The number of the purchase order associated with this account.
                Purchase order information generally comes from customers.
              maxLength: 100
              type: string
            salesRep:
              description: >
                The name of the sales representative associated with this
                account, if applicable.
              maxLength: 50
              type: string
            soldToContact:
              $ref: '#/components/schemas/SoldToContactPostOrder'
            taxInfo:
              $ref: '#/components/schemas/TaxInfo'
          required:
            - name
            - currency
            - billCycleDay
            - billToContact
          type: object
        - $ref: '#/components/schemas/DataAccessControlField'
    CreateOrderCreateSubscription:
      description: |
        Information about an order action of type `CreateSubscription`.
      properties:
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        currency:
          description: >
            The code of currency that is used for this subscription. If the
            currency is not selected, the default currency from the account will
            be used.


            All subscriptions in the same order must use the same currency. The
            currency for a subscription cannot be changed.


            **Note**: 
              This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies" target="_blank">Multiple Currencies</a> feature enabled.
          maxLength: 3
          type: string
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the subscription.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          maxLength: 255
          nullable: true
        invoiceSeparately:
          description: >
            Specifies whether the subscription appears on a separate invoice
            when Zuora generates invoices.
          type: boolean
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        newSubscriptionOwnerAccount:
          $ref: >-
            #/components/schemas/CreateOrderCreateSubscriptionNewSubscriptionOwnerAccount
        notes:
          description: >
            Notes about the subscription. These notes are only visible to Zuora
            users.
          maxLength: 500
          type: string
        paymentProfile:
          description: >
            Container for payment gateway and payment method details of a
            payment. If you do not set this field, the payment method and
            payment gateway values cannot be set in the subscription.


            **Note:**
              - If multiple order actions are specified, they will be applied in the same order they appear in the API payload.
              - If one or more of these order actions include the `paymentProfile` element, the changes will be applied in sequence, and the result will be consistent with the last `paymentProfile` element.
          properties:
            paymentGatewayId:
              description: |
                The ID of the gateway instance that processes the payment.

                This field remains unset, if you do not provide value.
              type: string
            paymentMethodId:
              description: |
                The ID of the payment method.

                This field remains unset, if you do not provide value.
              type: string
          type: object
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For
            example, `Net 30`. The payment term determines the due dates of
            invoices.


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          description: >
            The ID of the ship-to contact associated with the subscription. It
            must be a contact of the subscription owner.


            **Note:**
               To access this field, you must have the <b>ShipToContactSupport</b> permission. If you want to enable this permission, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        subscribeToRatePlans:
          description: |
            List of rate plans associated with the subscription.
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanOverride'
          type: array
        subscriptionNumber:
          description: >
            Subscription number of the subscription. For example, A-S00000001.


            If you do not set this field, Zuora will generate the subscription
            number.
          maxLength: 100
          type: string
        subscriptionOwnerAccountNumber:
          description: >
            Account number of an existing account that will own the
            subscription. For example, A00000001.


            If you do not set this field or the `newSubscriptionOwnerAccount`
            field, the account that owns the order will also own the
            subscription. Zuora will return an error if you set this field and
            the `newSubscriptionOwnerAccount` field.
          maxLength: 70
          type: string
        invoiceOwnerAccountNumber:
          description: >
            Account number of an existing account that will own the invoice. For
            example, A00000001. If you do not set this field, the account that
            owns the order will also own this invoice.
          maxLength: 70
          type: string
        terms:
          description: |
            Container for the terms and renewal settings of the subscription.
          properties:
            autoRenew:
              description: >
                Specifies whether the subscription automatically renews at the
                end of the each term. Only applicable if the type of the first
                term is `TERMED`.
              type: boolean
            initialTerm:
              description: |
                Information about the first term of the subscription.
              properties:
                period:
                  description: >
                    Duration of the first term in months, years, days, or weeks,
                    depending on the value of the `periodType` field. Only
                    applicable if the value of the `termType` field is `TERMED`.
                  type: integer
                periodType:
                  description: >
                    Unit of time that the first term is measured in. Only
                    applicable if the value of the `termType` field is `TERMED`.
                  enum:
                    - Month
                    - Year
                    - Day
                    - Week
                  type: string
                startDate:
                  description: |
                    Start date of the first term, in YYYY-MM-DD format.
                  format: date
                  type: string
                endDate:
                  description: |
                    End date of the first term, in YYYY-MM-DD format.
                  format: date
                  type: string
                termType:
                  description: >
                    Type of the first term. If the value of this field is
                    `TERMED`, the first term has a predefined duration based on
                    the value of the `period` field. If the value of this field
                    is `EVERGREEN`, the first term does not have a predefined
                    duration.
                  enum:
                    - TERMED
                    - EVERGREEN
                  type: string
              required:
                - termType
              type: object
            renewalSetting:
              description: >
                Specifies the type of the terms that follow the first term if
                the subscription is renewed. Only applicable if the type of the
                first term is `TERMED`.


                * `RENEW_WITH_SPECIFIC_TERM` - Each renewal term has a
                predefined duration. The first entry in `renewalTerms` specifies
                the duration of the second term of the subscription, the second
                entry in `renewalTerms` specifies the duration of the third term
                of the subscription, and so on. The last entry in `renewalTerms`
                specifies the ultimate duration of each renewal term.

                * `RENEW_TO_EVERGREEN` - The second term of the subscription
                does not have a predefined duration.
              enum:
                - RENEW_WITH_SPECIFIC_TERM
                - RENEW_TO_EVERGREEN
              type: string
            renewalTerms:
              description: >
                List of renewal terms of the subscription. Only applicable if
                the type of the first term is `TERMED` and the value of the
                `renewalSetting` field is `RENEW_WITH_SPECIFIC_TERM`.
              items:
                $ref: '#/components/schemas/RenewalTerm'
              type: array
          required:
            - initialTerm
          type: object
      title: createSubscription
      type: object
    CreateOrderUpdateProductTriggerParams:
      description: |
        Specifies when a charge becomes active.
      properties:
        specificTriggerDate:
          description: >
            Date in YYYY-MM-DD format. Only applicable if the value of the
            `triggerEvent` field is `SpecificDate`. 


            While this field is applicable, if this field is not set, your
            `CreateSubscription` order action creates a `Pending` order and a
            `Pending Acceptance` subscription. If at the same time the service
            activation date is required and not set, a `Pending Activation`
            subscription is created.


            While this field is applicable, if this field is not set, the
            following order actions create a `Pending` order but do not impact
            the subscription status. **Note**: This feature is in **Limited
            Availability**. If you want to have access to the feature, submit a
            request at [Zuora Global Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions

            While this field is applicable, for the `updateProduct` order
            action, if the Pending order feature as above is not enabled, this
            field must not be set to null.
          format: date
          type: string
        triggerEvent:
          description: >
            Condition for the charge to become active. If this field is not
            specified, the value of the field will be defaulted to the trigger
            event value defined in the product catalog.


            If the value of this field is `SpecificDate`, use the
            `specificTriggerDate` field to specify the date when the charge
            becomes active.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
          type: string
      title: startDate
      type: object
    CreateOrderPricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/ChargeModelDataOverride'
          description: >
            Container for charge model configuration data.


            **Note**: This field is only available if you have the High Water
            Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models
            enabled. The High Water Mark and Pre-Rated Pricing charge models are
            available for customers with Enterprise and Nine editions by
            default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
        discount:
          allOf:
            - $ref: '#/components/schemas/DiscountPricingUpdate'
          description: |
            Pricing information about a discount charge.
        recurringDeliveryBased:
          allOf:
            - $ref: '#/components/schemas/RecurringDeliveryPricingUpdate'
          description: >
            This field is only available if you have the Delivery Pricing charge
            model enabled.
        recurringFlatFee:
          allOf:
            - $ref: '#/components/schemas/RecurringFlatFeePricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "flat
            fee" charge model. In this charge model, the charge has a fixed
            price.
        recurringPerUnit:
          allOf:
            - $ref: '#/components/schemas/RecurringPerUnitPricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "per
            unit" charge model. In this charge model, the charge has a fixed
            price per unit purchased.
        recurringTiered:
          allOf:
            - $ref: '#/components/schemas/RecurringTieredPricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "tiered
            pricing" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            purchased.
        recurringVolume:
          allOf:
            - $ref: '#/components/schemas/RecurringVolumePricingUpdate'
          description: >
            Pricing information about a recurring charge that uses the "volume
            pricing" charge model. In this charge model, the charge has a
            variable price per unit, depending on how many units are purchased.
        usageFlatFee:
          allOf:
            - $ref: '#/components/schemas/UsageFlatFeePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "flat fee"
            charge model. In this charge model, the charge has a fixed price.
        usageOverage:
          allOf:
            - $ref: '#/components/schemas/UsageOveragePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "overage"
            charge model. In this charge model, the charge has an allowance of
            free units and a fixed price per additional unit consumed.
        usagePerUnit:
          allOf:
            - $ref: '#/components/schemas/UsagePerUnitPricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "per unit"
            charge model. In this charge model, the charge has a fixed price per
            unit consumed.
        usageTiered:
          allOf:
            - $ref: '#/components/schemas/UsageTieredPricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "tiered
            pricing" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            consumed.
        usageTieredWithOverage:
          allOf:
            - $ref: '#/components/schemas/UsageTieredWithOveragePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "tiered with
            overage" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            consumed. The charge also has a fixed price per unit consumed beyond
            the limit of the final tier.
        usageVolume:
          allOf:
            - $ref: '#/components/schemas/UsageVolumePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "volume
            pricing" charge model. In this charge model, the charge has a
            variable price per unit, depending on how many units are consumed.
      type: object
    CreateOrderChargeUpdate:
      description: >
        The JSON object containing the information for a charge update in the
        'UpdateProduct' type order action.
      properties:
        billing:
          $ref: '#/components/schemas/BillingUpdate'
        chargeNumber:
          description: >
            The number of the charge to be updated. The value of this field is
            inherited from the `subscriptions` > `orderActions` > `addProduct` >
            `chargeOverrides` > `chargeNumber` field.
          type: string
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            The value of this field must be a date within the subscription term.
            The system will then automatically calculate the estimated end date
            for the pending charge. The estimated start and end dates are used
            to manage the estimated charge duration and forecast the revenue for
            the pending charge.


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        negotiatedPriceTable:
          description: >
            Array of negotiated price table information. The rate card entries
            provided in the array will override the existing rate card entries
            in the standard price table to form a negotiated price table that
            will be    

            used during pricing evaluation.



            **Note:** To enable the Negotiated Price Table feature, submit a
            request to <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          items:
            $ref: '#/components/schemas/NegotiatedItems'
          type: array
        pricingAttributes:
          description: >
            Container for pricing attribute and value that provide additional
            context for dynamic pricing. The pricing attribute values included
            in the array will update the existing values. For the pricing
            attribute mapped to a Zuora object field, Zuora will retrieve the
            value automatically, you don’t need to pass its value explicitly. If
            you pass a value that doesn’t match the actual value of the Zuora
            object, an error will be returned.

            Note that for any pricing attribute mapped to the field of Zuora
            object Usage, because its value is only determined when the usage
            record arrives, you can’t provide a value via Orders API payload and
            Zuora will not retrieve its value automatically.




            **Note:** To enable Dynamic Pricing, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          additionalProperties: true
        productRatePlanChargeId:
          description: >
            ID of a product rate plan charge for this subscription. When
            `isAddingSubsetCharges` is set to true, the product rate charge
            specified by `productRatePlanChargeId` is added to the existing rate
            plan specified by `ratePlanId`.
          type: string
        productRatePlanChargeNumber:
          description: >
            Number of a product rate plan charge for this subscription. When
            `isAddingSubsetCharges` is set to true, the product rate charge
            specified by `productRatePlanChargeNumber` is added to the existing
            rate plan specified by `ratePlanId`.
          type: string
        customFields:
          $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
        description:
          type: string
        effectiveDate:
          $ref: '#/components/schemas/CreateOrderUpdateProductTriggerParams'
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
        pricing:
          allOf:
            - $ref: '#/components/schemas/CreateOrderPricingUpdate'
          description: |
            Pricing information about the charge.
        uniqueToken:
          description: >
            A unique string to represent the rate plan charge in the order. The
            unique token is used to perform multiple actions against a newly
            added rate plan charge. For example, if you want to add and update a
            product in the same order, assign a unique token to the newly added
            rate plan charge and use that token in future order actions.
          type: string
      type: object
    CreateOrderRatePlanUpdate:
      description: |
        Information about an order action of type `UpdateProduct`.
      properties:
        chargeUpdates:
          description: >
            Array of the JSON objects containing the information for a charge
            update in the `updateProduct` type of order action.
          items:
            $ref: '#/components/schemas/CreateOrderChargeUpdate'
          type: array
        clearingExistingFeatures:
          description: |
            Specifies whether all features in the rate plan will be cleared.
          type: boolean
        customFields:
          $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
        externalCatalogPlanId:
          description: >
            An external ID of the rate plan to be updated. You can use this
            field to specify an existing rate plan in your subscription. The
            value of the `externalCatalogPlanId` field must match one of the
            values that are predefined in the `externallyManagedPlanIds` field
            on a product rate plan. However, if there are multiple rate plans
            with the same `productRatePlanId` value existing in the
            subscription, you must use the `ratePlanId` field to update the rate
            plan. The `externalCatalogPlanId` field cannot be used to
            distinguish multiple rate plans in this case.


            **Note:** If both `externalCatalogPlanId` and `ratePlanId` are
            provided. They must point to the same product rate plan. Otherwise,
            the request would fail.
          type: string
        isAddingSubsetCharges:
          description: >
            Specifies whether to add a subset of charges to the subscription.



            **Note:** To access this field for adding a subset of charges,
            submit a request at <a href="http://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            The id of the rate plan to be updated. It can be the latest version
            or any history version id.
          type: string
        specificUpdateDate:
          description: >
            The specific date when the Update Product order action takes
            effect.  This field allows you to update a charge before a
            future-dated Update Product order action on the subscription. The
            format of the date is yyyy-mm-dd.


            **Note**: After you use this option, the charge's `TriggerEvent`
            field value will be changed to `SpecificDate`. 


            See [Update a Product on Subscription with Future-dated
            Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates)
            for more information about this feature.
          format: date
          type: string
        subscriptionProductFeatures:
          description: >
            List of features associated with the rate plan.

            The system compares the `subscriptionProductFeatures` and
            `featureId` fields in the request with the counterpart fields in a
            rate plan. The comparison results are as follows:

            * If there is no `subscriptionProductFeatures` field or the field is
            empty, features in the rate plan remain unchanged. But if the
            `clearingExistingFeatures` field is additionally set to true, all
            features in the rate plan are cleared.

            * If the `subscriptionProductFeatures` field contains the
            `featureId` nested fields, as well as the optional `description` and
            `customFields` nested fields, the features indicated by the
            featureId nested fields in the request overwrite all features in the
            rate plan.
          items:
            $ref: '#/components/schemas/CreateOrderRatePlanFeatureOverride'
          type: array
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
        uniqueToken:
          description: >
            A unique string to represent the rate plan in the order. The unique
            token is used to perform multiple actions against a newly added rate
            plan. For example, if you want to add and update a product in the
            same order, assign a unique token to the newly added rate plan and
            use that token in future order actions.
          type: string
      title: updateRateplan
      type: object
    CreateOrderOrderAction:
      properties:
        addProduct:
          $ref: '#/components/schemas/CreateOrderRatePlanOverride'
        cancelSubscription:
          $ref: '#/components/schemas/CancelSubscription'
        changePlan:
          $ref: '#/components/schemas/CreateChangePlan'
        changeReason:
          description: |
            The change reason set for an order action when an order is created.
          maxLength: 255
          type: string
        createSubscription:
          $ref: '#/components/schemas/CreateOrderCreateSubscription'
        customFields:
          $ref: '#/components/schemas/OrderActionObjectCustomFields'
        ownerTransfer:
          $ref: '#/components/schemas/OwnerTransfer'
        removeProduct:
          $ref: '#/components/schemas/RemoveProduct'
        renewSubscription:
          $ref: '#/components/schemas/RenewSubscription'
        resume:
          $ref: '#/components/schemas/CreateOrderResume'
        suspend:
          $ref: '#/components/schemas/CreateOrderSuspend'
        termsAndConditions:
          $ref: '#/components/schemas/CreateOrderTermsAndConditions'
        triggerDates:
          description: >
            Container for the contract effective, service activation, and
            customer acceptance dates of the order action. 


            If [Zuora is configured to require service
            activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F)
            and the `ServiceActivation` field is not set for a
            `CreateSubscription` order action, a `Pending` order and a `Pending
            Activation` subscription are created.


            If [Zuora is configured to require customer
            acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F)
            and the `CustomerAcceptance` field is not set for a
            `CreateSubscription` order action, a `Pending` order and a `Pending
            Acceptance` subscription are created. At the same time, if the
            service activation date field is also required and not set, a
            `Pending` order and a `Pending Activation` subscription are created
            instead.


            If [Zuora is configured to require service
            activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F)
            and the `ServiceActivation` field is not set for either of the
            following order actions, a `Pending` order is created. The
            subscription status is not impacted. **Note:** This feature is in
            **Limited Availability**. If you want to have access to the feature,
            submit a request at [Zuora Global
            Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions

            If [Zuora is configured to require customer
            acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F)
            and the `CustomerAcceptance` field is not set for either of the
            following order actions, a `Pending` order is created. The
            subscription status is not impacted. **Note:** This feature is in
            **Limited Availability**. If you want to have access to the feature,
            submit a request at [Zuora Global
            Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions
          items:
            $ref: '#/components/schemas/TriggerDate'
          type: array
        type:
          description: >
            Type of order action.


            Unless the type of order action is `RenewSubscription`, you must use
            the corresponding field to provide information about the order
            action. For example, if the type of order action is `AddProduct`,
            you must set the `addProduct` field.


            Zuora returns an error if you set a field that corresponds to a
            different type of order action. For example, if the type of order
            action is `AddProduct`, Zuora returns an error if you set the
            `updateProduct` field.


            A [pending
            order](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/Pending_Order_and_Subscription)
            supports the following order actions:
             * CreateSubscription
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions
             * ChangePlan

            However, pending orders created through all order actions except for
            "Create new subscription":
             * Do not impact the subscription status.
             * Are in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). 

            A pending order is created in either of the following conditions:
             * [Zuora is configured to require service activation](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Service_Activation_of_Orders.3F) and the service activation date is not set in your "Create an order" call.
             * [Zuora is configured to require customer acceptance](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Default_Subscription_Settings#Require_Customer_Acceptance_of_Orders.3F) and the customer acceptance date is not set in your "Create an order" call.
             * When a charge in the subscription has its `triggerEvent` field set as `SpecificDate` and the `specificTriggerDate` field is not set in your "Create an order" API call.

            **Note**: The change plan type of order action is supported for the 
            <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature. However, it is
            currently not supported for the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> feature. When
            Billing - Revenue Integration is enabled, the change plan type of
            order action will no longer be applicable in Zuora Billing.
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        updateProduct:
          $ref: '#/components/schemas/CreateOrderRatePlanUpdate'
      required:
        - type
      type: object
    POSTOrderRequestType:
      example:
        existingAccountNumber: A00000097
        orderDate: '2024-07-01'
        subscriptions:
          - orderActions:
              - type: CreateSubscription
                createSubscription:
                  terms:
                    initialTerm:
                      period: 12
                      periodType: Month
                      termType: TERMED
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerms:
                      - period: 12
                        periodType: Month
                  subscribeToRatePlans:
                    - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4
      properties:
        category:
          default: NewSales
          description: >
            Category of the order to indicate a product sale or return. Default
            value is `NewSales`.
          enum:
            - NewSales
            - Return
          type: string
        commitments:
          description: >
            It contains a list of commitments to create or update. 

            Use the `action` nested field to indicate whether to create or
            update the commitment.
          items:
            $ref: '#/components/schemas/UpsertCommitmentInput'
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        description:
          description: A description of the order.
          maxLength: 500
          type: string
        existingAccountId:
          description: >
            The account ID under which this order will be created. This field
            sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order. To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field. If you want to relax the
            restriction that the `existingAccountNumber` must be the invoice
            owner of the subscriptions in this order, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.


            **Note:** You can specify either the `existingAccountNumber` or
            `existingAccountId` field, but not both.
          type: string
        existingAccountNumber:
          description: >
            The account number under which this order will be created. This
            field sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order. To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field. If you want to relax the
            restriction that the `existingAccountNumber` must be the invoice
            owner of the subscriptions in this order, submit a request to <a
            href="https://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          maxLength: 70
          type: string
        newAccount:
          $ref: '#/components/schemas/CreateOrderNewAccount'
        orderDate:
          description: >-
            The date when the order is signed. All the order actions under this
            order will use this order date as the contract effective date if the
            contract effective date field is skipped or its value is left as
            null.
          format: date
          type: string
        orderLineItems:
          description: >
            [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            are non subscription based items created by an Order, representing
            transactional charges such as one-time fees, physical goods, or
            professional service charges that are not sold as subscription
            services. 


            With the Order Line Items feature enabled, you can now launch
            non-subscription and unified monetization business models in Zuora,
            in addition to subscription business models.


            If you do not have the **Create Order Line Items Without Product
            Catalog** billing permission, you can only create order  line items
            from existing products by specifying the product rate plan charge ID
            in the `productRatePlanChargeId` field.  For more information about
            billing permissions, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/System_Management/Administrator_Settings/User_Roles/d_Billing_Roles"
            target="_blank">Billing Roles</a>.


            **Note:** The [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature is now generally available to all Zuora customers. You need
            to enable the
            [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
            feature to access the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature. As of Zuora Billing Release 313 (November 2021), new
            customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            will have the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
            feature enabled by default.        
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          description: >
            The order number of the new order. If not provided, system will
            auto-generate a number for this order.   

            **Note:** The characters `#`, `?`, and `/` are not allowed in this
            field. Additionally, to ensure compatibility with the UI when
            viewing orders, use only the following special characters: `_`,`-`,
            `.`, `~`, `*`, `(`, `)`, and `'`.
          maxLength: 100
          type: string
        processingOptions:
          $ref: >-
            #/components/schemas/processingOptionsOrdersWithDelayedCapturePayment
        reasonCode:
          description: >
            Values of reason code configured in **Billing Settings** >
            **Configure Reason Codes** through Zuora UI. Indicates the reason
            when a return order line item occurs.
          maxLength: 255
          type: string
        schedulingOptions:
          description: |
            Information of scheduled order. 
          properties:
            scheduledDate:
              description: |
                The date for the order scheduled.
              format: date
              type: string
            scheduledDatePolicy:
              description: Date policy of the scheduled order.
              enum:
                - SpecificDate
              type: string
          type: object
        status:
          description: >
            The status of the order. The default value is `Completed`. The
            following values are supported:

            - `Draft`: The order is in draft status.

            - `Pending`: The order is in pending status.

            - `Completed`: The order is in completed status.

            - `Scheduled`: The order is in scheduled status and it is only valid
            if the Scheduled Orders feature is enabled.

            - `Executing`: The scheduled order is executed by a scheduler and it
            is only valid if the Scheduled Orders feature is enabled.

            - `Failed`: The scheduled order has failed.


            **Note:** If you have the Pending Subscription Processing feature
            turned on and want to  create a completed order with an active
            subscription with pending charges, you must specify  `Completed` in
            this field because the default order status is `Pending` for this
            scenario.
          enum:
            - Draft
            - Pending
            - Completed
            - Scheduled
            - Executing
            - Failed
          type: string
        subscriptions:
          description: >-
            Each item includes a set of order actions, which will be applied to
            the same base subscription.  When you create an order that involves
            multiple subscriptions, these subscriptions can have different
            invoice owner accounts or subscription owner accounts. 
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                description: >
                  Notes about the subscription. These notes are only visible to
                  Zuora users. Notes set in this field will override the value
                  of the `notes` field within the createSubscription order
                  action.
                type: string
                maxLength: 1000
              orderActions:
                description: >-
                  The actions to be applied to the subscription. Order actions
                  will be stored with the sequence when it was provided in the
                  request.
                items:
                  $ref: '#/components/schemas/CreateOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                description: >
                  Leave this empty to represent new subscription creation.
                  Specify a subscription number to update an existing
                  subscription.
                type: string
            type: object
          type: array
      required:
        - orderDate
      type: object
    processingOptionsOrdersAsync:
      description: >
        The container for billing processing options and payment processing
        options.


        **Note:** This field is not supported in draft orders.
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to an invoice. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
          items:
            type: string
          type: array
        applyCredit:
          description: >

            - If the value is true, the credit memo or unapplied payment on the
            order account will be automatically applied to the invoices
            generated by this order. The credit memo generated by this order
            will not be automatically applied to any invoices



            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: boolean
        applyCreditBalance:
          description: >
            Indicates if any credit balance on a customer's account is
            automatically applied to invoices. If no value is specified then
            this field defaults to false. This feature is not available if you
            have enabled the Invoice Settlement feature.
          type: boolean
        billingOptions:
          properties:
            creditMemoReasonCode:
              description: >-
                A code identifying the reason for the credit memo transaction
                that is generated by the request. The value must be an existing
                reason code. If you do not pass the field or pass the field with
                empty value, Zuora uses the default reason code.
              type: string
            documentDate:
              description: |
                The invoice date displayed on the invoice.
              format: date
              type: string
            generateDraftInvoice:
              description: >
                Indicates if the current request needs to generate a draft
                invoice.


                Values are:


                * `true`

                * `false` (default)
              type: boolean
            targetDate:
              description: >
                Date through which to calculate charges if an invoice is
                generated. See [What is a Target
                Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).


                **Note**: If you do not specify this field, today's date is used
                by default.  
              format: date
              type: string
            chargeTypeToExclude:
              description: >
                The types of the charges to be excluded from the generation of
                billing documents.
              items:
                type: string
                enum:
                  - OneTime
                  - Recurring
                  - Usage
              type: array
          type: object
        collectPayment:
          description: >
            Indicates if the current request needs to collect payments. This
            value can not be 'true' when 'runBilling' flag is 'false'.
          type: boolean
        electronicPaymentOptions:
          description: |
            Container for the electronic payment options.
          properties:
            paymentGatewayId:
              description: >
                Specifies the ID of a payment gateway to override the default
                gateway. If this field is not specified, the default payment
                gateway will be used to process the payment.
              type: string
            paymentMethodId:
              description: >
                Specifies an electronic payment method. It can be one that has
                already been associated with an invoice owner, or an orphan
                payment method, which is not associated with any invoice owner.
                For an orphan payment method, this operation will then associate
                it with the account that this order will be created under.
              type: string
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values.

                The fields supported by gateways vary. For more information, see
                the

                overview topic of each gateway integration in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways"
                target="_blank">Zuora Knowledge Center</a>.


                Zuora sends all the information that you specified to the
                gateway. If you

                specify any unsupported gateway option parameters, they will be
                ignored

                without error prompts.
              type: object
              title: gatewayOptions
              additionalProperties:
                type: string
                description: |
                  The gateway options specification consists of key-value pairs:
                    - Field name: The name of a gateway-specific parameter.
                    - Field value: The value of the gateway-specific parameter.
          type: object
        runBilling:
          description: >
            Indicates if the current request needs to generate an invoice. The
            invoice will be generated against all subscriptions included in this
            order.
          type: boolean
      type: object
    POSTOrderAsyncRequestType:
      example:
        existingAccountNumber: A00000097
        orderDate: '2024-07-01'
        subscriptions:
          - orderActions:
              - type: CreateSubscription
                createSubscription:
                  terms:
                    initialTerm:
                      period: 12
                      periodType: Month
                      termType: TERMED
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    renewalTerms:
                      - period: 12
                        periodType: Month
                  subscribeToRatePlans:
                    - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4
      properties:
        category:
          default: NewSales
          description: >
            Category of the order to indicate a product sale or return. Default
            value is `NewSales`.
          enum:
            - NewSales
            - Return
          type: string
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        description:
          description: A description of the order.
          maxLength: 500
          type: string
        existingAccountId:
          description: >
            The account ID under which this order will be created.  This field
            sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order.  To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field. 


            **Note:** You can specify either the `existingAccountNumber` or
            `existingAccountId` field, but not both.
          type: string
        existingAccountNumber:
          description: >
            The account number under which this order will be created.  This
            field sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order. To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field.
          maxLength: 70
          type: string
        externallyManagedBy:
          description: >
            An enum field on the Subscription object to indicate the name of a
            third-party store. This field is used to represent subscriptions
            created through third-party stores.
          enum:
            - Amazon
            - Apple
            - Google
            - Roku
          type: string
        newAccount:
          $ref: '#/components/schemas/CreateOrderNewAccount'
        orderDate:
          description: >-
            The date when the order is signed. All the order actions under this
            order will use this order date as the contract effective date if the
            contract effective date field is skipped or its value is left as
            null.
          format: date
          type: string
        orderLineItems:
          description: >
            [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            are non subscription based items created by an Order, representing
            transactional charges such as one-time fees, physical goods, or
            professional service charges that are not sold as subscription
            services. 


            With the Order Line Items feature enabled, you can now launch
            non-subscription and unified monetization business models in Zuora,
            in addition to subscription business models.


            If you do not have the **Create Order Line Items Without Product
            Catalog** billing permission, you can only create order  line items
            from existing products by specifying the product rate plan charge ID
            in the `productRatePlanChargeId` field.  For more information about
            billing permissions, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/System_Management/Administrator_Settings/User_Roles/d_Billing_Roles"
            target="_blank">Billing Roles</a>.


            **Note:** The [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature is now generally available to all Zuora customers. You need
            to enable the
            [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders)
            feature to access the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items)
            feature. As of Zuora Billing Release 313 (November 2021), new
            customers who onboard on
            [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders)
            will have the [Order Line
            Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items)
            feature enabled by default.        
          items:
            $ref: '#/components/schemas/CreateOrderOrderLineItem'
          type: array
        orderNumber:
          description: >
            The order number of the new order. If not provided, system will
            auto-generate a number for this order.   

            **Note:** The characters `#`, `?`, and `/` are not allowed in this
            field. Additionally, to ensure compatibility with the UI when
            viewing orders, use only the following special characters: `_`,`-`,
            `.`, `~`, `*`, `(`, `)`, and `'`.
          maxLength: 100
          type: string
        processingOptions:
          $ref: '#/components/schemas/processingOptionsOrdersAsync'
        reasonCode:
          description: >
            Values of reason code configured in **Billing Settings** >
            **Configure Reason Codes** through Zuora UI. Indicates the reason
            when a return order line item occurs.
          maxLength: 255
          type: string
        subscriptions:
          description: >-
            Each item includes a set of order actions, which will be applied to
            the same base subscription. When you create an order that involves
            multiple subscriptions, these subscriptions can have different
            invoice owner accounts or subscription owner accounts. 
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              notes:
                description: >
                  Notes about the subscription. These notes are only visible to
                  Zuora users. Notes set in this field will override the value
                  of the `notes` field within the createSubscription order
                  action.
                type: string
                maxLength: 1000
              orderActions:
                description: >-
                  The actions to be applied to the subscription. Order actions
                  will be stored with the sequence when it was provided in the
                  request.
                items:
                  $ref: '#/components/schemas/CreateOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                description: >
                  Leave this empty to represent new subscription creation.
                  Specify a subscription number to update an existing
                  subscription.
                type: string
            type: object
          type: array
      required:
        - orderDate
      type: object
    GetOrderResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            order:
              $ref: '#/components/schemas/Order'
          type: object
    processingOptionsOrders:
      description: >
        The container for billing processing options and payment processing
        options.


        **Note:**

        - This field is not supported in draft orders.

        - When you use the "Create an order" operation to create an account,
        create a subscription, run billing, and collect payment in a single
        call, if any error occurs during the call, such as a payment processing
        failure and a tax engine failure, then all the other steps will be
        rolled back. In this case, neither the invoice will be generated, nor
        the subscription nor the account will be created.

        - When you use the "Create an order" operation to cancel a subscription
        with `refund` and `writeOff`, if the `refund` or `writeOff` fails,
        `cancelSubscription`, `runBilling`, and `collectPayment` still can
        succeed.

        - When you use the "Create an order" operation, the `collectPayment` and
        `refund` fields cannot be set to `true` simultaneously.  Otherwise, the
        order will not be proceeded.
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to an invoice. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
          items:
            type: string
          type: array
        applyCredit:
          description: >
            Whether to automatically apply credit memos or unapplied payments,
            or both to an invoice.


            If the value is true, the credit memo or unapplied payment on the
            order account will be automatically applied to the invoices
            generated by this order. The credit memo generated by this order
            will not be automatically applied to any invoices.          



            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: boolean
        applyCreditBalance:
          description: >
            Indicates if any credit balance on a customer's account is
            automatically applied to invoices. If no value is specified then
            this field defaults to false. This feature is not available if you
            have enabled the Invoice Settlement feature.
          type: boolean
        billingOptions:
          properties:
            creditMemoReasonCode:
              description: >-
                A code identifying the reason for the credit memo transaction
                that is generated by the request. The value must be an existing
                reason code. If you do not pass the field or pass the field with
                empty value, Zuora uses the default reason code.
              type: string
            documentDate:
              description: |
                The invoice date displayed on the invoice.
              format: date
              type: string
            generateDraftInvoice:
              description: >
                Indicates if the current request needs to generate a draft
                invoice.


                Values are:


                * `true`

                * `false` (default)
              type: boolean
            targetDate:
              description: >
                Date through which to calculate charges if an invoice is
                generated. See [What is a Target
                Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).
              format: date
              type: string
          type: object
        collectPayment:
          description: >
            Indicates if the current request needs to collect payments. This
            value can not be 'true' when 'runBilling' flag is 'false'.
          type: boolean
        electronicPaymentOptions:
          description: |
            Container for the electronic payment options.
          properties:
            paymentGatewayId:
              description: >
                Specifies the ID of a payment gateway to override the default
                gateway. If this field is not specified, the default payment
                gateway will be used to process the payment.
              type: string
            paymentMethodId:
              description: >
                Specifies an electronic payment method. It can be one that has
                already been associated with an invoice owner, or an orphan
                payment method, which is not associated with any invoice owner.
                For an orphan payment method, this operation will then associate
                it with the account that this order will be created under.
              type: string
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values.

                The fields supported by gateways vary. For more information, see
                the

                overview topic of each gateway integration in <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways"
                target="_blank">Zuora Knowledge Center</a>.


                Zuora sends all the information that you specified to the
                gateway. If you

                specify any unsupported gateway option parameters, they will be
                ignored

                without error prompts.
              type: object
              title: gatewayOptions
              additionalProperties:
                type: string
                description: |
                  The gateway options specification consists of key-value pairs:
                    - Field name: The name of a gateway-specific parameter.
                    - Field value: The value of the gateway-specific parameter.
          type: object
        refund:
          description: >
            Indicates whether to refund after subscription cancelation. Default
            is `false`. 


            **Note**: When refunding a subscription that is not invoiced
            separately, if you do not enable the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement"
            target="_blank">Invoice Item Settlement</a> feature, you will
            encounter the following error during the cancel and refund process:
            “Cancellation/Refund failed because of the following reason: Invoice
            is linked to multiple subscriptions. Cancellation was not
            processed.”
          type: boolean
        refundAmount:
          description: >
            Indicates the amount to be refunded. Required if the `refund` field
            is `true`.
          type: number
        refundReasonCode:
          description: >
            A code identifying the reason for the refund transaction. The value
            must be an existing payment refund reason code listed in **Payments
            Settings** > **Configure Reason Codes**. If you do not specify the
            field or leave the field with an empty value, Zuora uses the default
            payment refund reason code.
          type: string
        runBilling:
          description: >
            Indicates if the current request needs to generate an invoice. The
            invoice will be generated against all subscriptions included in this
            order.
          type: boolean
        writeOff:
          description: >
            Indicates whether to write off the outstanding balance on the
            invoice after refund. Default is `false`.


            **Note**: 

            - When refunding a subscription that is not invoiced separately, if
            you do not enable the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement/C_Invoice_Item_Settlement"
            target="_blank">Invoice Item Settlement</a> feature, you will
            encounter the following error during the cancel and refund process:
            “Cancellation/Refund failed because of the following reason: Invoice
            is linked to multiple subscriptions. Cancellation was not
            processed.”

            - The <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Invoice_Settlement"
            target="_blank">Invoice Settlement</a> feature must have been
            enabled for write-off.
          type: boolean
        writeOffBehavior:
          description: >
            The financial information of the credit memo items generated to
            write off the invoice balance. 


            **Note:** 
              - All the credit memo items that are used to write off the invoice will be applied with the same financial information.
              - Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here.
          properties:
            financeInformation:
              description: >
                Container for the finance information related to the credit memo
                items that are created for invoice write-off.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
          type: object
      type: object
    PUTOrderRequestType:
      example:
        existingAccountNumber: A00000097
        orderDate: '2024-11-11'
        subscriptions:
          - orderActions:
              - createSubscription:
                  notes: Notes about the subscription
                  terms:
                    renewalSetting: RENEW_WITH_SPECIFIC_TERM
                    initialTerm:
                      startDate: '2024-11-10'
                      period: 12
                      periodType: Month
                      termType: TERMED
                    renewalTerms:
                      - period: 6
                        periodType: Month
                type: CreateSubscription
      properties:
        category:
          default: NewSales
          description: >
            Category of the order to indicate a product sale or return. Default
            value is `NewSales`.
          enum:
            - NewSales
            - Return
          type: string
        commitments:
          items:
            $ref: '#/components/schemas/UpsertCommitmentInput'
          type: array
          description: |
            A list of commitments you want to create or update.
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        description:
          description: A description of the order.
          maxLength: 500
          type: string
        existingAccountId:
          description: >
            The account ID under which this order will be created.  This field
            sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order.  To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field. 


            **Note** You can specify either the `existingAccountNumber` or
            `existingAccountId` field, but not both.
          type: string
        existingAccountNumber:
          description: >
            The account number under which this order will be created.  This
            field sets the default invoice owner account and subscription owner
            account for any new subscriptions in the order. To override these
            defaults for individual subscriptions, use the
            `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber`
            nested fields in the `subscriptions` field.
          maxLength: 70
          type: string
        orderDate:
          description: >-
            The date when the order is signed. All the order actions under this
            order will use this order date as the contract effective date if the
            contract effective date field is skipped or its value is left as
            null.
          format: date
          type: string
        orderNumber:
          description: >
            The order number of the new order. If not provided, system will
            auto-generate a number for this order.   

            **Note:** The characters `#`, `?`, and `/` are not allowed in this
            field.
          maxLength: 100
          type: string
        processingOptions:
          $ref: '#/components/schemas/processingOptionsOrders'
        reasonCode:
          description: >
            Values of reason code configured in **Billing Settings** >
            **Configure Reason Codes** through Zuora UI. Indicates the reason
            when a return order line item occurs.
          maxLength: 255
          type: string
        schedulingOptions:
          description: |
            Information of scheduled order. 
          properties:
            scheduledDate:
              description: |
                The date for the order scheduled.
              format: date
              type: string
            scheduledDatePolicy:
              description: Date policy of the scheduled order.
              enum:
                - SpecificDate
              type: string
          type: object
        status:
          description: >
            The status of the order. The default value is `Completed`. The
            following values are supported:

            - `Draft`: The order is in draft status.

            - `Pending`: The order is in pending status.

            - `Completed`: The order is in completed status.

            - `Scheduled`: The order is in scheduled status and it is only valid
            if the Scheduled Orders feature is enabled.

            - `Executing`: The scheduled order is executed by a scheduler and it
            is only valid if the Scheduled Orders feature is enabled.

            - `Failed`: The scheduled order has failed.


            **Note:** If you have the Pending Subscription Processing feature
            turned on and want to  update a completed order with an active
            subscription with pending charges, you must specify  `Completed` in
            this field because the default order status is `Pending` for this
            scenario.
          enum:
            - Draft
            - Pending
            - Completed
            - Scheduled
            - Executing
            - Failed
          type: string
        subscriptions:
          description: >-
            Each item includes a set of order actions, which will be applied to
            the same base subscription.  When you create an order that involves
            multiple subscriptions, these subscriptions can have different
            invoice owner accounts or subscription owner accounts. 
          items:
            properties:
              customFields:
                $ref: '#/components/schemas/SubscriptionObjectCustomFields'
              orderActions:
                description: >-
                  The actions to be applied to the subscription. Order actions
                  will be stored with the sequence when it was provided in the
                  request.
                items:
                  $ref: '#/components/schemas/CreateOrderOrderAction'
                type: array
              quote:
                $ref: '#/components/schemas/QuoteObjectFields'
              ramp:
                $ref: '#/components/schemas/RampRequest'
              subscriptionNumber:
                description: >
                  Leave this empty to represent new subscription creation.
                  Specify a subscription number to update an existing
                  subscription.
                type: string
            type: object
          type: array
      required:
        - orderDate
      type: object
    PutOrderResponseType:
      description: Response information of orders.
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            accountId:
              description: >-
                The account ID for the order. This field is returned instead of
                the `accountNumber` field if the `returnIds` query parameter is
                set to `true`.
              maxLength: 32
              type: string
            accountNumber:
              description: The account number for the order.
              maxLength: 50
              type: string
            creditMemoIds:
              description: >-
                An array of the credit memo IDs generated in this order request.
                The credit memo is only available if you have the Invoice
                Settlement feature enabled. This field is returned instead of
                the `creditMemoNumbers` field if the `returnIds` query parameter
                is set to `true`.
              items:
                type: string
                maxLength: 32
              type: array
            creditMemoNumbers:
              description: >-
                An array of the credit memo numbers generated in this order
                request. The credit memo is only available if you have the
                Invoice Settlement feature enabled.
              items:
                type: string
                maxLength: 255
              type: array
            invoiceIds:
              description: >-
                An array of the invoice IDs generated in this order request.
                Normally it includes one invoice ID only, but can include
                multiple items when a subscription was tagged as invoice
                separately. This field is returned instead of the
                `invoiceNumbers` field if the `returnIds` query parameter is set
                to `true`.
              items:
                type: string
                maxLength: 32
              type: array
            invoiceNumbers:
              description: >-
                An array of the invoice numbers generated in this order request.
                Normally it includes one invoice number only, but can include
                multiple items when a subscription was tagged as invoice
                separately.
              items:
                type: string
                maxLength: 255
              type: array
            orderId:
              description: >-
                The ID of the order created. This field is returned instead of
                the `orderNumber` field if the `returnIds` query parameter is
                set to `true`.
              maxLength: 32
              type: string
            orderNumber:
              description: The order number of the order created.
              maxLength: 100
              type: string
            paidAmount:
              description: The total amount collected in this order request.
              maxLength: 22
              minLength: 9
              type: string
            paymentId:
              description: >-
                The payment Id that is collected in this order request. This
                field is returned instead of the `paymentNumber` field if the
                `returnIds` query parameter is set to `true`.
              maxLength: 32
              type: string
            paymentNumber:
              description: The payment number that is collected in this order request.
              maxLength: 32
              type: string
            ramps:
              description: >
                **Note**: This field is only available if you have the Ramps
                feature enabled.  The <a
                href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders"
                target="_blank">Orders</a>  feature must be enabled before you
                can access the <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics"
                target="_blank">Ramps</a> feature.  The Ramps feature is
                available for customers with Enterprise and Nine editions by
                default. If you are a Growth customer, see <a
                href="https://knowledgecenter.zuora.com/Entitlements_and_Service_Policies/Zuora_Editions">Zuora
                Editions</a> for pricing information coming October 2020. The
                ramp definitions created by this order request.
              items:
                properties:
                  rampNumber:
                    description: The number of the ramp definition.
                    maxLength: 50
                    type: string
                  subscriptionNumber:
                    description: >-
                      The number of the subscription that this ramp deal
                      definition is applied to.
                    maxLength: 150
                    type: string
                type: object
              type: array
            refunds:
              items:
                properties:
                  number:
                    description: The refund number. For example, `R-00009564`.
                    maxLength: 32
                    type: string
                  refundInvoiceNumbers:
                    description: >-
                      An array of the refunded invoice numbers generated in this
                      order request.
                    items:
                      type: string
                      maxLength: 255
                    type: array
                  status:
                    description: The status of the refund.
                    enum:
                      - Success
                      - Error
                    type: string
                type: object
              type: array
            status:
              description: >-
                Status of the order. `Pending` is only applicable for an order
                that contains a `CreateSubscription` order action.
              enum:
                - Draft
                - Pending
                - Completed
                - Scheduled
              type: string
            subscriptionIds:
              description: >-
                Container for the subscription IDs of the subscriptions in an
                order. This field is returned if the `returnIds` query parameter
                is set to `true`.
              items:
                type: string
                maxLength: 32
              type: array
            subscriptionOwnerId:
              description: Subscription owner account ID of the subscription.
              type: string
            subscriptionOwnerNumber:
              description: Subscription owner account number of the subscription.
              type: string
            subscriptions:
              description: >
                This field is available only if you are on the latest Zuora API
                minor

                version, or you set the `Zuora-Version` request header to
                `223.0` or a

                later available version.
              items:
                properties:
                  status:
                    description: >-
                      Status of the subscription. `Pending Activation` and
                      `Pending Acceptance` are only applicable for an order that
                      contains a `CreateSubscription` order action.
                    enum:
                      - Active
                      - Pending Activation
                      - Pending Acceptance
                      - Cancelled
                      - Suspended
                    type: string
                  subscriptionId:
                    description: >-
                      Subscription ID of the subscription included in this
                      order. This field is returned instead of the
                      `subscriptionNumber` field if the `returnIds` query
                      parameter is set to `true`.
                    maxLength: 32
                    type: string
                  subscriptionNumber:
                    description: >-
                      Subscription number of the subscription included in this
                      order.
                    maxLength: 150
                    type: string
                type: object
              type: array
            writeOff:
              items:
                properties:
                  amount:
                    description: The amount written off from the invoice balance.
                    maximum: 22
                    minimum: 9
                    type: number
                  failedReason:
                    description: The reason of write-off failure.
                    type: string
                  invoiceNumber:
                    description: >-
                      The number of the invoice that is written off. For
                      example, `INV00051208`.
                    maxLength: 255
                    type: string
                  status:
                    description: The status of the write-off.
                    enum:
                      - Success
                      - Failed
                    type: string
                  writeOffCreditMemoNumber:
                    description: The number of the credit memo that is written off.
                    maxLength: 255
                    type: string
                type: object
              type: array
            commitments:
              $ref: '#/components/schemas/CommitmentOutput'
          type: object
    DeleteOrderAsyncResponse:
      properties:
        jobId:
          description: >-
            The ID of an asynchronous job that will be returned for tracking the
            status and result of the job.
          type: string
        success:
          description: Indicates whether the call succeeded.
          type: boolean
      type: object
    GetAsyncCreateOrderJobResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - $ref: '#/components/schemas/CreateOrderResult'
        - type: object
          properties:
            jobType:
              description: The type of job.
              type: string
              enum:
                - AsyncCreateOrder
              default: AsyncCreateOrder
    GetAsyncPreviewOrderJobResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - $ref: '#/components/schemas/PreviewOrderResult'
        - type: object
          properties:
            jobType:
              description: The type of job.
              type: string
              enum:
                - AsyncPreviewOrder
              default: AsyncPreviewOrder
    GetAsyncOrderJobResponseResult:
      oneOf:
        - $ref: '#/components/schemas/GetAsyncCreateOrderJobResponse'
        - $ref: '#/components/schemas/GetAsyncPreviewOrderJobResponse'
      discriminator:
        propertyName: jobType
        mapping:
          AsyncCreateOrder: '#/components/schemas/GetAsyncCreateOrderJobResponse'
          AsyncPreviewOrder: '#/components/schemas/GetAsyncPreviewOrderJobResponse'
    GetAsyncOrderJobResponse:
      properties:
        errors:
          description: Error messages returned if the job failed.
          type: string
          nullable: true
        result:
          $ref: '#/components/schemas/GetAsyncOrderJobResponseResult'
        status:
          description: Type of job status.
          enum:
            - Processing
            - Failed
            - Completed
          type: string
        success:
          description: Indicates whether the operation call succeeded.
          type: boolean
      type: object
    GetOrdersResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            nextPage:
              description: >
                URL to retrieve the next page of the response if it exists;
                otherwise absent.
              format: URL
              type: string
            orders:
              items:
                $ref: '#/components/schemas/Order'
              type: array
          type: object
    PUTOrderPatchRequestType:
      example:
        customFields:
          CustomTag__c: internal
      properties:
        customFields:
          $ref: '#/components/schemas/OrderObjectCustomFields'
        subscriptions:
          items:
            properties:
              orderActions:
                items:
                  properties:
                    customFields:
                      $ref: '#/components/schemas/OrderActionObjectCustomFields'
                    orderActionId:
                      description: >
                        The Id of the order action in the order. You can provide
                        either the `sequence` or the `orderActionId` field to
                        specify which order action to update. You cannot use
                        then both at the same time.
                      type: string
                    sequence:
                      description: >
                        The sequence number of the order action in the order.
                        You can provide either the `sequence` or the
                        `orderActionId` field to specify which order action to
                        update. You cannot use then both at the same time.
                      type: integer
                  type: object
                type: array
              subscriptionNumber:
                type: string
            type: object
          type: array
      type: object
    PUTSubscriptionPatchRequestType:
      example:
        customFields:
          CustomTag__c: internal
      properties:
        customFields:
          $ref: '#/components/schemas/SubscriptionObjectCustomFields'
        ratePlans:
          items:
            properties:
              charges:
                items:
                  properties:
                    chargeId:
                      description: >
                        Use either this field or the `chargeNumber` field to
                        specify the charge for which you will be updating the
                        custom fields. By using this field you actually specify
                        a specific charge segment of a charge. See <a
                        href="https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges"
                        target="_blank">Segmented rate plan charges</a> for more
                        information about charge segments.
                      type: string
                    chargeNumber:
                      description: >
                        Use either this field or the `chargeId` field to specify
                        the charge for which you will be updating the custom
                        fields. By using this field you actually specify the
                        last charge segment of a charge. See <a
                        href="https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges"
                        target="_blank">Segmented rate plan charges</a> for more
                        information about charge segments.
                      type: string
                    customFields:
                      $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
                  type: object
                type: array
              customFields:
                $ref: '#/components/schemas/OrdersRatePlanObjectCustomFields'
              ratePlanId:
                description: >-
                  The rate plan id in any version of the subscription. This will
                  be linked to the only one rate plan in the current version.
                type: string
            type: object
          type: array
      type: object
    PUTOrderActionTriggerDatesRequestType:
      example:
        subscriptions:
          - subscriptionNumber: A-S00000143
            orderActions:
              - sequence: 0
                triggerDates:
                  - name: CustomerAcceptance
                    triggerDate: '2024-07-22'
      properties:
        subscriptions:
          items:
            properties:
              orderActions:
                items:
                  properties:
                    charges:
                      items:
                        properties:
                          chargeNumber:
                            description: >-
                              Charge number of the charge which needs the
                              triggering date to be provided. The charge's
                              `triggerEvent` must have been set as
                              `SpecificDate`.
                            type: string
                          specificTriggerDate:
                            description: >-
                              Date in YYYY-MM-DD format. The specific trigger
                              date you are to set for the charge.
                            format: date
                            type: string
                        type: object
                      type: array
                    sequence:
                      description: >
                        Identifies which order action will have its triggering
                        dates updated. 
                      type: integer
                    triggerDates:
                      description: >-
                        Container for the service activation and customer
                        acceptance dates of the order action.
                      items:
                        properties:
                          name:
                            description: Name of the trigger date of the order action.
                            enum:
                              - ServiceActivation
                              - CustomerAcceptance
                            type: string
                          triggerDate:
                            description: >
                              Trigger date in YYYY-MM-DD format. The date you
                              are to set as the service activation date or the
                              customer acceptance date.
                            format: date
                            type: string
                        type: object
                      type: array
                  required:
                    - sequence
                  type: object
                type: array
              subscriptionNumber:
                description: >
                  Subscription number of a subscription in the `Pending` order
                  for which you are to update the triggering dates. For example,
                  A-S00000001.
                maxLength: 100
                type: string
            required:
              - subscriptionNumber
            type: object
          type: array
      type: object
    PUTOrderTriggerDatesResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            accountNumber:
              description: The account number for the order.
              type: string
            orderNumber:
              description: The order number of the order updated.
              type: string
            status:
              description: Status of the order.
              enum:
                - Completed
                - Pending
              type: string
            subscriptions:
              description: The subscriptions updated.
              items:
                properties:
                  status:
                    description: >-
                      Status of the subscription. `Pending Activation` and
                      `Pending Acceptance` are only applicable for an order that
                      contains a `CreateSubscription` order action.
                    enum:
                      - Active
                      - Pending Activation
                      - Pending Acceptance
                    type: string
                  subscriptionNumber:
                    description: Subscription number of the subscription updated.
                    type: string
                type: object
              type: array
          type: object
    PutOrderCancelResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            accountNumber:
              description: The account number for the order.
              type: string
            cancelReason:
              description: The reason for cancelling the order.
              type: string
            orderNumber:
              description: The order number of the order created.
              type: string
            status:
              description: Status of the order. `Cancelled` is only valid value.
              enum:
                - Cancelled
              type: string
          type: object
    RevertOrderRequest:
      example:
        orderDate: '2000-01-23'
      properties:
        orderDate:
          description: The order date when order is booked in YYYY-MM-DD format.
          format: date
          type: string
      required:
        - orderDate
      title: RevertOrderRequest
      type: object
    RevertOrderResponse:
      allOf:
        - properties:
            accountNumber:
              description: The account number for the order.
              type: string
            orderNumber:
              description: The order number of the order created(reverting order).
              type: string
            subscriptionNumbers:
              description: The subscription numbers on which revert is applied.
              items:
                type: string
              type: array
            success:
              description: Indicates whether the call succeeded.
              type: boolean
            status:
              description: Status of the order. `Completed` is only valid value.
              enum:
                - Completed
              type: string
          type: object
    OrderActionCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Order Action object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields"
          target="_blank">Manage Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Order Action object.
      title: OrderActionCustomFields
      type: object
    OrderActionCommon:
      properties:
        changeReason:
          description: >
            The change reason set for an order action when the order action is
            updated.
          type: string
        customFields:
          $ref: '#/components/schemas/OrderActionCustomFields'
      title: OrderAction
      type: object
    PUTOrderActionsRequestType:
      example:
        changeReason: string
        customFields:
          PICKLIST_CF__c: option_1
      type: object
      allOf:
        - $ref: '#/components/schemas/OrderActionCommon'
    OrderLineItemCustomFieldsRetrieveOrderLineItem:
      additionalProperties:
        description: >
          Custom fields of the Order Line Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Order Line Item object.
      title: OrderLineItemCustomFields
      type: object
    OrderLineItemCommonRetrieveOrderLineItem:
      properties:
        UOM:
          description: |
            Specifies the units to measure usage.
          type: string
        accountingCode:
          description: |
            The accountingCode for the Order Line Item.
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available in the request body schema only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available in the request body schema only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.
          type: string
        amendedByOrderOn:
          description: >
            The date when the rate plan charge is amended through an order or
            amendment. This field is to standardize the booking date information
            to increase audit ability and traceability of data between Zuora
            Billing and Zuora Revenue. It is mapped as the booking date for a
            sales order line in Zuora Revenue.
          format: date
          type: string
        amountPerUnit:
          description: |
            The actual charged amount per unit for the Order Line Item.
          type: number
        billTargetDate:
          description: >
            The target date for the Order Line Item to be picked up by bill run
            for billing.
          format: date
          type: string
        billTo:
          description: >
            The ID of the bill-to contact of an order line item. An existing
            contact under the billing account is specified as the bill-to
            contact of the order line item. The billing account is the order
            account.
          type: string
        billToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the bill-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `billToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        billingRule:
          description: |
            The billing rule for the Order Line Item.
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available in the request body schema only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.
          type: string
        contractLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available in the request body schema only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available in the request body schema only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.
          type: string
        currency:
          description: >
            The currency for the order line item. You can specify a currency
            when creating an order line item through the "Create an order"
            operation.
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFieldsRetrieveOrderLineItem'
        deferredRevenueAccountingCode:
          description: |
            The deferred revenue accounting code for the Order Line Item.
          type: string
        description:
          description: |
            The description of the Order Line Item.
          type: string
        discount:
          description: >
            This field shows the total discount amount that is applied to an
            order line item after the `inlineDiscountType`,
            `inlineDiscountPerUnit` and `quantity` fields are set.


            The inline discount is applied to the list price of an order line
            item (see the `listPrice` field).
          type: number
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude Order Line Item related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          description: >
            The flag to exclude Order Line Item from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        inlineDiscountPerUnit:
          description: >
            This field is used in accordance with the `inlineDiscountType`
            field, in the following manner:

            * If the `inlineDiscountType` field is set as `Percentage`, this
            field specifies the discount percentage for each unit of the order
            line item. For exmaple, if you specify `5` in this field, the
            discount percentage is 5%.

            * If the `inlineDiscountType` field is set as `FixedAmount`, this
            field specifies the discount amount on each unit of the order line
            item. For exmaple, if you specify `10` in this field, the discount
            amount on each unit of the order line item is 10.


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          type: number
        inlineDiscountType:
          description: >
            This field is used to specify the inline discount type, which can be
            `Percentage`, `FixedAmount`, or `None`. The default value is
            `Percentage`.


            This field is used together with the `inlineDiscountPerUnit` field
            to specify inline discounts for order line items. The inline
            discount is applied to the list price of an order line item. 


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        invoiceOwnerAccountId:
          description: |
            The account ID of the invoice owner of the order line item.
          type: string
        invoiceOwnerAccountName:
          description: |
            The account name of the invoice owner of the order line item.
          type: string
        invoiceOwnerAccountNumber:
          description: |
            The account number of the invoice owner of the order line item.
          type: string
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        itemCategory:
          default: Sales
          description: >
            The category for the Order Line Item, to indicate a product sales or
            return.
          enum:
            - Sales
            - Return
          type: string
        itemName:
          description: |
            The name of the Order Line Item.
          type: string
        itemNumber:
          description: |
            The number for the Order Line Item.
          type: string
        itemState:
          description: >
            The state of the Order Line Item. See [State transitions for an
            order, order line item, and
            fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          description: |
            The type of the Order Line Item. 
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPrice:
          description: >
            The extended list price for an order line item, calculated by the
            formula: listPrice = listPricePerUnit * quantity
          type: number
        listPricePerUnit:
          description: |
            The list price per unit for the Order Line Item.
          type: number
        originalOrderDate:
          description: >
            The date when the rate plan charge is created through an order or
            amendment. This field is to standardize the booking date information
            to increase audit ability and traceability of data between Zuora
            Billing and Zuora Revenue. It is mapped as the booking date for a
            sales order line in Zuora Revenue.
          format: date
          type: string
        originalOrderId:
          description: |
            The ID of the original sales order for a return order line item.
          type: string
        originalOrderLineItemId:
          description: >
            The ID of the original sales order line item for a return order line
            item.
          type: string
        originalOrderLineItemNumber:
          description: >
            The number of the original sales order line item for a return order
            line item.
          type: string
        originalOrderNumber:
          description: |
            The number of the original sales order for a return order line item.
          type: string
        ownerAccountId:
          description: |
            The account ID of the owner of the order line item.
          type: string
        ownerAccountName:
          description: |
            The account name of the owner of the order line item.
          type: string
        ownerAccountNumber:
          description: |
            The account number of the owner of the order line item.
          type: string
        productCode:
          description: |
            The product code for the Order Line Item.
          type: string
        productRatePlanChargeId:
          description: >
            Id of a Product Rate Plan Charge. Only one-time charges are
            supported.
          type: string
        purchaseOrderNumber:
          description: >
            Used by customers to specify the Purchase Order Number provided by
            the buyer.
          type: string
        quantity:
          description: >
            The quantity of units, such as the number of authors in a hosted
            wiki service.
          type: number
        quantityAvailableForReturn:
          description: |
            The quantity that can be returned for an order line item. 
          type: number
        quantityFulfilled:
          description: |
            The fulfilled quantity for an order line item. 
          type: number
        quantityPendingFulfillment:
          description: |
            The quantity to fulfill for an order line item. 
          type: number
        recognizedRevenueAccountingCode:
          description: |
            The recognized revenue accounting code for the Order Line Item.
          type: string
        relatedSubscriptionNumber:
          description: >
            Use this field to relate an order line item to an subscription.
            Specify this field to the subscription number of the subscription to
            relate.
          type: string
        requiresFulfillment:
          description: >
            The flag to show whether fulfillment is needed or not. It's derived
            from billing rule of the Order Line Item.
          type: boolean
        revenueRecognitionRule:
          description: |
            The Revenue Recognition rule for the Order Line Item.
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the OrderLineItem.
          type: string
          nullable: true
        communicationProfileId:
          description: >
            The ID of the communication profile associated with the
            subscription.
          type: string
          nullable: true
        shipTo:
          description: >
            The ID of a contact that belongs to the owner account or billing
            account of the order line item. Use this field to assign an existing
            account as the ship-to contact of an order line item.
          type: string
        shipToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the ship-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `shipToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        soldTo:
          description: >
            The ID of a contact that belongs to the owner account or billing
            account of the order line item. Use this field to assign an existing
            account as the sold-to contact of an order line item.
          type: string
        soldToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the sold-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `soldToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        taxCode:
          description: |
            The tax code for the Order Line Item.
          type: string
        taxMode:
          description: |
            The tax mode for the Order Line Item.
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          description: >
            The date a transaction is completed. The default value of this field
            is the transaction start date. Also, the value of this field should
            always equal or be later than the value of the
            `transactionStartDate` field.
          format: date
          type: string
        transactionStartDate:
          description: >
            The date a transaction starts. The default value of this field is
            the order date.
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available in the request body schema only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.
          type: string
      title: OrderLineItem
      type: object
    FulfillmentCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Fulfillment object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Fulfillment object.
      title: FulfillmentCustomFields
      type: object
    FulfillmentCommon:
      properties:
        billTargetDate:
          description: >
            The target date for the Fulfillment to be picked up by bill run for
            billing.
          format: date
          type: string
        carrier:
          description: >
            The carrier of the Fulfillment. The available values can be
            configured in **Billing Settings** > **Fulfillment Settings**
            through Zuora UI.
          type: string
        customFields:
          $ref: '#/components/schemas/FulfillmentCustomFields'
        description:
          description: |
            The description of the Fulfillment.
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude Fulfillment related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          description: >
            The flag to exclude Fulfillment from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        externalId:
          description: |
            The external id of the Fulfillment.
          type: string
        fulfillmentDate:
          description: |
            The date of the Fulfillment.
          format: date
          type: string
        fulfillmentLocation:
          description: >
            The fulfillment location of the Fulfillment. The available values
            can be configured in **Billing Settings** > **Fulfillment Settings**
            through Zuora UI.
          type: string
        fulfillmentSystem:
          description: >
            The fulfillment system of the Fulfillment. The available values can
            be configured in **Billing Settings** > **Fulfillment Settings**
            through Zuora UI.
          type: string
        fulfillmentType:
          description: |
            The type of the Fulfillment. 
          enum:
            - Delivery
            - Return
          type: string
        orderLineItemId:
          description: |
            The reference id of the related Order Line Item.
          format: UUID
          type: string
        quantity:
          description: |
            The quantity of the Fulfillment.
          type: number
        state:
          description: >
            The state of the Fulfillment. See [State transitions for an order,
            order line item, and
            fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        trackingNumber:
          description: |
            The tracking number of the Fulfillment.
          type: string
      title: Fulfillment
      type: object
    FulfillmentGet:
      allOf:
        - properties:
            fulfillmentNumber:
              description: |
                The sytem generated number for the Fulfillment.
              type: string
            id:
              description: |
                The sytem generated Id.
              format: UUID
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentCommon'
    OrderLineItem:
      allOf:
        - properties:
            amount:
              description: |
                The calculated gross amount for the Order Line Item.
              type: number
            amountWithoutTax:
              description: >
                The calculated gross amount for an order line item excluding
                tax. If the tax mode is tax exclusive, the value of this field
                equals that of the `amount` field.


                If the tax mode of an order line item is not set, the system
                treats it as tax exclusive by default. The value of the
                `amountWithoutTax` field equals that of the `amount` field.


                If you create an order line item from the product catalog, the
                tax mode and tax code of the product rate plan charge are used
                for the order line item by default. You can still overwrite this
                default set-up by setting the tax mode and tax code of the order
                line item.
              type: number
            id:
              description: |
                The sytem generated Id for the Order Line Item.
              format: UUID
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the order line
                item.


                After enabling the Invoice Grouping feature, you can specify
                invoice group numbers to bill subscriptions and order line items
                based on specific criteria. For the same account, Zuora
                generates separate invoices for subscriptions and order line
                items, each identified by unique invoice group numbers. For more
                information, see [Invoice
                Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
              maxLength: 255
              nullable: true
            quantityFulfilled:
              description: >
                The quantity that has been fulfilled by fulfillments for the
                order line item. This field will be updated automatically when
                related fulfillments become 'SentToBilling' or 'Complete' state.
              type: number
            quantityPendingFulfillment:
              description: >
                The quantity that needs to be fulfilled by fulfillments for the
                order line item. This field will be updated automatically when
                related fulfillments become 'SentToBilling' or 'Complete' state.
              type: number
          type: object
        - $ref: '#/components/schemas/OrderLineItemCommonRetrieveOrderLineItem'
        - properties:
            fulfillments:
              description: |
                Container for the fulfillments attached to an order line item.
              items:
                $ref: '#/components/schemas/FulfillmentGet'
              type: array
          type: object
    GetOrderLineItemResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            orderLineItem:
              $ref: '#/components/schemas/OrderLineItem'
          type: object
      example:
        success: true
        orderLineItems:
          - id: 8a90e4a7932049480193247166783bfe
            itemState: Executing
    OrderLineItemCommon:
      properties:
        UOM:
          description: >
            Specifies the units to measure usage.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        accountingCode:
          description: >
            The accountingCode for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        adjustmentLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        adjustmentRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        amountPerUnit:
          description: >
            The actual charged amount per unit for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: number
        billTargetDate:
          description: >
            The target date for the Order Line Item (OLI) to be picked up by
            bill run for generating billing documents.


            To generate billing documents for an OLI, you must set this field
            and set the `itemState` field to `SentToBilling`.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` or `Booked` state.
          format: date
          type: string
        billTo:
          description: >
            The ID of the bill-to contact of an order line item. Specify an
            existing contact under the billing account as the bill-to contact of
            the order line item. The billing account is the order account.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        billingRule:
          default: TriggerWithoutFulfillment
          description: >
            The rule for billing of the Order Line Item (OLI).


            You can update this field for a sales or return OLI only when it is
            in the `Executing` state (when the `itemState` field is set as
            `Executing`).
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        contractAssetAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        contractLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object.  This field is
            available only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        contractRecognizedRevenueAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        customFields:
          $ref: '#/components/schemas/OrderLineItemCustomFields'
        deferredRevenueAccountingCode:
          description: >
            The deferred revenue accounting code for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        description:
          description: >
            The description of the Order Line Item (OLI).


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled. 
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related rate plan charges and order
            line items from revenue accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled.
        inlineDiscountPerUnit:
          description: >
            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).


            Use this field in accordance with the `inlineDiscountType` field, in
            the following manner:

            * If the `inlineDiscountType` field is set as `Percentage`, this
            field specifies the discount percentage for each unit of the order
            line item. For exmaple, if you specify `5` in this field, the
            discount percentage is 5%.

            * If the `inlineDiscountType` field is set as `FixedAmount`, this
            field specifies the discount amount on each unit of the order line
            item. For exmaple, if you specify `10` in this field, the discount
            amount on each unit of the order line item is 10.


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          type: number
        inlineDiscountType:
          description: >
            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).


            Use this field to specify the inline discount type, which can be
            `Percentage`, `FixedAmount`, or `None`. The default value is
            `Percentage`.


            Use this field together with the `inlineDiscountPerUnit` field to
            specify inline discounts for order line items. The inline discount
            is applied to the list price of an order line item. 


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        isAllocationEligible:
          description: >
            This field is used to identify if the charge segment is allocation

            eligible in revenue recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        isUnbilled:
          description: >
            This field is used to dictate how to perform the accounting during
            revenue

            recognition.



            **Note**: The field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled. To enable this
            field, submit a request at <a href="https://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: boolean
        itemName:
          description: >
            The name of the Order Line Item (OLI).


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          type: string
        itemState:
          description: >
            The state of the Order Line Item (OLI). See [State transitions for
            an order, order line item, and
            fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.


            To generate invoice for an OLI, you must set this field to
            `SentToBilling` and set the `billTargetDate` field .


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` or 'Booked' or `SentToBilling`state (when
            the `itemState` field is set as `Executing` or `SentToBilling`).
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Canceled
          type: string
        itemType:
          description: >
            The type of the Order Line Item (OLI). 


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          description: >
            The list price per unit for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: number
        ownerAccountNumber:
          description: >
            Use this field to assign an existing account as the owner of an
            order line item.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        productCode:
          description: >
            The product code for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        purchaseOrderNumber:
          description: >
            Used by customers to specify the Purchase Order Number provided by
            the buyer.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        quantity:
          description: >
            The quantity of units, such as the number of authors in a hosted
            wiki service.


            You can update this field for a sales or return OLI only when the
            OLI in the `Executing` state (when the `itemState` field is set as
            `Executing`).
          type: number
        recognizedRevenueAccountingCode:
          description: >
            The recognized revenue accounting code for the Order Line Item
            (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        relatedSubscriptionNumber:
          description: >
            Use this field to relate an order line item to an subscription.
            Specify this field to the subscription number of the subscription to
            relate.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        revenueRecognitionRule:
          description: >
            The Revenue Recognition rule for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        invoiceGroupNumber:
          description: >
            The number of the invoice group associated with the order line item.


            After enabling the Invoice Grouping feature, you can specify invoice
            group numbers to bill subscriptions and order line items based on
            specific criteria. For the same account, Zuora generates separate
            invoices for subscriptions and order line items, each identified by
            unique invoice group numbers. For more information, see [Invoice
            Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).


            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
          maxLength: 255
          nullable: true
        sequenceSetId:
          description: >
            The ID or number of the sequence set associated with the order line
            item.



            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
        paymentTerm:
          description: |
            The payment term name associated with the order line item.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the order line item.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.
              - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`.
          type: string
        shipTo:
          description: >
            Use this field to assign an existing account as the ship-to contact
            of an order line item, by the following rules:


            * If the `ownerAccountNumber` field is set, then this field must be
            the ID of a contact that belongs to the owner account of the order
            line item. 

            * If the `ownerAccountNumber` field is not set, then this field must
            be the ID of a contact that belongs to the billing account of the
            order line item. The billing account is the order account.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        soldTo:
          description: >
            Use this field to assign an existing account as the sold-to contact
            of an order line item, by the following rules:


            * If the `ownerAccountNumber` field is set, then this field must be
            the ID of a contact that belongs to the owner account of the order
            line item. 

            * If the `ownerAccountNumber` field is not set, then this field must
            be the ID of a contact that belongs to the billing account of the
            order line item. The billing account is the order account.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        taxCode:
          description: >
            The tax code for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        taxMode:
          description: >
            The tax mode for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionEndDate:
          description: >
            The date a transaction is completed. The default value of this field
            is the transaction start date. Also, the value of this field should
            always equal or be later than the value of the
            `transactionStartDate` field.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        transactionStartDate:
          description: >
            The date a transaction starts. The default value of this field is
            the order date.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        unbilledReceivablesAccountingCode:
          description: >
            The accounting code on the Order Line Item object. This field is
            available only if you have enabled <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/B_Set_up_Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
      title: OrderLineItem
      type: object
    PutOrderLineItemUpdateType:
      allOf:
        - $ref: '#/components/schemas/OrderLineItemCommon'
    PUTOrderLineItemRequestType:
      allOf:
        - $ref: '#/components/schemas/PutOrderLineItemUpdateType'
      example:
        description": Details of the order line item
    PutOrderLineItemResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
    PostOrderLineItemUpdateType:
      allOf:
        - properties:
            id:
              description: >
                The sytem generated Id for the Order Line Item(OLI). Use this
                field to specify which OLI to update.
              format: UUID
              type: string
          required:
            - id
          type: object
        - $ref: '#/components/schemas/OrderLineItemCommon'
    BillingOptions:
      properties:
        documentDate:
          description: The invoice date displayed on the billing document.
          format: date
          type: string
        targetDate:
          description: >-
            Date through which to calculate charges for order line items if a
            billing document is generated. See [What is a Target
            Date?](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Creating_Bill_Runs#What_is_a_Target_Date.3F).
          format: date
          type: string
      type: object
    ProcessingOptions:
      description: Processing options for generating billing documents.
      properties:
        billingOptions:
          $ref: '#/components/schemas/BillingOptions'
        runBilling:
          description: >-
            Indicates if the current request needs to generate a billing
            document. The billing document will be generated against all Order
            Line Items included in this order.
          type: boolean
      type: object
    PostOrderLineItemsRequestType:
      example:
        orderLineItems:
          - id: 8a90e4a7932049480193247166783bfe
            description: Details of the order line item
      properties:
        orderLineItems:
          items:
            $ref: '#/components/schemas/PostOrderLineItemUpdateType'
          type: array
        processingOptions:
          $ref: '#/components/schemas/ProcessingOptions'
      type: object
    FulfillmentItemCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Fulfillment Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Fulfillment Item object.
      title: FulfillmentItemCustomFields
      type: object
    FulfillmentItemCommon:
      properties:
        customFields:
          $ref: '#/components/schemas/FulfillmentItemCustomFields'
        description:
          description: |
            The description of the Fulfillment Item.
          type: string
        itemIdentifier:
          description: |
            The external identifier of the Fulfillment Item.
          type: string
      title: FulfillmentItem
      type: object
    FulfillmentItemPostFromFulfillmentPost:
      allOf:
        - $ref: '#/components/schemas/FulfillmentItemCommon'
    FulfillmentPost:
      allOf:
        - properties:
            orderLineItemId:
              description: |
                The reference id of the related Order Line Item.
              format: UUID
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentCommon'
        - properties:
            fulfillmentItems:
              items:
                $ref: '#/components/schemas/FulfillmentItemPostFromFulfillmentPost'
              type: array
          type: object
    PostFulfillmentsRequestType:
      example:
        fulfillments:
          - billTargetDate: '2022-01-01'
            fulfillmentDate: '2022-01-01'
            fulfillmentType: Delivery
            orderLineItemId: 4028828c82819b740182821bb23e15c4
            quantity: 5
            state: SentToBilling
          - billTargetDate: '2022-01-01'
            fulfillmentDate: '2022-01-01'
            fulfillmentType: Delivery
            orderLineItemId: 4028828c82819b740182821bb23e15c4
            quantity: 5
            state: SentToBilling
        processingOptions:
          billingOptions:
            documentDate: '2022-01-01'
            targetDate: '2022-01-01'
          collectPayment: true
          runBilling: true
      properties:
        fulfillments:
          items:
            $ref: '#/components/schemas/FulfillmentPost'
          type: array
        processingOptions:
          $ref: '#/components/schemas/ProcessingOptions'
      type: object
    PostFulfillmentsResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            creditMemoNumbers:
              description: >
                An array of the credit memo numbers generated in this request.
                The credit memo is only available if you have the Invoice
                Settlement feature enabled.
              items:
                type: string
              type: array
            fulfillments:
              items:
                properties:
                  fulfillmentItems:
                    items:
                      properties:
                        id:
                          description: |
                            The sytem generated Id.
                          format: UUID
                          type: string
                      type: object
                    type: array
                  fulfillmentNumber:
                    description: |
                      The sytem generated number for the Fulfillment.
                    type: string
                  id:
                    description: |
                      The sytem generated Id.
                    format: UUID
                    type: string
                type: object
              type: array
            invoiceNumbers:
              description: >
                An array of the invoice numbers generated in this request.
                Normally it includes one invoice number only.
              items:
                type: string
              type: array
            paidAmount:
              description: |
                The total amount collected in this request.
              type: number
            paymentNumber:
              description: |
                The payment number collected in this request.
              type: string
          type: object
    GetFulfillmentResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            fulfillment:
              $ref: '#/components/schemas/FulfillmentGet'
          type: object
    PutFulfillmentRequestType:
      example:
        billTargetDate: '2022-01-01'
        fulfillmentDate: '2022-01-01'
        fulfillmentType: Delivery
        quantity: 5
        state: SentToBilling
      properties:
        billTargetDate:
          description: >
            The target date for the Fulfillment to be picked up by bill run for
            billing.
          format: date
          type: string
        carrier:
          description: >
            The carrier of the Fulfillment. The available values can be managed
            in the Fulfillment Settings page under Billing Settings.
          type: string
        customFields:
          $ref: '#/components/schemas/FulfillmentCustomFields'
        description:
          description: |
            The description of the Fulfillment.
          type: string
        externalId:
          description: |
            The external id of the Fulfillment.
          type: string
        fulfillmentDate:
          description: |
            The date of the Fulfillment.
          format: date
          type: string
        fulfillmentLocation:
          description: >
            The fulfillment location of the Fulfillment. The available values
            can be managed in the Fulfillment Settings page under Billing
            Settings.
          type: string
        fulfillmentSystem:
          description: >
            The fulfillment system of the Fulfillment. The available values can
            be managed in the Fulfillment Settings page under Billing Settings.
          type: string
        quantity:
          description: |
            The quantity of the Fulfillment.
          type: number
        state:
          description: >
            The state of the Fulfillment. See [Order Line Item states, Order
            states, and state
            transitions](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        trackingNumber:
          description: |
            The tracking number of the Fulfillment.
          type: string
      type: object
    FulfillmentItemPost:
      allOf:
        - properties:
            fulfillmentNumber:
              description: |
                The reference of the related Fulfillment.
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentItemCommon'
    PostFulfillmentItemsRequestType:
      example:
        fulfillmentItems:
          - customFields:
              PICKLIST_CF__c: option_1
            description: description1
            fulfillmentNumber: F-00000001
            itemIdentifier: 0c27b769-5bba-46a5-80aa-cdd95f931216
          - customFields:
              PICKLIST_CF__c: option_2
            description: description2
            fulfillmentNumber: F-00000001
            itemIdentifier: 456d3812-33d2-454c-b272-4c5a9a3e2742
      properties:
        fulfillmentItems:
          items:
            $ref: '#/components/schemas/FulfillmentItemPost'
          type: array
      type: object
    PostFulfillmentItemsResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            fulfillmentItems:
              items:
                properties:
                  id:
                    description: |
                      The sytem generated Id.
                    format: UUID
                    type: string
                type: object
              type: array
          type: object
    FulfillmentItemGet:
      allOf:
        - properties:
            fulfillmentId:
              description: |
                The reference id of the related Fulfillment.
              format: UUID
              type: string
            id:
              description: |
                The sytem generated Id.
              format: UUID
              type: string
          type: object
        - $ref: '#/components/schemas/FulfillmentItemCommon'
    GetFulfillmentItemResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            fulfillmentItem:
              $ref: '#/components/schemas/FulfillmentItemGet'
          type: object
    PutFulfillmentItemRequestType:
      example:
        customFields:
          PICKLIST_CF__c: option_1
        description: description1
        itemIdentifier: 0c27b769-5bba-46a5-80aa-cdd95f931216
      properties:
        customFields:
          $ref: '#/components/schemas/FulfillmentItemCustomFields'
        description:
          description: |
            The description of the Fulfillment Item.
          type: string
        itemIdentifier:
          description: |
            The external identifier of the Fulfillment Item.
          type: string
      type: object
    GETRampByRampNumberResponseType:
      allOf:
        - properties:
            ramp:
              $ref: '#/components/schemas/RampResponse'
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    RampIntervalMetrics:
      properties:
        description:
          description: The short description of the interval.
          type: string
        discountTcb:
          description: The discount amount for the TCB.
          type: number
        discountTcv:
          description: The discount amount for the TCV.
          type: number
        endDate:
          description: The end date of the interval.
          format: date
          type: string
        grossTcb:
          description: The gross TCB value before discount charges are applied.
          type: number
        grossTcv:
          description: The gross TCV value before discount charges are applied.
          type: number
        intervalMetrics:
          description: >-
            Container for the detailed metrics for each rate plan charge in each
            ramp interval.
          items:
            $ref: '#/components/schemas/RampIntervalChargeMetrics'
          type: array
        name:
          description: The name of the interval.
          type: string
        netTcb:
          description: The net TCB value after discount charges are applied.
          type: number
        netTcv:
          description: The net TCV value after discount charges are applied.
          type: number
        startDate:
          description: The start date of the interval.
          format: date
          type: string
      type: object
    RampMetrics:
      properties:
        description:
          description: The short description of the ramp.
          type: string
        discountTcb:
          description: The discount amount for the TCB.
          type: number
        discountTcv:
          description: The discount amount for the TCV.
          type: number
        grossTcb:
          description: The gross TCB value before discount charges are applied.
          type: number
        grossTcv:
          description: The gross TCV value before discount charges are applied.
          type: number
        intervals:
          description: >-
            Container for the intervals that the ramp is split into in its
            timeline.
          items:
            $ref: '#/components/schemas/RampIntervalMetrics'
          type: array
        name:
          description: The name of the ramp.
          type: string
        netTcb:
          description: The net TCB value after discount charges are applied.
          type: number
        netTcv:
          description: The net TCV value after discount charges are applied.
          type: number
        number:
          description: >-
            The number of the ramp. It is automaticcally generated by the
            billing system.
          type: string
      type: object
    GETRampMetricsByRampNumberResponseType:
      allOf:
        - properties:
            rampMetrics:
              $ref: '#/components/schemas/RampMetrics'
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    GETRampsBySubscriptionKeyResponseType:
      allOf:
        - properties:
            ramps:
              items:
                $ref: '#/components/schemas/RampResponse'
              type: array
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    GETRampMetricsBySubscriptionKeyResponseType:
      allOf:
        - properties:
            rampMetrics:
              $ref: '#/components/schemas/RampMetrics'
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    GETRampMetricsByOrderNumberResponseType:
      allOf:
        - properties:
            rampMetrics:
              items:
                $ref: '#/components/schemas/OrderRampMetrics'
              type: array
          type: object
        - $ref: '#/components/schemas/CommonResponse'
    POSTSubscriptionPreviewTypePreviewAccountInfo:
      allOf:
        - properties:
            billCycleDay:
              description: >
                The account's bill cycle day (BCD), when bill runs generate
                invoices for the account. Specify any day of the month
                (`1`-`31`, where `31` = end-of-month), or `0` for auto-set.
              format: int64
              type: integer
            billToContact:
              description: |
                Container for bill-to contact information of this account.
              properties:
                city:
                  description: >
                    The city of the bill-to address. The value should be 40
                    characters or less.
                  type: string
                country:
                  description: >
                    The country of the bill-to address. The value must be a
                    valid country name or abbreviation.


                    **Note:** You must specify this field if you are using Zuora
                    Tax for this account.
                  type: string
                county:
                  description: >
                    The county of the bill-to address. The value should be 32
                    characters or less.
                  type: string
                state:
                  description: >
                    The state of the bill-to address. The value must be a valid
                    subregion (state or province) name or code. For more
                    information, see <a
                    href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
                    target="_blank">View subregions of a specific country or
                    region</a>.


                    **Note:** You must specify this field if you are using Zuora
                    Tax for this account and the country is `USA` or `Canada`.
                  type: string
                taxRegion:
                  description: >
                    If using Zuora Tax, a region string as optionally defined in
                    your tax rules.
                  type: string
                  nullable: true
                zipCode:
                  description: >
                    The zip code of the bill-to address. The value should be 20
                    characters or less.
                  type: string
              type: object
            currency:
              description: |
                A currency as defined in Billing Settings.
              type: string
          required:
            - billCycleDay
            - billToContact
            - currency
          type: object
        - $ref: '#/components/schemas/AccountObjectNSFields'
        - $ref: '#/components/schemas/AccountObjectCustomFields'
      description: >
        A container for providing a customer account information if you do not
        have an existing customer account. This customer account information is
        only used for subscription preview.


        You must specify the account information either in this field or in the
        `accountKey` field with the following conditions:


        * If you already have a customer account, specify the account number or
        ID in the accountKey field.

        * If you do not have a customer account, provide account information in
        this field.
      title: previewAccountInfo
    POSTSubscriptionPreviewType:
      allOf:
        - properties:
            accountKey:
              description: >

                Customer account number or ID.


                You must specify the account information either in this field or
                in the `previewAccountInfo` field with the following conditions:
                         
                * If you already have a customer account, specify the account
                number or ID in this field.

                * If you do not have a customer account, provide account
                information in the `previewAccountInfo` field.
              type: string
            contractEffectiveDate:
              description: |
                Effective contract date for this subscription, as yyyy-mm-dd.
              format: date
              type: string
            customerAcceptanceDate:
              description: >
                The date on which the services or products within a subscription
                have been accepted by the customer, as yyyy-mm-dd.


                Default value is dependent on the value of other fields. See
                **Notes** section for more details.
              format: date
              type: string
            documentDate:
              description: >
                The date of the billing document, in `yyyy-mm-dd` format. It
                represents the invoice date for invoices, credit memo date for
                credit memos, and debit memo date for debit memos.


                - If this field is specified, the specified date is used as the
                billing document date. 

                - If this field is not specified, the date specified in the
                `targetDate` is used as the billing document date.
              format: date
              type: string
            includeExistingDraftDocItems:
              description: >
                Specifies whether to include draft invoice items in subscription
                previews.

                Values are:


                * `true` (default). Includes draft invoice items in the preview
                result.

                * `false`. Excludes draft invoice items in the preview result.

                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `207.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: boolean
            initialTerm:
              description: >
                Duration of the first term of the subscription, in whole months.
                If `termType` is `TERMED`, then this field is required, and the
                value must be greater than `0`. If `termType` is `EVERGREEN`,
                this field is ignored.    
              format: int64
              type: integer
            initialTermPeriodType:
              description: |+
                The period type of the initial term. 

                Supported values are:

                * `Month`
                * `Year`
                * `Day`
                * `Week`
                 
                The default period type is `Month`.

              type: string
            invoiceOwnerAccountKey:
              description: >
                Invoice owner account number or ID.


                **Note:** This feature is in **Limited Availability**. If you
                wish to have access to the feature, submit a request at [Zuora
                Global Support](http://support.zuora.com/).
              type: string
            notes:
              description: The notes for the subscription.
              maxLength: 1000
              type: string
            previewAccountInfo:
              $ref: >-
                #/components/schemas/POSTSubscriptionPreviewTypePreviewAccountInfo
            previewType:
              description: >
                The type of preview you will receive. 


                **Note**: If your API minor version is earlier than `206.0` or
                you specify the `Zuora-Version` header for this request to
                `206.0` or earlier, the following values are supported for the
                `previewType` field:

                    - `InvoiceItem` (default)
                    - `ChargeMetrics`
                    - `InvoiceItemChargeMetrics`
                  
              enum:
                - LegalDoc
                - ChargeMetrics
                - LegalDocChargeMetrics
              type: string
              default: LegalDoc
            serviceActivationDate:
              description: >
                The date on which the services or products within a subscription
                have been activated and access has been provided to the
                customer, as yyyy-mm-dd.


                Default value is dependent on the value of other fields. See
                **Notes** section for more details.
              format: date
              type: string
            subscribeToRatePlans:
              description: |
                Container for one or more rate plans for this subscription.
              items:
                $ref: '#/components/schemas/POSTSrpCreateType'
              type: array
            targetDate:
              description: >
                Date through which to calculate charges if an invoice is
                generated, as yyyy-mm-dd. Default is current date.


                **Note:** This field is only available if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `207.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: date
              type: string
            termStartDate:
              description: >
                The date on which the subscription term begins, as yyyy-mm-dd.
                If this is a renewal subscription, this date is different from
                the subscription start date.
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
          required:
            - termType
            - contractEffectiveDate
            - subscribeToRatePlans
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      example:
        accountKey: 8ad09be48db5aba7018db604776d4854
        contractEffectiveDate: '2024-07-01'
        termType: TERMED
        initialTerm: 12
        subscribeToRatePlans:
          - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4
    POSTSubscriptionPreviewTaxationItemsType:
      properties:
        exemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          type: number
        jurisdiction:
          description: >
            The jurisdiction that applies the tax or VAT. This value is
            typically a state, province, county, or city.
          type: string
        locationCode:
          description: >
            The identifier for the location based on the value of the taxCode
            field.
          type: string
        name:
          description: |
            The name of the taxation item.
          type: string
        taxAmount:
          description: |
            The tax amount of the invoice item.
          format: double
          type: number
        taxCode:
          description: >
            The tax code identifies which tax rules and tax rates to apply to a
            specific invoice.
          type: string
        taxCodeDescription:
          description: |
            The description of the tax code.
          type: string
        taxDate:
          description: |
            The date when the tax is applied to the invoice.
          type: string
        taxRate:
          description: 'The tax rate applied to the invoice. '
          type: number
        taxRateDescription:
          description: |
            The description of the tax rate.
          type: string
        taxRateType:
          description: >
            Enum:"Percentage" "FlatFee". The type of the tax rate applied to the
            invoice.
          enum:
            - Percentage
            - FlatFee
          type: string
      title: taxationItems
      type: object
    POSTSubscriptionPreviewCreditMemoItemsType:
      properties:
        amountWithoutTax:
          description: |
            The credit memo item amount excluding tax.
          format: double
          type: number
        chargeAmount:
          description: >
            The amount of the credit memo item. For tax-inclusive credit memo
            items, the amount indicates the credit memo item amount including
            tax. For tax-exclusive credit memo items, the amount indicates the
            credit memo item amount excluding tax
          format: double
          type: number
        chargeDescription:
          description: |
            Description of this credit memo item.
          type: string
        chargeName:
          description: |
            Name of this credit memo item.
          type: string
        productName:
          description: |
            Name of the product associated with this credit memo item.
          type: string
        productRatePlanChargeId:
          description: >
            ID of the product rate plan charge associated with this credit memo
            item.
          type: string
        quantity:
          description: |
            Quantity of the charge associated with this credit memo item.
          type: integer
        serviceEndDate:
          description: >
            End date of the service period for this credit memo item, as
            yyyy-mm-dd.
          format: date
          type: string
        serviceStartDate:
          description: |
            Service start date of this credit memo item, as yyyy-mm-dd.
          format: date
          type: string
        taxAmount:
          description: |
            The tax amount of the credit memo item.
          format: double
          type: number
        taxationItems:
          description: >-
            List of taxation items.

            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `315.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          items:
            $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType'
          type: array
        unitOfMeasure:
          description: Unit used to measure consumption.
          type: string
      title: creditMemoItems
      type: object
    POSTSubscriptionPreviewInvoiceItemsType:
      properties:
        chargeAmount:
          description: >
            The amount of the charge. This amount doesn't include taxes unless
            the charge's tax mode is inclusive.
          type: number
        chargeDescription:
          description: |
            Description of the charge.
          type: string
        chargeName:
          description: |
            Name of the charge.
          type: string
        productName:
          description: |
            Name of the product associated with this item.
          type: string
        productRatePlanChargeId:
          description: |
            ID of the product rate plan charge.
          type: string
        quantity:
          description: |
            Quantity of this item.
          type: number
        serviceEndDate:
          description: >
            End date of the service period for this item, i.e., the last day of
            the period, as yyyy-mm-dd.
          format: date
          type: string
        serviceStartDate:
          description: >
            Service start date as yyyy-mm-dd. If the charge is a one-time fee,
            this is the date of that charge.
          format: date
          type: string
        taxAmount:
          description: |
            The tax amount of the invoice item.
          format: double
          type: number
        taxationItems:
          description: >-
            List of taxation items.

            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `315.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          items:
            $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType'
          type: array
        unitOfMeasure:
          description: ''
          type: string
      title: invoiceItems
      type: object
    POSTSubscriptionPreviewResponseType:
      properties:
        chargeMetrics:
          description: |
            Container for charge metrics.
          properties:
            dmrr:
              description: |
                Change in monthly recurring revenue.
              type: string
            dtcv:
              description: |
                Change in total contract value.
              type: string
            mrr:
              description: |
                Monthly recurring revenue.
              type: string
            number:
              description: >
                The charge number of the subscription. Only available for update
                subscription.
              type: string
            originRatePlanId:
              description: |
                The origin rate plan ID. Only available for update subscription.
              type: string
            originalId:
              description: >
                The original rate plan charge ID. Only available for update
                subscription.
              type: string
            productRatePlanChargeId:
              description: |
                The product rate plan charge ID.
              type: string
            productRatePlanId:
              description: |
                The product rate plan ID.
              type: string
            tcv:
              description: |
                Total contract value.
              type: string
          type: object
        contractedMrr:
          description: |
            Monthly recurring revenue of the subscription.
          type: number
        creditMemo:
          description: >

            Container for credit memos.


            **Note:** This container is only available if you are on the latest
            Zuora API version or you set the `Zuora-Version` request header to
            `207.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version), 
            and you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information. 
          properties:
            amount:
              description: Credit memo amount.
              format: double
              type: number
            amountWithoutTax:
              description: Credit memo amount minus tax.
              format: double
              type: number
            creditMemoItems:
              description: ''
              items:
                $ref: >-
                  #/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType
              type: array
            taxAmount:
              description: Tax amount on the credit memo.
              format: double
              type: number
          type: object
        documentDate:
          description: >
            The date of the billing document, in `yyyy-mm-dd` format. It
            represents the invoice date for invoices, credit memo date for
            credit memos, and debit memo date for debit memos.


            - If this field is specified, the specified date is used as the
            billing document date. 

            - If this field is not specified, the date specified in the
            `targetDate` is used as the billing document date.
          format: date
          type: string
        invoice:
          description: >
            Container for invoices.



            **Note:** This field is only available if you set the Zuora REST API
            minor version to `207.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version)
            in the request header. Also, the response structure is changed and
            the following invoice related response fields are moved to this
            **invoice** container:
              
               * amount
               * amountWithoutTax
               * taxAmount
               * invoiceItems
          properties:
            amount:
              description: Invoice amount.
              type: number
            amountWithoutTax:
              description: |
                Invoice amount minus tax.
              type: number
            invoiceItems:
              description: |
                Container for invoice items.
              items:
                $ref: '#/components/schemas/POSTSubscriptionPreviewInvoiceItemsType'
              type: array
            targetDate:
              description: >
                Date through which to calculate charges if an invoice is
                generated, as yyyy-mm-dd. Default is current date.


                **Note:** This field is only available if you set the Zuora REST
                API minor version to 207.0 or later [available
                versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
                in the request header.
              type: string
            taxAmount:
              description: |
                The tax amount of the invoice.
              type: number
          type: object
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        targetDate:
          description: >
            Date through which to calculate charges if an invoice is generated,
            as yyyy-mm-dd. Default is current date.


            **Note:** This field is only available if you set the Zuora REST API
            minor version to `207.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version)
            in the request header.
          format: date
          type: string
        taxAmount:
          description: |
            Tax amount on the invoice.
          type: number
        totalContractedValue:
          description: |
            Total contracted value of the subscription.
          type: number
      type: object
    PreviewStartDatePolicy:
      description: >
        The options on how the preview start date is calculated.

        - If you set this field to `startOfTerm`, the preview start date is the
        start date of the subscription term.   

        - If you set this field to `today`, the preview start date is today.

        - If you set this field to `specificDate`, you must specify a specific
        date in the `specificDate` field. The date must be in the format
        `yyyy-mm-dd`.
      enum:
        - startOfTerm
        - today
        - specificDate
      type: string
    PreviewStartDate:
      description: |
        The start date of the preview.
      properties:
        previewStartDatePolicy:
          $ref: '#/components/schemas/PreviewStartDatePolicy'
        specificDate:
          description: >
            The specific date for the preview start date. Required if
            `previewStartDatePolicy` is `specificDate`.
          type: string
      type: object
    PreviewThruDatePolicy:
      description: >
        The options on how the preview through date is calculated. 

        - If you set this field to `nextBillingPeriods`, you must specify the
        number of billing periods to preview in the `nextBillingPeriods` field.

        - If you set this field to `endOfTerm`, the preview through date is the
        end date of the subscription term.

        - If you set this field to `specificDate`, you must specify a specific
        date in the `specificDate` field. The date must be in the format
        `yyyy-mm-dd`.
      enum:
        - nextBillingPeriods
        - endOfTerm
        - specificDate
      type: string
    PreviewThroughDate:
      description: |
        The preview through date.
      properties:
        previewThruDatePolicy:
          $ref: '#/components/schemas/PreviewThruDatePolicy'
        nextBillingPeriods:
          description: >
            The number of billing periods to preview. Required if
            `previewThruDatePolicy` is `nextBillingPeriods`.
          type: number
        specificDate:
          description: >
            The specific date for the preview start date. Required if
            `previewThruDatePolicy` is `specificDate`.
          type: string
      type: object
    QuantityForUsageCharges:
      allOf:
        - properties:
            chargeId:
              description: |
                The ID of the subscription charge.
              type: string
            quantity:
              description: |
                The quantity of the subscription charge.
              type: number
          type: object
    PreviewExistingSubscriptionRequest:
      description: |
        Preview the existing subscription by subscription ID or number.
      properties:
        previewStartDate:
          $ref: '#/components/schemas/PreviewStartDate'
        previewThroughDate:
          $ref: '#/components/schemas/PreviewThroughDate'
        quantityForUsageCharges:
          items:
            $ref: '#/components/schemas/QuantityForUsageCharges'
          type: array
          description: |
            Container for usage charges.
      type: object
      example:
        previewStartDate:
          previewStartDatePolicy: specificDate
          specificDate: '2024-01-01'
        previewThroughDate:
          previewThruDatePolicy: nextBillingPeriods
          nextBillingPeriods: '2'
        quantityForUsageCharges:
          - chargeId: 402880e78ccd1743018cce026efb002d
            quantity: 20
    PreviewExistingSubscriptionDiscountDetails:
      properties:
        discountChargeName:
          type: string
          description: The charge name of the discount.
        discountChargeNumber:
          type: string
          description: The charge number of the discount.
        discountRate:
          type: number
          description: The discount rate.
        serviceStartDate:
          format: date
          type: string
          description: Start date of the service period for this discount charge.
        serviceEndDate:
          format: date
          type: string
          description: End date of the service period for this discount charge.
      type: object
    PreviewExistingSubscriptionInvoiceItemResult:
      properties:
        serviceStartDate:
          format: date
          type: string
          description: >-
            Service start date as yyyy-mm-dd. If the charge is a one-time fee,
            this is the date of that charge.
        serviceEndDate:
          format: date
          type: string
          description: >-
            End date of the service period for this item, i.e., the last day of
            the period, as yyyy-mm-dd.
        amountWithoutTax:
          type: number
          description: Invoice amount minus tax.
          format: double
        taxAmount:
          type: number
          description: The tax amount of the invoice item.
          format: double
        chargeDescription:
          type: string
          description: Description of the charge.
        chargeName:
          type: string
          description: Name of the charge.
        chargeNumber:
          description: >-
            Available when the `chargeNumber` field was specified in the request
            or when the order is amending an existing subscription.
          type: string
        productName:
          type: string
          description: Name of the product.
        productRatePlanChargeId:
          type: string
          description: The ID of the product rate plan charge.
        processingType:
          type: string
          description: The processing type of the invoice item.
          enum:
            - Charge
            - Discount
            - Tax
        unitPrice:
          type: number
          description: The unit price of the charge.
          format: double
        quantity:
          type: number
          description: The quantity of the charge.
        unitOfMeasure:
          type: string
          description: The unit of measure of the charge.
          nullable: true
        discountDetails:
          items:
            $ref: '#/components/schemas/PreviewExistingSubscriptionDiscountDetails'
          type: array
          description: Container for discount details.
      type: object
    PreviewExistingSubscriptionResultInvoices:
      properties:
        invoiceNumber:
          type: string
          description: |
            The invoice number.
        amount:
          type: number
          description: |
            Invoice amount.
          format: double
        amountWithoutTax:
          type: number
          description: |
            Invoice amount minus tax.
          format: double
        taxAmount:
          type: number
          description: |
            The tax amount of the invoice.
          format: double
        targetDate:
          format: date
          type: string
          description: >
            Date through which to calculate charges if an invoice is generated,
            as yyyy-mm-dd.
        invoiceItems:
          items:
            $ref: '#/components/schemas/PreviewExistingSubscriptionInvoiceItemResult'
          type: array
          description: |
            The container for invoice items.
        status:
          type: string
          description: |
            The status of the invoice.
          enum:
            - Draft
            - Posted
            - null
          nullable: true
        isFromExistingInvoice:
          type: boolean
          description: >
            Indicates whether the invoice information is from an existing
            invoice.
      type: object
    PreviewExistingSubscriptionCreditMemoItemResult:
      properties:
        serviceStartDate:
          format: date
          type: string
          description: >-
            Service start date as yyyy-mm-dd. If the charge is a one-time fee,
            this is the date of that charge.
        serviceEndDate:
          format: date
          type: string
          description: >-
            End date of the service period for this item, i.e., the last day of
            the period, as yyyy-mm-dd.
        amountWithoutTax:
          type: number
          description: Credit memo amount minus tax.
          format: double
        taxAmount:
          type: number
          description: The tax amount of the credit memo item.
          format: double
        chargeDescription:
          type: string
          description: Description of the charge.
        chargeName:
          type: string
          description: Name of the charge.
        chargeNumber:
          description: >-
            Available when the `chargeNumber` field was specified in the request
            or when the order is amending an existing subscription.
          type: string
        productName:
          type: string
          description: Name of the product.
        productRatePlanChargeId:
          type: string
          description: The ID of the product rate plan charge.
        processingType:
          type: string
          description: The processing type of the credit memo item.
          enum:
            - Charge
            - Discount
            - Tax
        unitPrice:
          type: number
          description: The unit price of the charge.
          format: double
        quantity:
          type: number
          description: The quantity of the charge.
        unitOfMeasure:
          type: string
          description: The unit of measure of the charge.
          nullable: true
        discountDetails:
          items:
            $ref: '#/components/schemas/PreviewExistingSubscriptionDiscountDetails'
          type: array
          description: Container for discount details.
      type: object
    PreviewExistingSubscriptionResultCreditMemos:
      properties:
        creditMemoNumber:
          type: string
          description: The credit memo number.
        amount:
          type: number
          description: Credit memo amount.
          format: double
        amountWithoutTax:
          type: number
          description: Credit memo amount minus tax.
          format: double
        taxAmount:
          type: number
          description: The tax amount of the credit memo.
          format: double
        targetDate:
          format: date
          type: string
          description: >-
            Date through which to calculate charges if a credit memo is
            generated, as yyyy-mm-dd.
        creditMemoItems:
          items:
            $ref: >-
              #/components/schemas/PreviewExistingSubscriptionCreditMemoItemResult
          type: array
          description: Container for credit memo items.
        status:
          type: string
          description: The status of the credit memo.
          nullable: true
        isFromExistingCreditMemo:
          type: boolean
          description: >-
            Indicates whether the credit memo information is from an existing
            credit memo.
      type: object
    PreviewExistingSubscriptionResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            invoices:
              description: Container for invoices.
              items:
                $ref: '#/components/schemas/PreviewExistingSubscriptionResultInvoices'
              type: array
            creditMemos:
              description: >
                Container for credit memos.


                **Note**: This field is only available if you have the Invoice
                Settlement feature enabled.
              items:
                $ref: >-
                  #/components/schemas/PreviewExistingSubscriptionResultCreditMemos
              type: array
          type: object
    POSTSubscriptionType:
      allOf:
        - properties:
            accountKey:
              description: |
                Customer account number or ID
              type: string
            applicationOrder:
              description: >
                The priority order to apply credit memos and/or unapplied
                payments to an invoice. Possible item values are: `CreditMemo`,
                `UnappliedPayment`.


                **Note:**
                  - This field is valid only if the `applyCredit` field is set to `true`.
                  - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
                  - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
              items:
                type: string
              type: array
            applyCredit:
              description: >
                If the value is true, the credit memo or unapplied payment on
                the order account will be automatically applied to the invoices
                generated by this order. The credit memo generated by this order
                will not be automatically applied to any invoices.



                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.
              type: boolean
            applyCreditBalance:
              description: >
                Whether to automatically apply a credit balance to an invoice.


                If the value is `true`, the credit balance is applied to the
                invoice. If the value is `false`, no action is taken.



                To view the credit balance adjustment, retrieve the details of
                the invoice using the Get Invoices method.


                Prerequisite: `invoice` must be `true`. 


                **Note:** 
                  - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.
                  - This field is deprecated if you have the Invoice Settlement feature enabled.
              type: boolean
            autoRenew:
              default: false
              description: >
                If true, this subscription automatically renews at the end of
                the subscription term.


                This field is only required if the `termType` field is set to
                `TERMED`.
              type: boolean
            collect:
              default: true
              description: >
                Collects an automatic payment for a subscription. The collection
                generated in this operation is only for this subscription, not
                for the entire customer account.


                If the value is `true`, the automatic payment is collected. If
                the value is `false`, no action is taken.


                Prerequisite: The `invoice` or `runBilling` field must be
                `true`. 


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `196.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: boolean
            contractEffectiveDate:
              description: |
                Effective contract date for this subscription, as yyyy-mm-dd
              format: date
              type: string
            creditMemoReasonCode:
              description: >-
                A code identifying the reason for the credit memo transaction
                that is generated by the request. The value must be an existing
                reason code. If you do not pass the field or pass the field with
                empty value, Zuora uses the default reason code.
              type: string
            customerAcceptanceDate:
              description: >
                The date on which the services or products within a subscription
                have been accepted by the customer, as yyyy-mm-dd.


                Default value is dependent on the value of other fields. See
                **Notes** section for more details.
              format: date
              type: string
            documentDate:
              description: >
                The date of the billing document, in `yyyy-mm-dd` format. It
                represents the invoice date for invoices, credit memo date for
                credit memos, and debit memo date for debit memos.


                - If this field is specified, the specified date is used as the
                billing document date. 

                - If this field is not specified, the date specified in the
                `targetDate` is used as the billing document date.
              format: date
              type: string
            externallyManagedBy:
              description: >
                An enum field on the Subscription object to indicate the name of
                a third-party store. This field is used to represent
                subscriptions created through third-party stores.
              enum:
                - Amazon
                - Apple
                - Google
                - Roku
              type: string
            gatewayId:
              description: >
                The ID of the payment gateway instance. For example,
                `2c92c0f86078c4d5016091674bcc3e92`.


                If <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
                target="_blank">Payment Gateway Routing</a> is enabled: 
                  - If this field is not specified, gateway routing rules will be invoked.
                  - If this field is specified, the specified gateway will be used to process the payment.

                If Payment Gateway Routing is disabled:
                  - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. 
                  - If this field is specified, the specified gateway will be used to process the payment.
              type: string
            initialTerm:
              description: >
                The length of the period for the first subscription term. If
                `termType` is `TERMED`, then this field is required, and the
                value must be greater than `0`. If `termType` is `EVERGREEN`,
                this field is ignored.
              format: int64
              type: integer
            initialTermPeriodType:
              description: >
                The period type for the first subscription term.


                This field is used with the `InitialTerm` field to specify the
                initial subscription term.


                Values are:


                * `Month` (default)

                * `Year`

                * `Day`

                * `Week`
              type: string
            invoiceOwnerAccountKey:
              description: >
                Invoice owner account number or ID.


                **Note:** This feature is in **Limited Availability**. If you
                wish to have access to the feature, submit a request at [Zuora
                Global Support](http://support.zuora.com/).
              type: string
            invoiceSeparately:
              description: >
                Separates a single subscription from other subscriptions and
                invoices the charge independently. 


                If the value is `true`, the subscription is billed separately
                from other subscriptions. If the value is `false`, the
                subscription is included with other subscriptions in the account
                invoice.


                The default value is `false`.


                Prerequisite: The default subscription setting Enable
                Subscriptions to be Invoiced Separately must be set to Yes.
              type: boolean
            lastBookingDate:
              description: >-
                The last booking date of the subscription object. This field is
                writable only when the subscription is newly created as a first
                version subscription. You can override the date value when
                creating a subscription through the Subscribe and Amend API or
                the subscription creation UI (non-Orders). Otherwise, the
                default value `today` is set per the user's timezone. The value
                of this field is as follows:

                * For a new subscription created by the [Subscribe and Amend
                APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),
                this field has the value of the subscription creation date.

                * For a subscription changed by an amendment, this field has the
                value of the amendment booking date.

                * For a subscription created or changed by an order, this field
                has the value of the order date. 
              format: date
              type: string
            notes:
              description: |
                The notes for the subscription.
              maxLength: 1000
              type: string
            paymentMethodId:
              description: |
                The ID of the payment method used for the payment.
              type: string
            prepayment:
              description: >
                Indicates whether the subscription will consume the reserved
                payment amount of the customer account. 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
            renewalSetting:
              description: >
                Specifies whether a termed subscription will remain termed or
                change to evergreen when it is renewed.


                Values:


                * `RENEW_WITH_SPECIFIC_TERM` (default)

                * `RENEW_TO_EVERGREEN`
              type: string
            renewalTerm:
              description: >
                The length of the period for the subscription renewal term.
                Default is `0`.
              format: int64
              type: integer
            renewalTermPeriodType:
              description: >
                The period type for the subscription renewal term.


                This field is used with the `renewalTerm` field to specify the
                subscription renewal term.


                Values are:


                * `Month` (default)

                * `Year`

                * `Day`

                * `Week`
              type: string
            runBilling:
              default: true
              description: >
                Creates an invoice for a subscription. If you have the Invoice
                Settlement feature enabled, a credit memo might also be created
                based on the [invoice and credit memo generation
                rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).  



                The billing documents generated

                in this operation is only for this subscription, not for the
                entire

                customer account.

                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `211.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).


                Possible values:


                - `true`: An invoice is created. If you have the Invoice
                Settlement feature enabled, a credit memo might also be created.


                - `false`: No invoice is created.
              type: boolean
            serviceActivationDate:
              description: >
                The date on which the services or products within a subscription
                have been activated and access has been provided to the
                customer, as yyyy-mm-dd.


                Default value is dependent on the value of other fields. See
                **Notes** section for more details.
              format: date
              type: string
            subscribeToRatePlans:
              description: |
                Container for one or more rate plans for this subscription.
              items:
                $ref: '#/components/schemas/POSTSrpCreateType'
              type: array
            subscriptionNumber:
              description: >
                Subscription Number. The value can be up to 1000 characters.


                If you do not specify a subscription number when creating a
                subscription, Zuora will generate a subscription number
                automatically.


                If the account is created successfully, the subscription number
                is returned in the `subscriptionNumber` response field.
              type: string
            targetDate:
              description: >
                Date through which to calculate charges if an invoice or a
                credit memo is generated, as

                yyyy-mm-dd. Default is current date.


                **Note**:  - This field is available only if you are on the
                latest Zuora API minor version, or you set the `Zuora-Version`
                request header to `211.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).


                - The credit memo is only available if you have the Invoice
                Settlement feature enabled.
              format: date
              type: string
            termStartDate:
              description: >
                The date on which the subscription term begins, as yyyy-mm-dd.
                If this is a renewal subscription, this date is different from
                the subscription start date.
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
          required:
            - accountKey
            - contractEffectiveDate
            - subscribeToRatePlans
            - termType
            - renewalTerm
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectQTFields'
        - $ref: '#/components/schemas/SubscriptionObjectNSFields'
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      example:
        accountKey: 8ad09be48db5aba7018db604776d4854
        contractEffectiveDate: '2024-07-16'
        termType: TERMED
        initialTerm: 12
        renewalTerm: 12
        autoRenew: true
        subscribeToRatePlans:
          - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4
    POSTSubscriptionResponseType:
      properties:
        contractedMrr:
          description: |
            Monthly recurring revenue of the subscription.
          type: number
        creditMemoId:
          description: >
            The credit memo ID, if a credit memo is generated during the
            subscription process.


            **Note:** This container is only available if you set the Zuora REST
            API minor version to 207.0 or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            in the request header, and you have  [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        invoiceId:
          description: >
            Invoice ID, if an invoice is generated during the subscription
            process.
          type: string
        paidAmount:
          description: |
            Payment amount, if a payment is collected.
          type: number
        paymentId:
          description: |
            Payment ID, if a payment is collected.
          type: string
        subscriptionId:
          description: ''
          type: string
        subscriptionNumber:
          description: ''
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        totalContractedValue:
          description: |
            Total contracted value of the subscription.
          type: number
      type: object
    Currency:
      type: string
      description: Currency used by the account. For example, `USD` or `EUR`.
    GETDeliveryScheduleType:
      description: >
        The `deliverySchedule` is used for the Delivery Pricing charge model
        only. 


        **Note**: The Delivery Pricing charge model is in the **Early Adopter**
        phase. We are actively soliciting feedback from a small set of early
        adopters before releasing it as generally available. To manage and
        access this feature through the self-service interface, see [Enable
        billing features by
        yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
        in the Knowledge Center. You can check **Delivery Pricing** in **Billing
        Settings** > **Enable Charge Types / Models**.
      properties:
        frequency:
          description: |
            Specifies delivery frequency for the delivery schedule.
          enum:
            - Weekly
          type: string
        friday:
          description: |
            Indicates whether delivery occurs on Friday.
          type: boolean
        monday:
          description: |
            Indicates whether delivery occurs on Monday.
          type: boolean
        saturday:
          description: |
            Indicates whether delivery occurs on Saturday.
          type: boolean
        sunday:
          description: |
            Indicates whether delivery occurs on Sunday.
          type: boolean
        thursday:
          description: |
            Indicates whether delivery occurs on Thursday.
          type: boolean
        tuesday:
          description: |
            Indicates whether delivery occurs on Tuesday.
          type: boolean
        wednesday:
          description: |
            Indicates whether delivery occurs on Wednesday.
          type: boolean
      title: deliverySchedule
      type: object
    DiscountApplyDetails:
      properties:
        appliedProductName:
          description: >
            The name of the product that the discount rate plan charge applies
            to.
          type: string
        appliedProductRatePlanChargeId:
          description: >
            The ID of the product rate plan charge that the discount rate plan
            charge applies to.
          type: string
        appliedProductRatePlanChargeName:
          description: >
            The name of the product rate plan charge that the discount rate plan
            charge applies to.
          type: string
        appliedProductRatePlanId:
          description: >
            The ID of the product rate plan that the discount rate plan charge
            applies to.
          type: string
        appliedProductRatePlanName:
          description: >
            The name of the product rate plan that the discount rate plan charge
            applies to.
          type: string
      title: discountApplyDetails
      type: object
    DiscountLevel:
      type: string
      enum:
        - rateplan
        - subscription
        - account
      description: >
        The level of the discount. 
         
        For example, if the value of this field is `subscription` and the value
        of the `applyDiscountTo` field is `RECURRING`, the discount charge
        applies to all recurring charges in the same subscription as the
        discount charge.
    Uom:
      description: Specifies the units to measure usage.
      type: string
    EndDateCondition:
      description: >
        Condition for the charge to become inactive.


        If the value of this field is `Fixed_Period`, the charge is active for a
        predefined duration based on the value of the `upToPeriodsType` and
        `upToPeriods` fields.


        If the value of this field is `Specific_End_Date`, use the
        `specificEndDate` field to specify the date when then charge becomes
        inactive.
      type: string
      enum:
        - Subscription_End
        - Fixed_Period
        - Specific_End_Date
        - One_Time
    PriceChangeOption:
      type: string
      description: |
        Applies an automatic price change when a termed subscription is renewed.
      enum:
        - NoChange
        - SpecificPercentageValue
        - UseLatestProductCatalogPricing
        - null
      default: NoChange
      nullable: true
    GETIntervalPriceTierType:
      properties:
        endingUnit:
          description: |
            Decimal defining end of tier range.
          type: number
        isOveragePrice:
          description: |
            True if the price is overage price for the tier.
          type: boolean
        price:
          description: >
            The decimal value of the tiered charge model. If the charge model is
            not a tiered type then this price field will be null and the `price`
            field directly under the `productRatePlanCharges` applies.
          type: number
        priceFormat:
          description: |
            Tier price format. Allowed values: `flat fee`, `per unit`.
          type: string
        startingUnit:
          description: |
            Decimal defining start of tier range.
          type: number
        tier:
          description: |
            Unique number of the tier.
          format: int64
          type: integer
      title: IntervalPricing
      type: object
    GETIntervalPriceType:
      properties:
        duration:
          description: |
            Duration period of this interval.
          type: integer
        price:
          description: |
            Price of this interval.
          type: number
        sequence:
          description: >
            A system-generated number that indicates the sequence in which each
            interval price is billed.
          type: integer
        subscriptionChargeIntervalPriceTiers:
          items:
            $ref: '#/components/schemas/GETIntervalPriceTierType'
          type: array
        type:
          description: |
            Interval type of this pricing.
          enum:
            - Day
            - Month
            - Infinity
          type: string
      title: IntervalPricing
      type: object
    RatePlanChargeTier:
      type: object
      title: chargeTier
      properties:
        tier:
          description: |
            Unique number of the tier.
          format: int64
          type: integer
          minimum: 1
        startingUnit:
          description: |
            Decimal defining start of tier range.
          type: number
          format: double
        endingUnit:
          description: |
            Decimal defining end of tier range.
          type: number
          format: double
        price:
          description: >
            The decimal value of the tiered charge model. If the charge model is
            not a tiered type then this price field will be null and the `price`
            field directly under the `productRatePlanCharges` applies.
          type: number
        priceFormat:
          description: |
            Tier price format. 
          type: string
          enum:
            - FlatFee
            - PerUnit
        originalListPrice:
          type: number
          format: double
          description: >
            The original list price is the price of a product or service at
            which it is listed for sale by a manufacturer or retailer.
    BillingPeriodAlignment:
      description: >
        Specifies how Zuora determines when to start new billing periods. You

        can use this field to align the billing periods of different charges.



        * `AlignToCharge` - Zuora starts a new billing period on the first
        billing day that

        falls on or after the date when the charge becomes active.


        * `AlignToSubscriptionStart` - Zuora starts a new billing period on the
        first billing

        day that falls on or after the start date of the subscription.


        * `AlignToTermStart` - For each term of the subscription, Zuora starts a
        new billing

        period on the first billing day that falls on or after the start date of
        the term.



        See the `billCycleType` field for information about how Zuora determines
        the billing

        day.


        **Note:** `AlignToTermEnd` is only available for prepayment charges by
        default.

        To enable this value for non-prepaid recurring charges, contact <a
        href="http://support.zuora.com/"

        target="_blank">Zuora Global Support</a>.
      enum:
        - AlignToCharge
        - AlignToSubscriptionStart
        - AlignToTermStart
        - AlignToTermEnd
      type: string
    TriggerEvent:
      description: >
        Condition for the charge to become active. If this field is not
        specified,

        the value of the field will be defaulted to the trigger event value
        defined in the

        product catalog.



        If the value of this field is `SpecificDate`, use the
        `specificTriggerDate` field

        to specify the date when the charge becomes active.
      type: string
      enum:
        - ContractEffective
        - ServiceActivation
        - CustomerAcceptance
        - SpecificDate
    UpToPeriodsType:
      description: |
        Unit of time that the charge duration is measured in. Only applicable
        if the value of the `endDateCondition` field is `Fixed_Period`.
      type: string
      enum:
        - Days
        - Weeks
        - Months
        - Years
        - Billing_Periods
        - null
      nullable: true
    ValidityPeriodType:
      description: >
        **Note**: This field is only available if you have the 

        <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
        target="_blank">Prepaid with Drawdown</a>

        feature enabled.



        The period in which the prepayment units are valid to use as defined in
        a <a
        href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge"
        target="_blank">prepayment

        charge</a>.
      type: string
      enum:
        - SUBSCRIPTION_TERM
        - ANNUAL
        - SEMI_ANNUAL
        - QUARTER
        - MONTH
        - null
      nullable: true
    RatePlanChargeSegment:
      type: object
      title: ratePlanChargeSegment
      properties:
        id:
          type: string
          description: |
            ID of the charge.
        amendedByOrderOn:
          description: >
            The date when the rate plan charge is amended through an order or
            amendment. This field is to standardize the booking date information
            to increase audit ability and traceability of data between Zuora
            Billing and Zuora Revenue. It is mapped as the booking date for a
            sale order line in Zuora Revenue.
          format: date
          type: string
        applyDiscountTo:
          type: string
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          description: >
            Specifies the type of charges a specific discount applies to. 


            This field is only used when applied to a discount charge model. If
            you are not using a discount charge model, the value is `null`.
          nullable: true
        chargeFunction:
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a> feature enabled.


            Define what type of charge it is in Advanced consumption billing: *
            `Standard`: Normal charge with no Prepayment or Commitment or
            Drawdown. * `Prepayment`: For recurring charges. Unit or currency
            based prepaid charge. * `CommitmentTrueUp`: For recurring charges.
            Currency based minimum commitment charge. * `Drawdown`: For usage
            charges. Drawdown from prepaid funds. *
            `DrawdownAndCreditCommitment`: For usage charges. Drawdown from
            prepaid funds and then credit to minimum commitment funds. *
            `CreditCommitment`: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - Standard
            - Prepayment
            - CommitmentTrueUp
            - Drawdown
            - CreditCommitment
            - DrawdownAndCreditCommitment
          type: string
        chargeModelConfiguration:
          $ref: '#/components/schemas/ChargeModelConfigurationType'
        chargedThroughDate:
          description: |
            The date through which a customer has been billed for the charge.
          format: date
          type: string
        commitmentType:
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a>

            feature enabled.



            The type of commitment. A prepaid charge can be `UNIT` or
            `CURRENCY`. And a min commitment(in-arrears) charge can only be
            CURRENCY type.

            For topup(recurring/one-time) charges, this field indicates what
            type of funds are created. 


            * If `UNIT`, it will create a fund with given prepaidUom.


            * If `CURRENCY`, it will create a fund with the currency amount
            calculated in list price.


            For drawdown(usage) charges, this field indicates what type of funds
            are drawdown from that created from topup charges.
          enum:
            - UNIT
            - CURRENCY
          type: string
        prepaidCommittedAmount:
          type: string
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> enabled.


            The amount of the prepaid committed amount.
          nullable: true
        creditOption:
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>
             feature enabled. \nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs.
             
             The way to calculate credit. See <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option" target="_blank">Credit Option</a> for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
            - null
          type: string
          nullable: true
        currency:
          $ref: '#/components/schemas/Currency'
        deliverySchedule:
          $ref: '#/components/schemas/GETDeliveryScheduleType'
        numberOfDeliveries:
          type: number
          description: |
            The number of the deliveries.
          nullable: true
        description:
          description: Description of the rate plan charge segment.
          type: string
        discountAmount:
          description: The amount of the discount.
          type: number
          nullable: true
        discountApplyDetails:
          description: >
            Container for the application details about a discount rate plan
            charge. 


            Only discount rate plan charges have values in this field.
          items:
            $ref: '#/components/schemas/DiscountApplyDetails'
          type: array
          nullable: true
        discountClass:
          description: >
            The class that the discount belongs to. The discount class defines

            the order in which discount rate plan charges are applied.



            For more information, see <a
            href="https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes"
            target="_blank">Manage Discount Classes</a>.
          type: string
          nullable: true
        discountLevel:
          $ref: '#/components/schemas/DiscountLevel'
        discountPercentage:
          description: |
            The amount of the discount as a percentage.
          type: number
          nullable: true
        applyToBillingPeriodPartially:
          type: boolean
          description: >
            A value of `true` indicates that the charge segment is applied to a
            billing period

            partially. The value of this field is `false` by default.
          default: false
        dmrc:
          description: >
            The change (delta) of monthly recurring charge exists when the
            change

            in monthly recurring revenue caused by an amendment or a new
            subscription.
          type: number
          format: double
        done:
          description: >
            A value of `true` indicates that an invoice for a charge segment

            has been completed. A value of `false` indicates that an invoice has
            not been

            completed for the charge segment.
          type: boolean
        drawdownRate:
          type: number
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            feature enabled.



            The <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion"
            target="_blank">conversion rate</a>

            between Usage UOM and Drawdown UOM for a <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge"
            target="_blank">drawdown charge</a>.

            Must be a positive number (>0).
        drawdownUom:
          $ref: '#/components/schemas/Uom'
        dtcv:
          description: >
            After an amendment or an AutomatedPriceChange event, `dtcv` displays
            the change (delta) for the total contract value (TCV) amount for
            this charge, compared with its previous value with recurring charge
            types.
          type: number
          format: double
        effectiveEndDate:
          format: date
          type: string
          description: |
            The effective end date of the charge.
        effectiveStartDate:
          format: date
          type: string
          description: |
            The effective start date of the charge.
        endDateCondition:
          $ref: '#/components/schemas/EndDateCondition'
        includedUnits:
          type: number
          description: |
            The number of units included in this charge segment.
        inputArgumentId:
          type: string
          description: |
            The ID of the input argument for the charge segment.
        isCommitted:
          type: boolean
          description: |
            Indicates if the charge segment is committed.
        isPrepaid:
          type: boolean
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            feature enabled.


            Indicates whether this charge is a prepayment (topup) charge or a
            drawdown charge. 
        isRollover:
          type: boolean
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            feature enabled.



            It determines whether the rollover fields are needed.
        mrr:
          type: number
          format: double
          description: >
            Monthly recurring revenue (MRR) is the amount of recurring

            charges in a given month. The MRR calculation doesn't include
            one-time

            charges nor usage charges. 
        originalOrderDate:
          format: date
          type: string
          description: |
            The date when the rate plan charge is created through an order or
            amendment. This field is to standardize the booking date information
            to increase audit ability and traceability of data between Zuora
            Billing and Zuora Revenue. It is mapped as the booking date for a
            sales order line in Zuora Revenue.
        overagePrice:
          type: number
          description: >
            Price for units over the allowed amount. 


            Available for the usage-based charge type for the Overage and Tiered
            with Overage charge models.
        prepaidOperationType:
          enum:
            - topup
            - drawdown
          type: string
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            feature enabled.


            The type of this charge. It is either a prepayment (topup) charge or
            a

            drawdown charge. 
        prepaidQuantity:
          type: number
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>

            feature enabled.


            The number of units included in a <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge"
            target="_blank">prepayment charge</a>.
        prepaidTotalQuantity:
          type: number
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> feature enabled.


            The total amount of units that end customers can use during a
            validity period when they subscribe to a <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge"
            target="_blank">prepayment charge</a>.
        prepaidUOM:
          $ref: '#/components/schemas/Uom'
        quantity:
          type: number
          description: |
            Number of units purchased. 
        price:
          type: number
          description: |
            The price of the charge segment.
        priceChangeOption:
          $ref: '#/components/schemas/PriceChangeOption'
        priceIncreasePercentage:
          type: number
          nullable: true
          description: >
            Specifies the percentage to increase or decrease the price of a
            termed

            subscription's renewal. Use this field if you set the

            `PriceChangeOption` value to `SpecificPercentageValue`.



            1. AutomatedPriceChange setting is on


            2. Charge type is not one-time


            3. Charge model is not discount fixed amount
          minimum: -100
          maximum: 100
        pricingSummary:
          type: string
          description: >
            A concise description of the charge model and pricing that is
            suitable to

            show to your customers. 
        originalListPrice:
          type: number
          nullable: true
          description: >
            The original list price is the price of a product or service at
            which it

            is listed for sale by a manufacturer or retailer.
        processedThroughDate:
          format: date
          type: string
          description: >
            The date until when charges have been processed. When billing in
            arrears, such as usage, this field value is the the same as the

            `ChargedThroughDate` value. 

            This date is the earliest date when a charge can be amended.
        rolloverApply:
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
        rolloverPeriodLength:
          type: integer
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. 
        rolloverPeriods:
          format: int64
          type: integer
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> feature enabled.



            This field defines the number of rollover periods, it is restricted
            to 3.
        prorationOption:
          type: string
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled.


            The charge-level proration option for the product rate plan charge.
        segment:
          format: int64
          type: integer
          description: |
            Segment number of the charge.
        specificEndDate:
          format: date
          type: string
          description: >
            Defines when the charge ends after the charge trigger date.


            This field is only applicable when the `endDateCondition` field is
            `Specific_End_Date`.
        subscriptionChargeIntervalPricing:
          items:
            $ref: '#/components/schemas/GETIntervalPriceType'
          type: array
        tcv:
          type: number
          format: double
          description: |
            Total contract value (TCV) is the sum of one-time charges, recurring
            charges, and usage charges. The TCV calculation includes one-time
            charges, recurring charges, and usage charges.
        tiers:
          items:
            $ref: '#/components/schemas/RatePlanChargeTier'
          type: array
          nullable: true
        triggerDate:
          format: date
          type: string
          nullable: true
          description: >
            The date when the charge becomes effective and billing begins, in
            `yyyy-mm-dd` format.
        billingPeriodAlignment:
          $ref: '#/components/schemas/BillingPeriodAlignment'
        triggerEvent:
          $ref: '#/components/schemas/TriggerEvent'
        upToPeriods:
          format: int64
          type: integer
          nullable: true
          description: >
            Specifies the length of the period during which the charge is
            active. If this period ends before the subscription ends, the charge
            ends when this period ends.


            The value is inherited from `ProductRatePlanCharge.UpToPeriods`
            field.
        upToPeriodsType:
          $ref: '#/components/schemas/UpToPeriodsType'
        validityPeriodType:
          $ref: '#/components/schemas/ValidityPeriodType'
        salesPrice:
          type: number
          format: double
          description: |
            The sales price of the charge segment.
        accountingCode:
          type: string
          nullable: true
          description: |
            The accounting code of the charge segment.
        revenueRecognitionCode:
          type: string
          nullable: true
          description: |
            The revenue recognition code of the charge segment.
        revRecTriggerCondition:
          type: string
          nullable: true
          description: |
            Specifies when revenue recognition begins.
        estimatedEndDate:
          format: date
          type: string
          description: |
            The estimated end date of the charge segment.
        estimatedStartDate:
          format: date
          type: string
          description: |
            The estimated start date of the charge segment.
        taxable:
          type: boolean
          nullable: true
          description: |
            Indicates whether the charge is taxable. 
        taxCode:
          type: string
          nullable: true
          description: |
            The tax code of a charge.
        taxMode:
          type: string
          nullable: true
          description: |
            Determines how to define taxation for the charge.

            It affects the tax calculation of the charge.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
    GETTierType:
      properties:
        endingUnit:
          description: |
            Decimal defining end of tier range.
          type: number
        originalListPrice:
          description: >
            The original list price is the price of a product or service at
            which it is listed for sale by a manufacturer or retailer.



            **Note:** This field applies to the following charges in a
            subscription created through an order:
              - `oneTimeTiered`
              - `oneTimeVolume`
              - `recurringTiered`
              - `recurringVolume`
              - `usageTiered`
              - `usageVolume`
              - `usageTieredWithOverage`
          type: number
        price:
          description: >
            The decimal value of the tiered charge model. If the charge model is
            not a tiered type then this price field will be null and the `price`
            field directly under the `productRatePlanCharges` applies.
          type: number
        priceFormat:
          description: |
            Tier price format. Allowed values: `flat fee`, `per unit`.
          type: string
        startingUnit:
          description: |
            Decimal defining start of tier range.
          type: number
        tier:
          description: |
            Unique number of the tier.
          format: int64
          type: integer
      title: tiers
      type: object
    GETSubscriptionRatePlanChargesType:
      allOf:
        - properties:
            amendedByOrderOn:
              description: >
                The date when the rate plan charge is amended through an order
                or amendment. This field is to standardize the booking date
                information to increase audit ability and traceability of data
                between Zuora Billing and Zuora Revenue. It is mapped as the
                booking date for a sale order line in Zuora Revenue.
              type: string
            applyDiscountTo:
              description: >
                Specifies the type of charges a specific discount applies to. 


                This field is only used when applied to a discount charge model.
                If you are not using a discount charge model, the value is null.


                Possible values:


                * `RECURRING`

                * `USAGE`

                * `ONETIMERECURRING`

                * `ONETIMEUSAGE`

                * `RECURRINGUSAGE`

                * `ONETIMERECURRINGUSAGE`
              type: string
            applyToBillingPeriodPartially:
              description: >
                Allow the discount duration to be aligned with the billing
                period partially.


                **Note**: This field is only available if you have the [Enhanced
                Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
                feature enabled.
              type: boolean
            billingDay:
              description: >
                Billing cycle day (BCD), which is when bill runs generate
                invoices

                for charges associated with the product rate plan charge or the
                account.  


                Values:


                * `DefaultFromCustomer`

                * `SpecificDayofMonth(# of the month)`

                * `SubscriptionStartDay`

                * `ChargeTriggerDay`

                * `SpecificDayofWeek/dayofweek`: in which dayofweek is the day
                in the week you define your billing periods to start.


                In the response data, a day-of-the-month ordinal value
                (`first`-`31st`) appears in place of the hash sign above ("#").
                If this value exceeds the number of days in a particular month,
                the last day of the month is used as the BCD.
              type: string
            billingPeriod:
              description: |
                Allows billing period to be overridden on the rate plan charge.
              type: string
            billingPeriodAlignment:
              description: |
                Possible values:

                * `AlignToCharge`
                * `AlignToSubscriptionStart`
                * `AlignToTermStart`
              type: string
            billingTiming:
              description: >
                The billing timing for the charge. This field is only used if
                the `ratePlanChargeType` value is `Recurring`.


                Possible values are:


                * `In Advance`

                * `In Arrears`


                **Note:** This feature is in **Limited Availability**. If you
                wish to have access to the feature, submit a request at [Zuora
                Global Support](http://support.zuora.com/).
              type: string
            chargeFunction:
              description: >
                **Note**: This field is only available if you have the Prepaid
                with Drawdown or Minimum Commitment feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `141` or higher. Otherwise, an error occurs.


                This field defines what type of charge it is:

                * Standard: Normal charge with no Prepayment or Commitment or
                Drawdown.

                * Prepayment: For recurring charges. Unit or currency based
                prepaid charge.

                * CommitmentTrueUp: For recurring charges. Currency based
                minimum commitment charge.

                * Drawdown: For usage charges. Drawdown from prepaid funds.

                * DrawdownAndCreditCommitment: For usage charges. Drawdown from
                prepaid funds and then credit to minimum commitment funds.

                * CreditCommitment: For usage charges. Credit to minimum
                commitment funds.
              enum:
                - Standard
                - Prepayment
                - CommitmentTrueUp
                - Drawdown
                - CreditCommitment
                - DrawdownAndCreditCommitment
              type: string
            commitmentType:
              description: >
                **Note**: This field is only available if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
                target="_blank">Prepaid with Drawdown</a> feature enabled.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `133` or higher. Otherwise, an error occurs. 


                This field defines the type of commitment. A prepaid charge can
                be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge
                can only be `CURRENCY` type. For topup(recurring or one-time)
                charges, this field indicates what type of funds are created. 

                * If UNIT, it will create a fund with given prepaidUom.

                * If CURRENCY, it will create a fund with the currency amount
                calculated in list price.
                  
                For drawdown(usage) charges, this field indicates what type of
                funds are drawdown from that created from topup charges.
              enum:
                - UNIT
                - CURRENCY
              type: string
            chargeModelConfiguration:
              $ref: '#/components/schemas/ChargeModelConfigurationType'
            chargeSegments:
              description: >
                This field is returned only if you have set the `charge-detail`
                query parameter to `all-segments`.

                Container for the charge information for all the charge
                segments.
              type: array
              items:
                $ref: '#/components/schemas/RatePlanChargeSegment'
            chargedThroughDate:
              description: >
                The date through which a customer has been billed for the
                charge.
              format: date
              type: string
            creditOption:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled. 

                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 114 or higher. Otherwise, an error occurs. 

                The way to calculate credit. See [Credit
                Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
                for more information.
              enum:
                - TimeBased
                - ConsumptionBased
                - FullCreditBack
              type: string
            currency:
              description: |
                Currency used by the account. For example, `USD` or `EUR`.
              type: string
            description:
              description: |
                Description of the rate plan charge.
              type: string
            discountAmount:
              description: |
                The amount of the discount.
              type: number
            discountApplyDetails:
              description: >
                Container for the application details about a discount rate plan
                charge. 


                Only discount rate plan charges have values in this field.
              items:
                $ref: '#/components/schemas/DiscountApplyDetails'
              type: array
            discountClass:
              description: >
                The class that the discount belongs to. The discount class
                defines the order in which discount rate plan charges are
                applied.


                For more information, see [Manage Discount
                Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).
              type: string
            discountLevel:
              description: >
                The level of the discount. Values: `RatePlan`, `Subscription`,
                `Account`.
              type: string
            discountPercentage:
              description: |
                The amount of the discount as a percentage.
              type: number
            dmrc:
              description: >
                The change (delta) of monthly recurring charge exists when the
                change in monthly recurring revenue caused by an amendment or a
                new subscription.
              type: number
            done:
              description: >
                A value of `true` indicates that an invoice for a charge segment
                has been completed. A value of `false` indicates that an invoice
                has not been completed for the charge segment.
              type: boolean
            drawdownRate:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The [conversion
                rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
                between Usage UOM and Drawdown UOM for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
                Must be a positive number (>0).
              type: number
            drawdownUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                Unit of measurement for a [drawdown
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
              type: string
            dtcv:
              description: >
                After an amendment or an AutomatedPriceChange event, `dtcv`
                displays the change (delta) for the total contract value (TCV)
                amount for this charge, compared with its previous value with
                recurring charge types.
              type: number
            effectiveEndDate:
              description: |
                The effective end date of the rate plan charge.
              format: date
              type: string
            effectiveStartDate:
              description: |
                The effective start date of the rate plan charge.
              format: date
              type: string
            endDateCondition:
              description: >
                Defines when the charge ends after the charge trigger date.


                If the subscription ends before the charge end date, the charge
                ends when the subscription ends. But if the subscription end
                date is subsequently changed through a Renewal, or Terms and
                Conditions amendment, the charge will end on the charge end
                date.


                Values:


                * `Subscription_End`

                * `Fixed_Period`

                * `Specific_End_Date`

                * `One_Time`
              type: string
            estimatedStartDate:
              type: string
              format: date
              description: >
                The estimated start date of the pending charge in an active
                subscription.


                The value must be a date within the subscription term. The
                system will then automatically calculate the estimated end date
                for the pending charge. The estimated start and end dates are
                used to manage the estimated charge duration and forecast the
                revenue for the pending charge. 


                **Note:** This field is available only when the Pending
                Subscription Processing feature is turned on.
            estimatedEndDate:
              type: string
              format: date
              description: >
                The estimated end date of the pending charge in an active
                subscription.


                The system automatically calculates the estimated end date for
                the pending charge. The estimated start and end dates are used
                to manage the estimated charge duration and forecast the revenue
                for the pending charge. 


                **Note:** This field is available only when the Pending
                Subscription Processing feature is turned on.
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude rate plan charge related invoice items,
                invoice item adjustments, credit memo items, and debit memo
                items from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            excludeItemBookingFromRevenueAccounting:
              description: >
                The flag to exclude rate plan charges from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            id:
              description: |
                Rate plan charge ID.
              type: string
            includedUnits:
              description: |
                Specifies the number of units in the base set of units.
              type: number
            invoiceScheduleId:
              description: >
                The ID of the invoice schedule associated with the rate plan
                charge on the subscription.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: string
            isAllocationEligible:
              description: >
                This field is used to identify if the charge segment is
                allocation

                eligible in revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            isDimensionalPrice:
              description: >
                **Note**: This field is only available when the Dynamic Pricing
                feature is enabled. 



                Indicates whether the charge uses dimensional pricing. When set
                to true, this charge enables dynamic pricing.
              type: boolean
            isPrepaid:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                Indicates whether this charge is a prepayment (topup) charge or
                a drawdown charge. Values: `true` or `false`.
              type: boolean
            isPriceNegotiated:
              description: >
                **Note**: This field is only available when the Negotiated Price
                Table feature is enabled.



                Indicates whether the charge uses negotiated pricing. When set
                to true, this charge defines a negotiated price table.
              type: boolean
            isRollover:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The value is either "True" or "False". It determines whether the
                rollover fields are needed.
              type: boolean
            isStackedDiscount:
              description: >
                **Note**: This field is only applicable to the Discount -
                Percentage charge model.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to 130 or higher. Otherwise, an error occurs.


                This field indicates whether the discount is to be calculated as
                stacked discount. Possible values are as follows:
                  - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.
                  - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.

                For more information, see [Stacked
                discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
              type: boolean
            isUnbilled:
              description: >
                This field is used to dictate how to perform the accounting
                during

                revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            listPriceBase:
              description: |
                List price base; possible values are:

                * `Per_Billing_Period`
                * `Per_Month`
                * `Per_Week`
                * `Per_Year`
                * `Per_Specific_Months`
              type: string
            model:
              description: |
                Charge model; possible values are:

                * `FlatFee`
                * `PerUnit`
                * `Overage`
                * `Volume`
                * `Tiered`
                * `TieredWithOverage`
                * `DiscountFixedAmount`
                * `DiscountPercentage`
                * `MultiAttributePricing`
                * `PreratedPerUnit`
                * `PreratedPricing`
                * `HighWatermarkVolumePricing`
                * `HighWatermarkTieredPricing`
                * `Delivery`
              type: string
            mrr:
              description: |
                Monthly recurring revenue of the rate plan charge.
              type: number
            name:
              description: |
                Charge name.
              type: string
            number:
              description: |
                Charge number.
              type: string
            numberOfDeliveries:
              description: >
                Number of deliveries in the billing period for the charge
                segment.


                The `numberOfDeliveries` is used for the Delivery Pricing charge
                model only. 
              type: number
            numberOfPeriods:
              description: >
                Specifies the number of periods to use when calculating charges
                in an overage smoothing charge model.
              format: int64
              type: integer
            originalChargeId:
              description: |
                The original ID of the rate plan charge.
              type: string
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.



                **Note:** This field applies to the following charges in a
                subscription created through an order:
                  - `oneTimeFlatFee`
                  - `oneTimePerUnit`
                  - `recurringFlatFee`
                  - `recurringPerUnit`
                  - `usageFlatFee`
                  - `usagePerUnit` 
                  - `usageOverage`
                  - `usageTieredWithOverage`
              type: number
            originalOrderDate:
              description: >
                The date when the rate plan charge is created through an order
                or amendment.


                This field is to standardize the booking date information to
                increase audit ability and traceability of data between Zuora
                Billing and Zuora Revenue. It is mapped as the booking date for
                a sale order line in Zuora Revenue.
              format: date
              type: string
            overageCalculationOption:
              description: |
                Determines when to calculate overage charges.
              type: string
            overagePrice:
              description: |
                The price for units over the allowed amount.
              type: number
            overageUnusedUnitsCreditOption:
              description: >
                Determines whether to credit the customer with unused units of
                usage.
              type: string
            prepaidOperationType:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The type of this charge. It is either a prepayment (topup)
                charge or a drawdown charge. 
              enum:
                - topup
                - drawdown
              type: string
            prepaidQuantity:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The number of units included in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
                Must be a positive number (>0).
              type: number
            prepaidTotalQuantity:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The total amount of units that end customers can use during a
                validity period when they subscribe to a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              type: number
            prepaidUom:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                Unit of measurement for a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              type: string
            price:
              description: >
                The price associated with the rate plan charge expressed as a
                decimal.
              type: number
            pricingAttributes:
              description: >
                Container for pricing attributes that provide additional context
                for dynamic pricing. This field includes all the dynamic pricing
                attributes and values associated with this charge, except for
                the pricing attributes mapped to Zuora Usage object fields.



                **Note:** To enable Dynamic Pricing, submit a request to <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.        
              type: object
              additionalProperties: true
            salesPrice:
              description: >
                The sales price associated with the rate plan charge expressed
                as a decimal.


                **Notes**: 

                - This field is only available to subscriptions that are created
                through orders and exist after 2023-01-10.

                - This field applies to the following charge models, and the
                values vary with the charge models:
                  - Flat fee: the value equals the value of the `price` field.
                  - Per unit: the value equals `price` multiplied by `quantity`.
                  - Fixed amount discount: the value equals the value of the `discountAmount` field.
                  - Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit.
                  - Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit.
              type: number
            priceChangeOption:
              description: >
                When the following is true:


                1. AutomatedPriceChange setting is on


                2. Charge type is not one-time


                3. Charge model is not discount percentage


                Then an automatic price change can have a value for when a
                termed subscription is renewed. 


                Values (one of the following):


                * `NoChange` (default)

                * `SpecificPercentageValue`

                * `UseLatestProductCatalogPricing`
              type: string
            priceIncreasePercentage:
              description: |
                A planned future price increase amount as a percentage.
              type: number
            pricingSummary:
              description: |
                Concise description of rate plan charge model.
              type: string
            processedThroughDate:
              description: >
                The date until when charges have been processed. When billing in
                arrears, such as usage, this field value is the the same as the
                `ChargedThroughDate` value. This date is the earliest date when
                a charge can be amended.
              format: date
              type: string
            productCategory:
              description: >
                This is used to maintain the product category. 


                **Note**: This field is only available if you have the
                Additional Revenue Fields property enabled.
              type: string
            productClass:
              description: >
                This is used to maintain the product class. 


                **Note**: This field is only available if you have the
                Additional Revenue Fields property enabled.    
              type: string
            productFamily:
              description: >
                This is used to maintain the product family. 


                **Note**: This field is only available if you have the
                Additional Revenue Fields property enabled.
              type: string
            productLine:
              description: >
                This is used to maintain the product line. 


                **Note**: This field is only available if you have the
                Additional Revenue Fields property enabled.
              type: string
            productRatePlanChargeId:
              description: ''
              type: string
            quantity:
              description: >
                The quantity of units, such as the number of authors in a hosted
                wiki service. Valid for all charge models except for Flat Fee
                pricing.
              type: number
            ratingGroup:
              description: >
                Specifies a rating group based on which usage records are rated.


                Possible values:


                - `ByBillingPeriod` (default): The rating is based on all the
                usages in a billing period.

                - `ByUsageStartDate`: The rating is based on all the usages on
                the same usage start date. 

                - `ByUsageRecord`: The rating is based on each usage record.

                - `ByUsageUpload`: The rating is based on all the  usages in a
                uploaded usage file (`.xls` or `.csv`).

                - `ByGroupId`: The rating is based on all the usages in a custom
                group.


                **Note:** 

                - The `ByBillingPeriod` value can be applied for all charge
                models. 

                - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload`
                values can only be applied for per unit, volume pricing, and
                tiered pricing charge models. 

                - The `ByGroupId` value is only available if you have the Active
                Rating feature enabled.

                - Use this field only for Usage charges. One-Time Charges and
                Recurring Charges return `NULL`.
              type: string
            reflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `reflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `reflectDiscountInNetAmount` field to `true`, you must also set
                both the `excludeItemBookingFromRevenueAccounting` and
                `excludeItemBillingFromRevenueAccounting` fields to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `reflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration does not support discounts on the preceding charges.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `reflectDiscountInNetAmount` field to
                `true`.      
            revenueRecognitionTiming:
              description: >
                Specifies the type of revenue recognition timing.


                Predefined options are listed as enum values in this API
                Reference. Other options might also be avaliable depending on
                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled.    
              maxLength: 200
              type: string
              enum:
                - Upon Billing Document Posting Date
                - Upon Order Activation Date
            revenueAmortizationMethod:
              description: >
                Specifies the type of revenue amortization method.


                Predefined options are listed as enum values in this API
                Reference. Other options might also be avaliable depending on
                the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
                target="_blank">revenue recognition policy configuration</a> in
                the Zuora Billing UI.


                **Note**: This field is only available if you have the Order to
                Revenue feature enabled. 
              maxLength: 200
              type: string
              enum:
                - Immediate
                - Ratable Using Start And End Dates
            rolloverApply:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                This field defines the priority of rollover, which is either
                first or last.
              enum:
                - ApplyFirst
                - ApplyLast
              type: string
            rolloverPeriodLength:
              default: null
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with

                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

                feature enabled.


                Use this field when you want to set the rollover fund's period
                length shorter than the prepayment charge's validity period. In
                this case, you must set the `rolloverPeriods` field to 1. For
                example, you can define the rollover fund's period length as 5
                months, shorter than the prepayment charge's validity period: a
                year.
              type: integer
            rolloverPeriods:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                This field defines the number of rollover periods, it is
                restricted to 3.
              type: number
            segment:
              description: >
                The identifying number of the subscription rate plan segment.
                Segments are numbered sequentially, starting with 1.
              format: int64
              type: integer
            smoothingModel:
              description: >
                Specifies when revenue recognition begins. When charge model is
                `Overage` or `TieredWithOverage`, `smoothingModel` will be one
                of the following values:


                * `ContractEffectiveDate`

                * `ServiceActivationDate`

                * `CustomerAcceptanceDate`
              type: string
            specificBillingPeriod:
              description: >
                Customizes the number of month or week for the charges billing
                period. This field is required if you set the value of the
                `BillingPeriod` field to `Specific_Months` or `Specific_Weeks`.
              format: int64
              type: integer
            specificEndDate:
              description: >
                The specific date on which the charge ends. If the subscription
                ends before the specific end date, the charge ends when the
                subscription ends. But if the subscription end date is
                subsequently changed through a Renewal, or Terms and Conditions
                amendment, the charge will end on the specific end date.
              format: date
              type: string
            specificListPriceBase:
              description: |
                The number of months for the list price base of the charge. 

                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.
            subscriptionChargeDeliverySchedule:
              $ref: '#/components/schemas/GETDeliveryScheduleType'
            subscriptionChargeIntervalPricing:
              description: >
                Interval Pricing information. This field is available if the
                Offers feature is enabled.
              items:
                $ref: '#/components/schemas/GETIntervalPriceType'
              type: array
            tcv:
              description: |
                The total contract value.
              type: number
            tiers:
              description: |
                One or many defined ranges with distinct pricing.
              items:
                $ref: '#/components/schemas/GETTierType'
              type: array
            triggerDate:
              description: |
                The date that the rate plan charge will be triggered.
              format: date
              type: string
            triggerEvent:
              description: |
                The event that will cause the rate plan charge to be triggered.

                Possible values: 

                * `ContractEffective`
                * `ServiceActivation`
                * `CustomerAcceptance`
                * `SpecificDate`
              type: string
            type:
              description: >
                Charge type. Possible values are: `OneTime`, `Recurring`,
                `Usage`.
              type: string
            unusedUnitsCreditRates:
              description: >
                Specifies the rate to credit a customer for unused units of
                usage. This field is applicable only for overage charge models
                when the 

                `OverageUnusedUnitsCreditOption` field value is
                `CreditBySpecificRate`.
              type: number
            upsellOriginChargeNumber:
              description: >
                The identifier of the original upselling charge associated with
                the current charge.


                For a termed subscription, you can now use the "Create an order"
                API operation to perform an Add Product order action to make a
                product quantity upsell for per unit recurring charges. The
                benefit is that the charge added by this approach will be
                automatically combined with the original existing charge for
                which you want to upsell when the subscription is renewed. The
                approach is as follows:

                * Use an Add Product order action to add a charge that is of the
                same charge type, charge model, and charge end date as the
                existing per unit recurring charge for which you want to make a
                quantity upsell.


                * In the preceding charge to add, use the
                `upsellOriginChargeNumber` field to specify the existing rate
                plan charge for which you want to make the quantity upsell.


                Note that a termed subscription with such upsell charges can not
                be changed to an evergreen subscription.   


                **Note**: The Quantity Upsell feature is in the **Early
                Adopter** phase. We are actively soliciting feedback from a
                small set of early adopters before releasing it as generally
                available. If you want to join this early adopter program,
                submit a request at [Zuora Global

                Support](https://support.zuora.com).  
              type: string
            uom:
              description: |
                Specifies the units to measure usage. 
              type: string
            upToPeriods:
              description: >
                Specifies the length of the period during which the charge is
                active. If this period ends before the subscription ends, the
                charge ends when this period ends.


                If the subscription end date is subsequently changed through a
                Renewal, or Terms and Conditions amendment, the charge end date
                will change accordingly up to the original period end.
              type: string
            upToPeriodsType:
              description: |
                The period type used to define when the charge ends. 

                Values:

                * `Billing_Periods`
                * `Days`
                * `Weeks`
                * `Months`
                * `Years`
              type: string
            usageRecordRatingOption:
              description: >
                Determines how Zuora processes usage records for per-unit usage
                charges. 
              type: string
            validityPeriodType:
              description: >
                **Note**: This field is only available if you have the [Prepaid
                with
                Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
                feature enabled.


                The period in which the prepayment units are valid to use as
                defined in a [prepayment
                charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
              enum:
                - SUBSCRIPTION_TERM
                - ANNUAL
                - SEMI_ANNUAL
                - QUARTER
                - MONTH
              type: string
            version:
              description: |
                Rate plan charge revision number.
              format: int64
              type: integer
          type: object
        - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
      title: ratePlanCharges
    GETSubscriptionProductFeatureType:
      properties:
        description:
          description: |
            Feature description.
          type: string
        featureCode:
          description: |
            Feature code, up to 255 characters long.
          type: string
        id:
          description: |
            SubscriptionProductFeature ID.
          type: string
        name:
          description: |
            Feature name, up to 255 characters long.
          type: string
      title: subscriptionProductFeatures
      type: object
    GETSubscriptionRatePlanType:
      allOf:
        - properties:
            externallyManagedPlanId:
              description: >
                Indicates the unique identifier for the rate plan purchased on a
                third-party store. This field is used to represent a
                subscription rate plan created through third-party stores.
              type: string
            id:
              description: |
                Rate plan ID.
              type: string
            lastChangeType:
              description: >
                The last amendment on the rate plan. 



                **Note:** If a subscription is created through an order, this
                field is only available if multiple orders are created on the
                subscription.



                Possible Values:
                  * `Add`
                  * `Update`
                  * `Remove`
              type: string
            productId:
              description: ''
              type: string
            productName:
              description: ''
              type: string
            productRatePlanId:
              description: ''
              type: string
            productSku:
              description: |
                The unique SKU for the product.
              type: string
            contractedMrr:
              description: >
                Monthly recurring revenue of the subscription rate plan
                exclusive of all the discounts applicable.
              type: number
            contractedNetMrr:
              description: >
                Monthly recurring revenue of the subscription rate plan
                inclusive of all the discounts applicable, including the
                fixed-amount discounts and percentage discounts.
              type: number
            asOfDayGrossMrr:
              description: >
                Monthly recurring revenue of the subscription rate plan
                exclusive of any discounts applicable as of specified day.
              type: number
            asOfDayNetMrr:
              description: >
                Monthly recurring revenue of the subscription rate plan
                inclusive of all the discounts applicable, including the
                fixed-amount discounts and percentage discounts as of specified
                day.
              type: number
            ratePlanCharges:
              description: |
                Container for one or more charges.
              items:
                $ref: '#/components/schemas/GETSubscriptionRatePlanChargesType'
              type: array
            ratePlanName:
              description: |
                Name of the rate plan.
              type: string
            subscriptionProductFeatures:
              description: >-
                Container for one or more features. 


                Only available when the following settings are enabled:


                * The Entitlements feature in your tenant.


                * The Enable Feature Specification in Product and Subscriptions
                setting in Zuora Billing Settings
              items:
                $ref: '#/components/schemas/GETSubscriptionProductFeatureType'
              type: array
          type: object
        - $ref: '#/components/schemas/RatePlanObjectCustomFields'
      title: ratePlans
    SubscriptionRampIntervalResponse:
      properties:
        description:
          description: The short description of the interval.
          type: string
        endDate:
          description: The end date of the interval.
          format: date
          type: string
        name:
          description: The name of the interval.
          type: string
        startDate:
          description: The start date of the interval.
          format: date
          type: string
      title: RampInterval
      type: object
    SubscriptionRampChargeResponse:
      properties:
        chargeNumber:
          description: The number of the rate plan charge.
          type: string
      title: RampCharge
      type: object
    SubscriptionRampResponse:
      description: >-
        Ramp information associated with the subscription including the ramp
        intervals and the charges.
      properties:
        id:
          description: The ID of the ramp.
          type: string
        name:
          description: The name of the ramp.
          type: string
        number:
          description: |-
            The number of the ramp. It is automatically generated by the billing
            system.
          type: string
        description:
          description: The short description of the ramp.
          type: string
        intervals:
          description: >-
            Container for the intervals that the ramp is split into in its
            timeline.
          items:
            $ref: '#/components/schemas/SubscriptionRampIntervalResponse'
          type: array
        charges:
          description: >-
            Container for the rate plan charges that are considered as part of
            the

            ramp deal.
          items:
            $ref: '#/components/schemas/SubscriptionRampChargeResponse'
          type: array
      title: SubscriptionRamp
      type: object
    GETSubscriptionStatusHistoryType:
      allOf:
        - properties:
            endDate:
              description: The effective end date of the status history.
              format: date
              type: string
            startDate:
              description: The effective start date of the status history.
              format: date
              type: string
            status:
              description: |
                The status of the subscription.

                Values are:

                * `Pending Activation`
                * `Pending Acceptance`
                * `Active`
                * `Cancelled`
                * `Suspended`
                * `OutOfTerm`
              type: string
          type: object
      title: statusHistory
    GETSubscriptionType:
      allOf:
        - properties:
            accountId:
              description: ''
              type: string
            accountName:
              description: ''
              type: string
            accountNumber:
              description: ''
              type: string
            autoRenew:
              description: >
                If `true`, the subscription automatically renews at the end of
                the term. Default is `false`.
              type: boolean
            billToContact:
              $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact'
            cancelReason:
              description: >
                The reason for a subscription cancellation copied from the
                `changeReason` field of a Cancel Subscription order action. 


                This field contains valid value only if a subscription is
                cancelled through the Orders UI or API. Otherwise, the value for
                this field will always be `null`.
              type: string
            contractEffectiveDate:
              description: |
                Effective contract date for this subscription, as yyyy-mm-dd.
              format: date
              type: string
            contractedMrr:
              description: |
                Monthly recurring revenue of the subscription.
              type: number
            contractedNetMrr:
              description: >
                Monthly recurring revenue of the subscription inclusive of all
                the discounts applicable, including the fixed-amount discounts
                and percentage discounts.
              type: number
            asOfDayGrossMrr:
              description: >
                Monthly recurring revenue of the subscription exclusive of any
                discounts applicable as of specified day.
              type: number
            asOfDayNetMrr:
              description: >
                Monthly recurring revenue of the subscription inclusive of all
                the discounts applicable, including the fixed-amount discounts
                and percentage discounts as of specified day.
              type: number
            netTotalContractedValue:
              description: >
                Total contracted value of the subscription inclusive of all the
                discounts applicable, including the fixed-amount discounts and
                percentage discounts.
              type: number
            currency:
              description: >
                The currency of the subscription.

                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currencies</a> feature enabled.
              type: string
            currentTerm:
              description: |
                The length of the period for the current subscription term.
              format: int64
              type: integer
            currentTermPeriodType:
              description: |
                The period type for the current subscription term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            customerAcceptanceDate:
              description: >
                The date on which the services or products within a subscription
                have been accepted by the customer, as yyyy-mm-dd.
              format: date
              type: string
            externallyManagedBy:
              description: >
                An enum field on the Subscription object to indicate the name of
                a third-party store. This field is used to represent
                subscriptions created through third-party stores.
              enum:
                - Amazon
                - Apple
                - Google
                - Roku
              type: string
            id:
              description: |
                Subscription ID.
              type: string
            initialTerm:
              description: |
                The length of the period for the first subscription term.
              format: int64
              type: integer
            initialTermPeriodType:
              description: |
                The period type for the first subscription term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the
                subscription.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            invoiceOwnerAccountId:
              description: ''
              type: string
            invoiceOwnerAccountName:
              description: ''
              type: string
            invoiceOwnerAccountNumber:
              description: ''
              type: string
            invoiceScheduleId:
              description: >
                The ID of the invoice schedule associated with the subscription.


                If multiple invoice schedules are created for different terms of
                a subscription, this field stores the latest invoice schedule.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: integer
            invoiceSeparately:
              description: >
                Separates a single subscription from other subscriptions and
                creates an invoice for the subscription. 


                If the value is `true`, the subscription is billed separately
                from other subscriptions. If the value is `false`, the
                subscription is included with other subscriptions in the account
                invoice.
              type: boolean
            invoiceTemplateId:
              description: |
                The ID of the invoice template associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
            invoiceTemplateName:
              description: >
                The name of the invoice template associated with the
                subscription.


                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body.
                  
              type: string
            isLatestVersion:
              description: >-
                If `true`, the current subscription object is the latest
                version.
              type: boolean
            lastBookingDate:
              description: >-
                The last booking date of the subscription object. This field is
                writable only when the subscription is newly created as a first
                version subscription. You can override the date value when
                creating a subscription through the Subscribe and Amend API or
                the subscription creation UI (non-Orders). Otherwise, the
                default value `today` is set per the user's timezone. The value
                of this field is as follows:

                * For a new subscription created by the [Subscribe and Amend
                APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),
                this field has the value of the subscription creation date.

                * For a subscription changed by an amendment, this field has the
                value of the amendment booking date.

                * For a subscription created or changed by an order, this field
                has the value of the order date. 
              format: date
              type: string
            notes:
              description: |
                A string of up to 65,535 characters.
              type: string
            orderNumber:
              description: >
                The order number of the order in which the changes on the
                subscription are made. 


                **Note:** This field is only available if you have the [Order
                Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
                feature enabled. If you wish to have access to the feature,
                submit a request at [Zuora Global
                Support](http://support.zuora.com/). We will investigate your
                use cases and data before enabling this feature for you.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentTerm:
              description: >
                The name of the payment term associated with the subscription.
                For example, `Net 30`. The payment term determines the due dates
                of invoices.


                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
            ratePlans:
              description: |
                Container for rate plans.
              items:
                $ref: '#/components/schemas/GETSubscriptionRatePlanType'
              type: array
            renewalSetting:
              description: >
                Specifies whether a termed subscription will remain `TERMED` or
                change to `EVERGREEN` when it is renewed. 


                Values are:


                * `RENEW_WITH_SPECIFIC_TERM` (default)

                * `RENEW_TO_EVERGREEN`
              type: string
            renewalTerm:
              description: |
                The length of the period for the subscription renewal term.
              format: int64
              type: integer
            renewalTermPeriodType:
              description: |
                The period type for the subscription renewal term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            revision:
              description: >
                An auto-generated decimal value uniquely tagged with a
                subscription. The value always contains one decimal place, for
                example, the revision of a new subscription is 1.0. If a further
                version of the subscription is created, the revision value will
                be increased by 1. Also, the revision value is always
                incremental regardless of deletion of subscription versions.
              type: string
            sequenceSetId:
              description: |
                The ID of the sequence set associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
              nullable: true
            communicationProfileId:
              description: >
                The ID of the communication profile associated with the
                subscription.


                **Note**: This field is available in the request body only if
                you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a>

                feature turned on. The value is `null` in the response body
                without this feature turned on.
              type: string
              nullable: true
            ramp:
              description: |
                Ramp information associated with the subscription.
              $ref: '#/components/schemas/SubscriptionRampResponse'
              type: object
            sequenceSetName:
              description: |
                The name of the sequence set associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body.
              type: string
            serviceActivationDate:
              description: >
                The date on which the services or products within a subscription
                have been activated and access has been provided to the
                customer, as yyyy-mm-dd
              format: date
              type: string
            shipToContact:
              $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact'
            soldToContact:
              $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact'
            status:
              description: |
                Subscription status; possible values are:

                * `Draft`
                * `Pending Activation`
                * `Pending Acceptance`
                * `Active`
                * `Cancelled`
                * `Suspended`
              type: string
            statusHistory:
              description: |
                Container for status history.
              items:
                $ref: '#/components/schemas/GETSubscriptionStatusHistoryType'
              type: array
            subscriptionEndDate:
              description: >
                The date when the subscription term ends, where the subscription
                ends at midnight the day before.

                For example, if the `subscriptionEndDate` is 12/31/2016, the
                subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.

                This date is the same as the term end date or the cancelation
                date, as appropriate.
              format: date
              type: string
            subscriptionNumber:
              description: ''
              type: string
            subscriptionStartDate:
              description: |
                Date the subscription becomes effective.
              format: date
              type: string
            termEndDate:
              description: >
                Date the subscription term ends. If the subscription is
                evergreen, this is null or is the cancellation date (if one has
                been set).
              format: date
              type: string
            termStartDate:
              description: >
                Date the subscription term begins. If this is a renewal
                subscription, this date is different from the subscription start
                date.
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
            scheduledCancelDate:
              description: The date when the subscription is scheduled to be canceled.
              format: date
              type: string
            scheduledSuspendDate:
              description: The date when the subscription is scheduled to be suspended.
              format: date
              type: string
            scheduledResumeDate:
              description: The date when the subscription is scheduled to be resumed.
              format: date
              type: string
            totalContractedValue:
              description: |
                Total contracted value of the subscription.
              type: number
            version:
              description: >-
                This is the subscription version automatically generated by
                Zuora Billing. Each order or amendment creates a new version of
                the subscription, which incorporates the changes made in the
                order or amendment.
              format: int64
              type: integer
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectQTFields'
        - $ref: '#/components/schemas/SubscriptionObjectNSFields'
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      title: subscriptions
    GETSubscriptionWrapper:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        subscriptions:
          description: |
            Array of subscriptions.
          items:
            $ref: '#/components/schemas/GETSubscriptionType'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETSubscriptionByKeyWithSuccess:
      allOf:
        - properties:
            accountId:
              description: The ID of the account associated with this subscription.
              type: string
            accountName:
              description: The name of the account associated with this subscription.
              type: string
            accountNumber:
              description: The number of the account associated with this subscription.
              type: string
            autoRenew:
              description: >
                If `true`, the subscription automatically renews at the end of
                the term. Default is `false`.
              type: boolean
            billToContact:
              $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact'
            cancelReason:
              description: >
                The reason for a subscription cancellation copied from the
                `changeReason` field of a Cancel Subscription order action. 


                This field contains valid value only if a subscription is
                cancelled through the Orders UI or API. Otherwise, the value for
                this field will always be `null`.
              type: string
            contractEffectiveDate:
              description: |
                Effective contract date for this subscription, as yyyy-mm-dd.
              format: date
              type: string
            contractedMrr:
              description: |
                Monthly recurring revenue of the subscription.
              type: number
            contractedNetMrr:
              description: >
                Monthly recurring revenue of the subscription inclusive of all
                the discounts applicable, including the fixed-amount discounts
                and percentage discounts.
              type: number
            asOfDayGrossMrr:
              description: >
                Monthly recurring revenue of the subscription exclusive of any
                discounts applicable as of specified day.
              type: number
            asOfDayNetMrr:
              description: >
                Monthly recurring revenue of the subscription inclusive of all
                the discounts applicable, including the fixed-amount discounts
                and percentage discounts as of specified day.
              type: number
            netTotalContractedValue:
              description: >
                Total contracted value of the subscription inclusive of all the
                discounts applicable, including the fixed-amount discounts and
                percentage discounts.
              type: number
            currency:
              description: >
                The currency of the subscription.

                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currencies</a> feature enabled.
              type: string
            currentTerm:
              description: |
                The length of the period for the current subscription term.
              format: int64
              type: integer
            currentTermPeriodType:
              description: |
                The period type for the current subscription term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            customerAcceptanceDate:
              description: >
                The date on which the services or products within a subscription
                have been accepted by the customer, as yyyy-mm-dd.
              format: date
              type: string
            externallyManagedBy:
              description: >
                An enum field on the Subscription object to indicate the name of
                a third-party store. This field is used to represent
                subscriptions created through third-party stores.
              enum:
                - Amazon
                - Apple
                - Google
                - Roku
              type: string
            id:
              description: |
                Subscription ID.
              type: string
            initialTerm:
              description: |
                The length of the period for the first subscription term.
              format: int64
              type: integer
            initialTermPeriodType:
              description: |
                The period type for the first subscription term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the
                subscription.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            invoiceOwnerAccountId:
              description: ''
              type: string
            invoiceOwnerAccountName:
              description: ''
              type: string
            invoiceOwnerAccountNumber:
              description: ''
              type: string
            invoiceScheduleId:
              description: >
                The ID of the invoice schedule associated with the subscription.


                If multiple invoice schedules are created for different terms of
                a subscription, this field stores the latest invoice schedule.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: integer
            invoiceSeparately:
              description: >
                Separates a single subscription from other subscriptions and
                creates an invoice for the subscription. 


                If the value is `true`, the subscription is billed separately
                from other subscriptions. If the value is `false`, the
                subscription is included with other subscriptions in the account
                invoice.
              type: boolean
            invoiceTemplateId:
              description: |
                The ID of the invoice template associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
              nullable: true
            invoiceTemplateName:
              description: >
                The name of the invoice template associated with the
                subscription.


                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body.
                  
              type: string
            isLatestVersion:
              description: >-
                If `true`, the current subscription object is the latest
                version.
              type: boolean
            lastBookingDate:
              description: >-
                The last booking date of the subscription object. This field is
                writable only when the subscription is newly created as a first
                version subscription. You can override the date value when
                creating a subscription through the Subscribe and Amend API or
                the subscription creation UI (non-Orders). Otherwise, the
                default value `today` is set per the user's timezone. The value
                of this field is as follows:

                * For a new subscription created by the [Subscribe and Amend
                APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),
                this field has the value of the subscription creation date.

                * For a subscription changed by an amendment, this field has the
                value of the amendment booking date.

                * For a subscription created or changed by an order, this field
                has the value of the order date. 
              format: date
              type: string
            notes:
              description: |
                A string of up to 65,535 characters.
              type: string
            orderNumber:
              description: >
                The order number of the order in which the changes on the
                subscription are made. 


                **Note:** This field is only available if you have the [Order
                Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
                feature enabled. If you wish to have access to the feature,
                submit a request at [Zuora Global
                Support](http://support.zuora.com/). We will investigate your
                use cases and data before enabling this feature for you.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            originalListPrice:
              description: >
                The original list price is the price of a product or service at
                which it is listed for sale by a manufacturer or retailer.



                **Note:** This field applies to the following charges in a
                subscription created through an order:
                  - `oneTimeFlatFee`
                  - `oneTimePerUnit`
                  - `recurringFlatFee`
                  - `recurringPerUnit`
                  - `usageFlatFee`
                  - `usagePerUnit` 
                  - `usageOverage`
                  - `usageTieredWithOverage`
              type: number
            paymentTerm:
              description: >
                The name of the payment term associated with the subscription.
                For example, `Net 30`. The payment term determines the due dates
                of invoices.


                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
            ramp:
              description: |
                Ramp information associated with the subscription.
              $ref: '#/components/schemas/SubscriptionRampResponse'
              type: object
            ratePlans:
              description: |
                Container for rate plans.
              items:
                $ref: '#/components/schemas/GETSubscriptionRatePlanType'
              type: array
            renewalSetting:
              description: >
                Specifies whether a termed subscription will remain `TERMED` or
                change to `EVERGREEN` when it is renewed. 


                Values are:


                * `RENEW_WITH_SPECIFIC_TERM` (default)

                * `RENEW_TO_EVERGREEN`
              type: string
            renewalTerm:
              description: |
                The length of the period for the subscription renewal term.
              format: int64
              type: integer
            renewalTermPeriodType:
              description: |
                The period type for the subscription renewal term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            revision:
              description: >
                An auto-generated decimal value uniquely tagged with a
                subscription. The value always contains one decimal place, for
                example, the revision of a new subscription is 1.0. If a further
                version of the subscription is created, the revision value will
                be increased by 1. Also, the revision value is always
                incremental regardless of deletion of subscription versions.
              type: string
            sequenceSetId:
              description: |
                The ID of the sequence set associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
              nullable: true
            communicationProfileId:
              description: >
                The ID of the communication profile associated with the
                subscription.


                **Note**: This field is available in the request body only if
                you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a>

                feature turned on. The value is `null` in the response body
                without this feature turned on.
              type: string
              nullable: true
            sequenceSetName:
              description: |
                The name of the sequence set associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body.
              type: string
            serviceActivationDate:
              description: >
                The date on which the services or products within a subscription
                have been activated and access has been provided to the
                customer, as yyyy-mm-dd
              format: date
              type: string
            shipToContact:
              $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact'
            soldToContact:
              $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact'
            status:
              description: |
                Subscription status; possible values are:

                * `Draft`
                * `Pending Activation`
                * `Pending Acceptance`
                * `Active`
                * `Cancelled`
                * `Suspended`
              type: string
            statusHistory:
              description: |
                Container for status history.
              items:
                $ref: '#/components/schemas/GETSubscriptionStatusHistoryType'
              type: array
            subscriptionEndDate:
              description: >
                The date when the subscription term ends, where the subscription
                ends at midnight the day before.

                For example, if the `subscriptionEndDate` is 12/31/2016, the
                subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.

                This date is the same as the term end date or the cancelation
                date, as appropriate.
              format: date
              type: string
            subscriptionNumber:
              description: Subscription number.
              type: string
            subscriptionStartDate:
              description: |
                Date the subscription becomes effective.
              format: date
              type: string
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
            termEndDate:
              description: >
                Date the subscription term ends. If the subscription is
                evergreen, this is null or is the cancellation date (if one has
                been set).
              format: date
              type: string
            termStartDate:
              description: >
                Date the subscription term begins. If this is a renewal
                subscription, this date is different from the subscription start
                date.
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
            scheduledCancelDate:
              description: The date when the subscription is scheduled to be canceled.
              format: date
              type: string
            scheduledSuspendDate:
              description: The date when the subscription is scheduled to be suspended.
              format: date
              type: string
            scheduledResumeDate:
              description: The date when the subscription is scheduled to be resumed.
              format: date
              type: string
            totalContractedValue:
              description: |
                Total contracted value of the subscription.
              type: number
            version:
              description: >-
                This is the subscription version automatically generated by
                Zuora Billing. Each order or amendment creates a new version of
                the subscription, which incorporates the changes made in the
                order or amendment.
              format: int64
              type: integer
            accountOwnerDetails:
              $ref: '#/components/schemas/GETAccountTypeBasicInfo'
            invoiceOwnerAccountDetails:
              $ref: '#/components/schemas/GETAccountTypeBasicInfo'
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectQTFields'
        - $ref: '#/components/schemas/SubscriptionObjectNSFields'
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
    PUTScAddType:
      allOf:
        - properties:
            amendedByOrderOn:
              description: >
                The date when the rate plan charge is amended through an order
                or amendment. This field is not updatable.


                This field is to standardize the booking date information to
                increase audit ability and traceability of data between Zuora
                Billing and Zuora Revenue. It is mapped as the booking date for
                a sale order line in Zuora Revenue.
              type: string
            applyDiscountTo:
              description: >
                Specifies the type of charges that you want a specific discount
                to apply to.


                Values:


                * `ONETIME`

                * `RECURRING`

                * `USAGE`

                * `ONETIMERECURRING`

                * `ONETIMEUSAGE`

                * `RECURRINGUSAGE`

                * `ONETIMERECURRINGUSAGE`


                Available for the following charge type for the Discount-Fixed
                Amount and Discount-Percentage charge models:


                * Recurring
              type: string
            billCycleDay:
              description: >
                Sets the bill cycle day (BCD) for the charge. The BCD determines
                which day of the month customer is billed.


                Values: `1`-`31`


                Available for the following charge types:


                * Recurring

                * Usage-based
              type: string
            billCycleType:
              description: >
                Specifies how to determine the billing day for the charge. When
                this field is set to `SpecificDayofMonth`, set the
                `BillCycleDay` field. When this field is set to
                `SpecificDayofWeek`, set the `weeklyBillCycleDay` field.


                Values:


                * `DefaultFromCustomer`

                * `SpecificDayofMonth`

                * `SubscriptionStartDay`

                * `ChargeTriggerDay`

                * `SpecificDayofWeek`


                Available for the following charge types:


                * Recurring

                * Usage-based
              type: string
            billingPeriod:
              description: >
                Billing period for the charge. The start day of the billing
                period is also called the bill cycle day (BCD). When you renew a
                subscription, the current subscription term is extended by
                creating a new term. If any charge in your subscription has the
                billing period set as `SubscriptionTerm`， a new charge segment
                is generated for the new term.


                Values:


                * `Month`

                * `Quarter`

                * `Semi_Annual`

                * `Annual`

                * `Eighteen_Months`

                * `Two_Years`

                * `Three_Years`

                * `Five_Years`

                * `Specific_Months`

                * `Subscription_Term`

                * `Week`

                * `Specific_Weeks`


                Available for the following charge types:


                * Recurring

                * Usage-based
              type: string
            billingPeriodAlignment:
              description: >
                Aligns charges within the same subscription if multiple charges
                begin on different dates.


                Values:


                * `AlignToCharge`

                * `AlignToSubscriptionStart`

                * `AlignToTermStart`


                Available for the following charge types:


                * Recurring

                * Usage-based
              type: string
            billingTiming:
              description: >
                Billing timing for the charge for recurring charge types. Not
                avaliable for one time, usage and discount charges.


                Values:


                * `IN_ADVANCE` (default)

                * `IN_ARREARS`
              type: string
            chargeModelConfiguration:
              $ref: '#/components/schemas/ChargeModelConfigurationType'
            description:
              description: |
                Description of the charge.
              type: string
            discountAmount:
              description: >
                Specifies the amount of fixed-amount discount.


                Available for the following charge type for the Discount-Fixed
                Amount charge model:


                * Recurring
              type: number
            discountLevel:
              description: >
                Specifies if the discount applies to the product rate plan only
                , the entire subscription, or to any activity in the account.


                Values:


                * `rateplan`

                * `subscription`

                * `account`


                Available for the following charge type for the Discount-Fixed
                Amount and Discount-Percentage charge models:


                * Recurring
              type: string
            discountPercentage:
              description: >
                Specifies the percentage of a percentage discount. 


                Available for the following charge type for the
                Discount-Percentage charge model:


                * Recurring
              type: number
            endDateCondition:
              description: >
                Defines when the charge ends after the charge trigger date. If
                the subscription ends before the charge end date, the charge
                ends when the subscription ends. But if the subscription end
                date is subsequently changed through a Renewal, or Terms and
                Conditions amendment, the charge will end on the charge end
                date.


                Values:


                * `Subscription_End`

                * `Fixed_Period`

                * `Specific_End_Date`

                * `One_Time`
              type: string
            excludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude rate plan charge related invoice items,
                invoice item adjustments, credit memo items, and debit memo
                items from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled.
              type: boolean
            excludeItemBookingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude rate plan charges from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled.
              type: boolean
            includedUnits:
              description: >
                Specifies the number of units in the base set of units for this
                charge. Must be >=`0`.


                Available for the following charge type for the Overage charge
                model:


                * Usage-based
              type: number
            isAllocationEligible:
              description: >
                This field is used to identify if the charge segment is
                allocation

                eligible in revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            isUnbilled:
              description: >
                This field is used to dictate how to perform the accounting
                during

                revenue recognition.



                **Note**: The field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> feature enabled. To enable
                this field, submit a request at <a
                href="https://support.zuora.com/" target="_blank">Zuora Global
                Support</a>.
              type: boolean
            listPriceBase:
              description: >
                The list price base for the product rate plan charge.


                Values:


                * `Per_Billing_Period`

                * `Per_Month`

                * `Per_Week`

                * `Per_Year`

                * `Per_Specific_Months`


                Available for the following charge type for the Flat Fee, Per
                Unit, Volume Pricing, and Tiered Pricing charge models:


                * Recurring
              type: string
            number:
              description: >
                Unique number that identifies the charge. System-generated if
                not provided.
              type: string
            numberOfPeriods:
              description: >
                Specifies the number of periods to use when calculating charges
                in an overage smoothing charge model.


                Available for the following charge type for the Overage and
                Tiered with Overage charge models:


                * Usage-based
              format: int64
              type: integer
            originalOrderDate:
              description: >
                The date when the rate plan charge is created through an order
                or amendment. This field is not updatable.


                This field is to standardize the booking date information to
                increase audit ability and traceability of data between Zuora
                Billing and Zuora Revenue. It is mapped as the booking date for
                a sale order line in Zuora Revenue.
              format: date
              type: string
            overagePrice:
              description: >
                Price for units over the allowed amount. 


                Available for the following charge type for the Overage and
                Tiered with Overage charge models:


                * Usage-based
              type: number
            overageUnusedUnitsCreditOption:
              description: >
                Determines whether to credit the customer with unused units of
                usage.


                Values:


                * `NoCredit`

                * `CreditBySpecificRate`


                Available for the following charge type for the Overage and
                Tiered with Overage charge models:


                * Usage-based
              type: string
            price:
              description: >
                Price for units in the subscription rate plan.


                Supports all charge types for the Flat Fee and Per Unit charge
                models
              type: number
            priceChangeOption:
              description: >
                Applies an automatic price change when a termed subscription is
                renewed. The Zuora Billing Admin setting Enable Automatic Price
                Change When Subscriptions are Renewed?  must be set to Yes to
                use this field.  See Define Default Subscription Settings for
                more information on setting this option.


                Values:


                * `NoChange` (default)

                * `SpecificPercentageValue`

                * `UseLatestProductCatalogPricing`


                Available for the following charge types:


                * Recurring

                * Usage-based

                * Not available for the Fixed-Amount Discount charge model.
              type: string
            priceIncreasePercentage:
              description: >
                Specifies the percentage to increase or decrease the price of a
                termed subscription's renewal. Required if you set the
                `PriceChangeOption` field to `SpecificPercentageValue`.


                Decimal between -100 and 100.


                Available for the following charge types:


                * Recurring

                * Usage-based


                Not available for the Fixed-Amount Discount charge model.
              type: number
            productRatePlanChargeId:
              description: ''
              type: string
            productRatePlanChargeNumber:
              description: >-
                Number of a product rate-plan charge for this
                subscription.                     
              type: string
            quantity:
              description: >
                Number of units. Must be >=`0`.


                Available for the following charge types for the Per Unit,
                Volume Pricing, and Tiered Pricing charge models:


                * One-time

                * Recurring
              type: number
            ratingGroup:
              description: >
                Specifies a rating group based on which usage records are rated.


                Possible values:


                - `ByBillingPeriod` (default): The rating is based on all the
                usages in a billing period.

                - `ByUsageStartDate`: The rating is based on all the usages on
                the same usage start date. 

                - `ByUsageRecord`: The rating is based on each usage record.

                - `ByUsageUpload`: The rating is based on all the  usages in a
                uploaded usage file (`.xls` or `.csv`).

                - `ByGroupId`: The rating is based on all the usages in a custom
                group.


                **Note:** 

                - The `ByBillingPeriod` value can be applied for all charge
                models. 

                - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload`
                values can only be applied for per unit, volume pricing, and
                tiered pricing charge models. 

                - The `ByGroupId` value is only available if you have the Active
                Rating feature enabled.

                - Use this field only for Usage charges. One-Time Charges and
                Recurring Charges return `NULL`.
              type: string
            specificBillingPeriod:
              description: >
                Specifies the number of month or week for the charges billing
                period. Required if you set the value of the `billingPeriod`
                field to `Specific_Months` or `Specific_Weeks`.


                Available for the following charge types:


                * Recurring

                * Usage-based
              format: int64
              type: integer
            specificEndDate:
              description: >
                Defines when the charge ends after the charge trigger date.


                This field is only applicable when the `endDateCondition` field
                is set to `Specific_End_Date`.


                If the subscription ends before the specific end date, the
                charge ends when the subscription ends. But if the subscription
                end date is subsequently changed through a Renewal, or Terms and
                Conditions amendment, the charge will end on the specific end
                date.
              format: date
              type: string
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.


                **Note**: 
                  - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
                  - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`.
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              description: >
                Container for Volume, Tiered or Tiered with Overage charge
                models. Supports the following charge types:


                * One-time

                * Recurring

                * Usage-based
              items:
                $ref: '#/components/schemas/POSTTierType'
              type: array
            triggerDate:
              description: >
                Specifies when to start billing the customer for the charge.
                Required if the `triggerEvent` field is set to `USD`.
              format: date
              type: string
            triggerEvent:
              description: |
                Specifies when to start billing the customer for the charge.

                Values:

                * `UCE`
                * `USA`
                * `UCA`
                * `USD`
              type: string
            unusedUnitsCreditRates:
              description: >
                Specifies the rate to credit a customer for unused units of
                usage. This field applies only for overage charge models when
                the `OverageUnusedUnitsCreditOption` field is set to
                `CreditBySpecificRate`.


                Available for the following charge type for the Overage and
                Tiered with Overage charge models:


                * Usage-based
              type: number
            upToPeriods:
              description: >
                The period type used to define when the charge ends. 


                Values:


                * `Billing_Periods`

                * `Days`

                * `Weeks`

                * `Months`

                * `Years`


                You must use this field together with the `upToPeriods` field to
                specify the time period.


                This field is applicable only when the `endDateCondition` field
                is set to `Fixed_Period`. 
              format: int64
              type: integer
            upToPeriodsType:
              description: >
                The period type used to define when the charge ends. 


                Values:


                * `Billing_Periods`

                * `Days`

                * `Weeks`

                * `Months`

                * `Years`


                You must use this field together with the `upToPeriods` field to
                specify the time period.


                This field is applicable only when the `endDateCondition` field
                is set to `Fixed_Period`. 
              type: string
          required:
            - productRatePlanChargeId
          type: object
        - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
      title: chargeOverrides
    PUTSrpAddType:
      allOf:
        - properties:
            bookingDate:
              description: >
                The booking date that you want to set for the amendment
                contract. The booking date of an amendment is the equivalent of
                the order date of an order. This field must be in the
                `yyyy-mm-dd` format. The default value is the current date when
                you make the API call.            
              format: date
              type: string
            chargeOverrides:
              description: >
                This optional container is used to override the quantity of one
                or more product rate plan charges for this subscription.
              items:
                $ref: '#/components/schemas/PUTScAddType'
              type: array
            contractEffectiveDate:
              description: >
                The date when the amendment changes take effect. The format of
                the date is yyyy-mm-dd.


                If there is already a future-dated Update Product amendment on
                the subscription, the `specificUpdateDate` field will be used
                instead of this field to specify when the Update Product
                amendment takes effect.
              format: date
              type: string
            customerAcceptanceDate:
              description: >
                The date when the customer accepts the contract in yyyy-mm-dd
                format.


                If this field is not set:


                * If the `serviceActivationDate` field is not set, the value of
                this field is set to be the contract effective date.

                * If the `serviceActivationDate` field is set, the value of this
                field is set to be the service activation date.


                The billing trigger dates must follow this rule:


                contractEffectiveDate <= serviceActivationDate <=
                contractAcceptanceDate
              format: date
              type: string
            externalCatalogPlanId:
              description: >
                An external ID of the product rate plan to be added. You can use
                this field to specify a product rate plan that is imported from
                an external system. The value of the `externalCatalogPlanId`
                field must match one of the values that are predefined in the
                `externallyManagedPlanIds` field on a product rate plan.


                **Note:** If both `externalCatalogPlanId` and
                `productRatePlanId` are provided. They must point to the same
                product rate plan. Otherwise, the request would fail.
              type: string
            externalIdSourceSystem:
              description: >
                The ID of the external source system. You can use this field and
                `externalCatalogPlanId` to specify a product rate plan that is
                imported from an external system.


                **Note:** If both `externalCatalogPlanId`,
                `externalIdSourceSystem` and `productRatePlanId` are provided.
                They must point to the same product rate plan. Otherwise, the
                request would fail.
              type: string
            externallyManagedPlanId:
              description: >
                Indicates the unique identifier for the rate plan purchased on a
                third-party store. This field is used to represent a
                subscription rate plan created through third-party stores.
              type: string
            productRatePlanId:
              description: |
                ID of a product rate plan for this subscription
              type: string
            productRatePlanNumber:
              description: |
                Number of a product rate plan for this subscription
              type: string
            serviceActivationDate:
              description: >
                The date when the new product in the subscription is activated
                in yyyy-mm-dd format.


                You must specify a Service Activation date if the Customer
                Acceptance date is set. If the Customer Acceptance date is not
                set, the value of the `serviceActivationDate` field defaults to
                be the Contract Effective Date.


                The billing trigger dates must follow this rule:


                contractEffectiveDate <= serviceActivationDate <=
                contractAcceptanceDate
              format: date
              type: string
          required:
            - contractEffectiveDate
          type: object
        - $ref: '#/components/schemas/RatePlanObjectCustomFields'
      title: add
    PUTSrpChangeType:
      allOf:
        - properties:
            bookingDate:
              description: >
                The booking date that you want to set for the amendment
                contract. The booking date of an amendment is the equivalent of
                the order date of an order. This field must be in the
                `yyyy-mm-dd` format. The default value is the current date when
                you make the API call. 
              format: date
              type: string
            chargeOverrides:
              description: >-
                This optional container is used to override one or more product
                rate plan charges for this subscription.
              items:
                $ref: '#/components/schemas/PUTScAddType'
              type: array
            contractEffectiveDate:
              description: Effective date of the new subscription, as yyyy-mm-dd.
              format: date
              type: string
            customerAcceptanceDate:
              description: >
                The date when the customer accepts the contract in yyyy-mm-dd
                format.

                When this field is not set:

                * If the `serviceActivationDate` field is not set, the value of
                this field

                is set to be the contract effective date.

                * If the `serviceActivationDate` field is set, the value of this
                field is

                set to be the service activation date.


                The billing trigger dates must follow this rule:
                contractEffectiveDate <= serviceActivationDate <=
                contractAcceptanceDate
              format: date
              type: string
            effectivePolicy:
              description: |
                The default value for the `effectivePolicy` field is as follows:
                  * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
                  * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
                  * Otherwise, the effective policy is `SpecificDate` by default.

                **Notes**: 
                  * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates" target="_blank">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period.
                  * When setting this field to `SpecificDate`, you must also set the `contractEffectiveDate` field.
              enum:
                - EffectiveImmediately
                - EffectiveEndOfBillingPeriod
                - SpecificDate
              type: string
            externalCatalogPlanId:
              description: >
                An external ID of the rate plan to be removed. You can use this
                field to specify an existing rate plan in your subscription. The
                value of the `externalCatalogPlanId` field must match one of the
                values that are predefined in the `externallyManagedPlanIds`
                field on a product rate plan. However, if there are multiple
                rate plans with the same `productRatePlanId` value existing in
                the subscription, you must use the `ratePlanId` field to remove
                the rate plan. The `externalCatalogPlanId` field cannot be used
                to distinguish multiple rate plans in this case.


                **Note:** Provide only one of `externalCatalogPlanId`,
                `ratePlanId` or `productRatePlanId`. If more than one field is
                provided then the request would fail.
              type: string
            externalIdSourceSystem:
              description: >
                The ID of the external source system. You can use this field and
                `externalCatalogPlanId` to specify a product rate plan that is
                imported from an external system.


                **Note:** If both `externalCatalogPlanId`,
                `externalIdSourceSystem` and `productRatePlanId` are provided.
                They must point to the same product rate plan. Otherwise, the
                request would fail.
              type: string
            newExternalCatalogPlanId:
              description: >
                An external ID of the product rate plan to be added. You can use
                this field to specify a product rate plan that is imported from
                an external system. The value of the `externalCatalogPlanId`
                field must match one of the values that are predefined in the
                `externallyManagedPlanIds` field on a product rate plan.


                **Note:** Provide only one of `newExternalCatalogPlanId` or
                `newProductRatePlanId`. If both fields are provided then the
                request would fail.
              type: string
            newExternalIdSourceSystem:
              description: >
                The ID of the external source system. You can use this field and
                `newExternalCatalogPlanId` to specify a product rate plan that
                is imported from an external system.


                **Note:** If both `newExternalCatalogPlanId`,
                `newExternalIdSourceSystem` and `newProductRatePlanId` are
                provided. They must point to the same product rate plan.
                Otherwise, the request would fail.
              type: string
            newProductRatePlanId:
              description: ID of a product rate plan for this subscription.
              type: string
            newProductRatePlanNumber:
              description: Number of a product rate plan for this subscription.
              type: string
            productRatePlanId:
              description: >
                ID of the product rate plan that the removed rate plan is based
                on.
              type: string
            productRatePlanNumber:
              description: 'Number of a product rate plan for this subscription.    '
              type: string
            ratePlanId:
              description: >
                ID of a rate plan to remove. Note that the removal of a rate
                plan through the Change Plan amendment supports the function of
                <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend/E_Amendments/EB_Remove_rate_plan_on_subscription_before_future-dated_removals"
                target="_blank">removal before future-dated removals</a>, as in
                a Remove Product amendment.
              type: string
            resetBcd:
              default: false
              description: >
                If resetBcd is true then reset the Account BCD to the effective
                date; if it is false keep the original BCD.
              type: boolean
            serviceActivationDate:
              description: >-
                The date when the change in the subscription is activated in
                yyyy-mm-dd format. You must specify a Service Activation date if
                the Customer Acceptance date is set. If the Customer Acceptance
                date is not set, the value of the `serviceActivationDate` field
                defaults to be the Contract Effective Date. The billing trigger
                dates must follow this rule: contractEffectiveDate <=
                serviceActivationDate <= contractAcceptanceDate
              format: date
              type: string
            subType:
              description: >
                Use this field to choose the sub type for your change plan
                amendment. 


                However, if you do not set this field, the field will be
                automatically generated by the system according to the following
                rules:


                When the old and new rate plans are within the same Grading
                catalog group:

                * If the grade of new plan is greater than that of the old plan,
                this is an "Upgrade".

                * If the grade of new plan is less than that of the old plan,
                this is a "Downgrade".

                * If the grade of new plan equals that of the old plan, this is
                a "Crossgrade".


                When the old and new rate plans are not in the same Grading
                catalog group, or either has no group, this is "PlanChanged".
              enum:
                - Upgrade
                - Downgrade
                - Crossgrade
                - PlanChanged
              type: string
            subscriptionRatePlanNumber:
              description: 'Number of a rate plan for this subscription.  '
              type: string
          type: object
        - $ref: '#/components/schemas/RatePlanObjectCustomFields'
      title: change
    PUTSrpRemoveType:
      properties:
        bookingDate:
          description: >
            The booking date that you want to set for the amendment contract.
            The booking date of an amendment is the equivalent of the order date
            of an order. This field must be in the `yyyy-mm-dd` format. The
            default value is the current date when you make the API call. 
          format: date
          type: string
        contractEffectiveDate:
          description: |
            Effective date of the new subscription, as yyyy-mm-dd.
          format: date
          type: string
        customerAcceptanceDate:
          description: >
            The date when the customer accepts the contract in yyyy-mm-dd
            format.


            If this field is not set:


            * If the `serviceActivationDate` field is not set, the value of this
            field is set to be the contract effective date.

            * If the `serviceActivationDate` field is set, the value of this
            field is set to be the service activation date.


            The billing trigger dates must follow this rule:


            contractEffectiveDate <= serviceActivationDate <=
            contractAcceptanceDate
          format: date
          type: string
        externalCatalogPlanId:
          description: >
            An external ID of the rate plan to be removed. You can use this
            field to specify an existing rate plan in your subscription. The
            value of the `externalCatalogPlanId` field must match one of the
            values that are predefined in the `externallyManagedPlanIds` field
            on a product rate plan. However, if there are multiple rate plans
            with the same `productRatePlanId` value existing in the
            subscription, you must use the `ratePlanId` field to remove the rate
            plan. The `externalCatalogPlanId` field cannot be used to
            distinguish multiple rate plans in this case.


            **Note:** If both `externalCatalogPlanId` and `ratePlanId` are
            provided. They must point to the same product rate plan. Otherwise,
            the request would fail.
          type: string
        externalIdSourceSystem:
          description: >
            The ID of the external source system. You can use this field and
            `externalCatalogPlanId` to specify a product rate plan that is
            imported from an external system.


            **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem`
            and `productRatePlanId` are provided. They must point to the same
            product rate plan. Otherwise, the request would fail.
          type: string
        productRatePlanNumber:
          description: |
            Number of a product rate plan for this subscription.
          type: string
        ratePlanId:
          description: >
            ID of a rate plan for this subscription. This can be the latest
            version or any history version of ID.
          type: string
        serviceActivationDate:
          description: >
            The date when the remove amendment is activated in yyyy-mm-dd
            format.


            You must specify a Service Activation date if the Customer
            Acceptance date is set. If the Customer Acceptance date is not set,
            the value of the `serviceActivationDate` field defaults to be the
            Contract Effective Date.


            The billing trigger dates must follow this rule:


            contractEffectiveDate <= serviceActivationDate <=
            contractAcceptanceDate
          format: date
          type: string
        subscriptionRatePlanNumber:
          description: |
            Number of a rate plan for this subscription.
          type: string
      required:
        - contractEffectiveDate
      title: remove
      type: object
    PUTScUpdateType:
      allOf:
        - properties:
            billingPeriodAlignment:
              description: >
                Aligns charges within the same subscription if multiple charges
                begin on different dates.


                Values:


                * `AlignToCharge`

                * `AlignToSubscriptionStart`

                * `AlignToTermStart`


                Available for the following charge types:


                * Recurring

                * Usage-based
              type: string
            chargeModelConfiguration:
              $ref: '#/components/schemas/ChargeModelConfigurationType'
            description:
              description: |
                Description of the charge.
              type: string
            includedUnits:
              description: >
                Specifies the number of units in the base set of units for this
                charge. Must be >=0.


                Available for the following charge type for the Overage charge
                model:

                * Usage-based
              type: number
            overagePrice:
              description: >
                Price for units over the allowed amount. 


                Available for the following charge type for the Overage and
                Tiered with Overage charge models:


                * Usage-based
              type: number
            price:
              description: >
                Price for units in the subscription rate plan.


                Supports all charge types for the Flat Fee and Per Unit charge
                models
              type: number
            priceChangeOption:
              description: >
                Applies an automatic price change when a termed subscription is
                renewed. The Billing Admin setting **Enable Automatic Price
                Change When Subscriptions are Renewed?** must be set to Yes to
                use this field.


                Values:


                * `NoChange` (default)

                * `SpecificPercentageValue`

                * `UseLatestProductCatalogPricing`


                Available for the following charge types:


                * Recurring

                * Usage-based


                Not available for the Fixed-Amount Discount charge model.
              type: string
            priceIncreasePercentage:
              description: >
                Specifies the percentage to increase or decrease the price of a
                termed subscription's renewal. Required if you set the
                `PriceChangeOption` field to `SpecificPercentageValue`.


                Decimal between `-100` and `100`.


                Available for the following charge types:


                * Recurring

                * Usage-based


                Not available for the Fixed-Amount Discount charge model.
              type: number
            quantity:
              description: |
                Quantity of units; must be greater than zero.
              type: number
            ratePlanChargeId:
              description: >
                ID of a rate-plan charge for this subscription. It can be the
                latest version or any history version of ID.
              type: string
            tiers:
              description: >
                Container for Volume, Tiered or Tiered with Overage charge
                models. Supports the following charge types:


                * One-time

                * Recurring

                * Usage-based
              items:
                $ref: '#/components/schemas/POSTTierType'
              type: array
            triggerDate:
              description: >
                Specifies when to start billing the customer for the charge.
                Required if the `triggerEvent` field is set to USD.


                `triggerDate` cannot be updated for the following using the REST
                update subscription call:


                * One-time charge type

                * Discount-Fixed Amount charge model

                * Discount-Percentage charge model
              format: date
              type: string
            triggerEvent:
              description: >
                Specifies when to start billing the customer for the charge.


                Values:


                * `UCE`

                * `USA`

                * `UCA`

                * `USD`


                This is the date when charge changes in the REST request become
                effective.


                `triggerEvent` cannot be updated for the following using the
                REST update subscription call:


                * One-time charge type

                * Discount-Fixed Amount charge model

                * Discount-Percentage charge model
              type: string
          required:
            - ratePlanChargeId
          type: object
        - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
      title: chargeUpdateDetails
    PUTSrpUpdateType:
      allOf:
        - properties:
            bookingDate:
              description: >
                The booking date that you want to set for the amendment
                contract. The booking date of an amendment is the equivalent of
                the order date of an order. This field must be in the
                `yyyy-mm-dd` format. The default value is the current date when
                you make the API call. 
              format: date
              type: string
            chargeUpdateDetails:
              description: |
                Container for one or more product rate plan charges. 
              items:
                $ref: '#/components/schemas/PUTScUpdateType'
              type: array
            contractEffectiveDate:
              description: >
                The date when the amendment changes take effect. The format of
                the date is yyyy-mm-dd.


                If there is already a future-dated Update Product amendment on
                the subscription, the `specificUpdateDate` field will be used
                instead of this field to specify when the Update Product
                amendment takes effect.
              format: date
              type: string
            customerAcceptanceDate:
              description: >
                The date when the customer accepts the contract in yyyy-mm-dd
                format.


                If this field is not set:


                * If the `serviceActivationDate` field is not set, the value of
                this field is set to be the contract effective date.

                * If the `serviceActivationDate` field is set, the value of this
                field is set to be the service activation date.


                The billing trigger dates must follow this rule:


                contractEffectiveDate <= serviceActivationDate <=
                contractAcceptanceDate
              format: date
              type: string
            externalCatalogPlanId:
              description: >
                An external ID of the rate plan to be updated. You can use this
                field to specify an existing rate plan in your subscription. The
                value of the `externalCatalogPlanId` field must match one of the
                values that are predefined in the `externallyManagedPlanIds`
                field on a product rate plan. However, if there are multiple
                rate plans with the same `productRatePlanId` value existing in
                the subscription, you must use the `ratePlanId` field to update
                the rate plan. The `externalCatalogPlanId` field cannot be used
                to distinguish multiple rate plans in this case.


                **Note:** If both `externalCatalogPlanId` and `ratePlanId` are
                provided. They must point to the same product rate plan.
                Otherwise, the request would fail.
              type: string
            externalIdSourceSystem:
              description: >
                The ID of the external source system. You can use this field and
                `externalCatalogPlanId` to specify a product rate plan that is
                imported from an external system.


                **Note:** If both `externalCatalogPlanId`,
                `externalIdSourceSystem` and `productRatePlanId` are provided.
                They must point to the same product rate plan. Otherwise, the
                request would fail.
              type: string
            externallyManagedPlanId:
              description: >
                Indicates the unique identifier for the rate plan purchased on a
                third-party store. This field is used to represent a
                subscription rate plan created through third-party stores.
              type: string
            productRatePlanNumber:
              description: |
                Number of a product rate plan for this subscription.
              type: string
            ratePlanId:
              description: >
                ID of a rate plan for this subscription. This can be the latest
                version or any history version of ID.
              type: string
            serviceActivationDate:
              description: >
                The date when the update amendment is activated in yyyy-mm-dd
                format.


                You must specify a Service Activation date if the Customer
                Acceptance date is set. If the Customer Acceptance date is not
                set, the value of the `serviceActivationDate` field defaults to
                be the Contract Effective Date.


                The billing trigger dates must follow this rule:


                contractEffectiveDate <= serviceActivationDate <=
                contractAcceptanceDate
              format: date
              type: string
            specificUpdateDate:
              description: >
                The date when the Update Product amendment takes effect. This
                field is only applicable if there is already a future-dated
                Update Product amendment on the subscription. The format of the
                date is yyyy-mm-dd.


                Required only for Update Product amendments if there is already
                a future-dated Update Product amendment on the subscription.
              format: date
              type: string
            subscriptionRatePlanNumber:
              description: |
                Number of a rate plan for this subscription.
              type: string
          required:
            - contractEffectiveDate
          type: object
        - $ref: '#/components/schemas/RatePlanObjectCustomFields'
      title: update
    PUTSubscriptionType:
      allOf:
        - properties:
            add:
              description: |
                Container for adding one or more rate plans.
              items:
                $ref: '#/components/schemas/PUTSrpAddType'
              type: array
            applicationOrder:
              description: >
                The priority order to apply credit memos and/or unapplied
                payments to an invoice. Possible item values are: `CreditMemo`,
                `UnappliedPayment`.


                **Note:**
                  - This field is valid only if the `applyCredit` field is set to `true`.
                  - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
                  - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
              items:
                type: string
              type: array
            applyCredit:
              description: >
                Whether to automatically apply credit memos or unapplied
                payments, or both to an invoice.


                If the value is `true`, the credit memo or unapplied payment, or
                both will be automatically applied to the invoice. If no value
                is specified or the value is `false`, no action is taken.


                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.
              type: boolean
            applyCreditBalance:
              description: >
                Whether to automatically apply a credit balance to an invoice.


                If the value is `true`, the credit balance is applied to the
                invoice. If the value is `false`, no action is taken.



                To view the credit balance adjustment, retrieve the details of
                the invoice using the Get Invoices method.


                Prerequisite: `invoice` must be `true`. 


                **Note:** 
                  - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.
                  - This field is deprecated if you have the Invoice Settlement feature enabled.
              type: boolean
            autoRenew:
              description: >
                If `true`, this subscription automatically renews at the end of
                the subscription term. Default is `false`.
              type: boolean
            bookingDate:
              description: >
                The booking date that you want to set for the contract when you
                change the `termType` field of the subscription and as a result
                get a new version of subscription created. The booking date of
                an amendment is the equivalent of the order date of an order.
                This field must be in the `yyyy-mm-dd` format. The default value
                is the current date when you make the API call. 
              format: date
              type: string
            change:
              description: >
                Use this field to change one or more rate plans - to replace the
                existing rate plans in a subscription with other rate plans.


                **Note**: Changing rate plans is currently not supported for
                the  <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> feature. When
                Billing - Revenue Integration is enabled, changing rate plans
                will no longer be applicable in Zuora Billing.
              items:
                $ref: '#/components/schemas/PUTSrpChangeType'
              type: array
            collect:
              default: false
              description: >
                Collects an automatic payment for a subscription. The collection
                generated in this operation is only for this subscription, not
                for the entire customer account.


                If the value is `true`, the automatic payment is collected. If
                the value is `false`, no action is taken.


                Prerequisite: The `invoice` or `runBilling` field must be
                `true`. 


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `196.0` or a later available version.
              type: boolean
            creditMemoReasonCode:
              description: >-
                A code identifying the reason for the credit memo transaction
                that is generated by the request. The value must be an existing
                reason code. If you do not pass the field or pass the field with
                empty value, Zuora uses the default reason code.
              type: string
            currentTerm:
              description: >
                The length of the period for the current subscription term. If
                `termType` is `TERMED`, this field is required and must be
                greater than `0`. If `termType` is `EVERGREEN`, this value is
                ignored.
              format: int64
              type: integer
            currentTermPeriodType:
              description: >
                The period type for the current subscription term.


                This field is used with the `CurrentTerm` field to specify the
                current subscription term.


                Values are:


                * `Month` (default)

                * `Year`

                * `Day`

                * `Week`
              type: string
            documentDate:
              description: >
                The date of the billing document, in `yyyy-mm-dd` format. It
                represents the invoice date for invoices, credit memo date for
                credit memos, and debit memo date for debit memos.


                - If this field is specified, the specified date is used as the
                billing document date. 

                - If this field is not specified, the date specified in the
                `targetDate` is used as the billing document date.
              format: date
              type: string
            externallyManagedBy:
              description: >
                An enum field on the Subscription object to indicate the name of
                a third-party store. This field is used to represent
                subscriptions created through third-party stores.
              enum:
                - Amazon
                - Apple
                - Google
                - Roku
              type: string
            includeExistingDraftDocItems:
              description: >
                Specifies whether to include draft invoice items in subscription
                previews.

                Values are:


                * `true` (default). Includes draft invoice items in the preview
                result.

                * `false`. Excludes draft invoice items in the preview result.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `207.0` or a later available version.
              type: boolean
            invoiceSeparately:
              description: >
                Separates a single subscription from other subscriptions and
                invoices the charge independently. 


                If the value is `true`, the subscription is billed separately
                from other subscriptions. If the value is `false`, the
                subscription is included with other subscriptions in the account
                invoice.


                The default value is `false`.

                Prerequisite: The default subscription setting Enable
                Subscriptions to be Invoiced Separately must be set to Yes.
              type: boolean
            notes:
              description: |
                The notes for the subscription.
              maxLength: 1000
              type: string
            preview:
              description: >
                If `true` the update is made in preview mode. The default
                setting is `false`.
              type: boolean
            previewType:
              description: >
                The type of preview you will receive. 


                **Note**: If your API minor version is earlier than `206.0` or
                you specify the `Zuora-Version` header for this request to
                `206.0` or earlier, the following values are supported for the
                `previewType` field:
                  - `InvoiceItem` (default)
                  - `ChargeMetrics`
                  - `InvoiceItemChargeMetrics`
              enum:
                - LegalDoc
                - ChargeMetrics
                - LegalDocChargeMetrics
              default: LegalDoc
              type: string
            remove:
              description: |
                Container for removing one or more rate plans.
              items:
                $ref: '#/components/schemas/PUTSrpRemoveType'
              type: array
            renewalSetting:
              description: >
                Specifies whether a termed subscription will remain `TERMED` or
                change to `EVERGREEN` when it is renewed. 


                Values are:


                * `RENEW_WITH_SPECIFIC_TERM` (default)

                * `RENEW_TO_EVERGREEN`
              type: string
            renewalTerm:
              description: >
                The length of the period for the subscription renewal term.
                Default is `0`.
              format: int64
              type: integer
            renewalTermPeriodType:
              description: >

                The period type for the subscription renewal term.


                This field is used with the `renewalTerm` field to specify the
                subscription renewal term.


                Values are:


                * `Month` (default)

                * `Year`

                * `Day`

                * `Week`
              type: string
            runBilling:
              default: false
              description: >
                Creates an invoice for a subscription. If you have the Invoice
                Settlement feature enabled, a credit memo might also be created
                based on the [invoice and credit memo generation
                rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).  



                The billing documents generated in this operation is only for
                this subscription, not for the entire customer account.


                This field is available only if you are on the latest Zuora API
                version, or you set the `Zuora-Version` request header to
                `211.0` or a later available version.


                Possible values:


                - `true`: An invoice is created. If you have the Invoice
                Settlement feature enabled, a credit memo might also be created.



                - `false`: No invoice is created.
              type: boolean
            targetDate:
              description: >
                Date through which to calculate charges if an invoice or a
                credit memo is generated, as

                yyyy-mm-dd. Default is current date.



                **Note:** The credit memo is only available if you have the
                Invoice Settlement feature enabled.



                This field is available only if you are on the latest Zuora API
                minor version, or you set the `Zuora-Version` request header to
                `211.0` or a  later available version.
              format: date
              type: string
            termStartDate:
              description: >
                Date the subscription term begins, as yyyy-mm-dd. If this is a
                renewal subscription, this date is different from the
                subscription start date. 
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
            update:
              description: |
                Container for updating one or more rate plans.
              items:
                $ref: '#/components/schemas/PUTSrpUpdateType'
              type: array
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectQTFields'
        - $ref: '#/components/schemas/SubscriptionObjectNSFields'
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      example:
        autoRenew: true
    PUTSubscriptionPreviewInvoiceItemsType:
      properties:
        chargeAmount:
          description: >
            The amount of the charge. This amount doesn't include taxes unless
            the charge's tax mode is inclusive.
          type: number
        chargeDescription:
          description: |
            Description of the charge.
          type: string
        chargeName:
          description: |
            Name of the charge
          type: string
        productName:
          description: |
            Name of the product associated with this item.
          type: string
        productRatePlanChargeId:
          description: ''
          type: string
        quantity:
          description: |
            Quantity of this item.
          type: number
        serviceEndDate:
          description: >
            End date of the service period for this item, i.e., the last day of
            the period, as yyyy-mm-dd.
          format: date
          type: string
        serviceStartDate:
          description: >
            Service start date as yyyy-mm-dd. If the charge is a one-time fee,
            this is the date of that charge.
          format: date
          type: string
        taxationItems:
          description: >-
            List of taxation items.

            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `315.0` or a later available version. 
          items:
            $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType'
          type: array
        unitOfMeasure:
          description: ''
          type: string
      title: invoiceItems
      type: object
    PUTSubscriptionResponseType:
      properties:
        chargeMetrics:
          description: >
            Container for charge metrics. This field is available only if the
            `preview` field in the request body is `true`.
          properties:
            dmrr:
              description: |
                Change in total contract value.
              type: string
            dtcv:
              description: |
                Change in monthly recurring revenue.
              type: string
            mrr:
              description: |
                Monthly recurring revenue.
              type: string
            number:
              description: >
                The charge number of the subscription. Only available for update
                subscription.
              type: string
            originRatePlanId:
              description: |
                The origin rate plan ID. Only available for update subscription.
              type: string
            originalId:
              description: >
                The original rate plan charge ID. Only available for update
                subscription.
              type: string
            productRatePlanChargeId:
              description: ''
              type: string
            productRatePlanId:
              description: ''
              type: string
            tcv:
              description: |
                Total contract value.
              type: string
          type: object
        creditMemo:
          description: >
            Container for credit memos. This field is available only if the
            `preview` field in the request body is `true`.


            **Note:** This container is only available if you set the Zuora REST
            API minor version to 207.0 or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            in the request header, and you have  [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information. 
          properties:
            amount:
              description: Credit memo amount.
              format: double
              type: number
            amountWithoutTax:
              description: Credit memo amount minus tax.
              format: double
              type: number
            creditMemoItems:
              description: ''
              items:
                $ref: >-
                  #/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType
              type: array
            taxAmount:
              description: Tax amount on the credit memo.
              format: double
              type: number
          type: object
        creditMemoId:
          description: >
            The credit memo ID. This field is available only if the `preview`
            field in the request body is `false` and a credit memo is generated
            during the update.


            **Note:** This container is only available if you set the Zuora REST
            API minor version to 207.0 or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            in the request header, and you have  [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        invoice:
          description: >
            Container for invoices. This field is available only if the
            `preview` field in the request body is `true`.



            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `207.0` or

            [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
            Also, the response structure is changed and the following invoice
            related response fields are moved to this **invoice** container:
              
               * amount
               * amountWithoutTax
               * taxAmount
               * invoiceItems
               * targetDate
          properties:
            amount:
              description: Invoice amount.
              format: double
              type: number
            amountWithoutTax:
              description: |
                Invoice amount minus tax.
              format: double
              type: number
            invoiceItems:
              description: |
                Container for invoice items.
              items:
                $ref: '#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType'
              type: array
            targetDate:
              description: >
                Date through which to calculate charges if an invoice is
                generated, as yyyy-mm-dd. Default is current date.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `207.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). 
              format: date
              type: string
            taxAmount:
              description: |
                The tax amount of the invoice.
              format: double
              type: number
          type: object
        invoiceId:
          description: >
            The ID of the generated invoice.


            This field is available only if the `preview` field in the request
            body is `false` and an invoice is generated during the update.
          type: string
        invoiceItems:
          description: >
            Container for invoice items. This field is available only if the
            `preview` field in the request body is `true`.
          items:
            $ref: '#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType'
          type: array
        paidAmount:
          description: |
            Payment amount, if a payment is collected
          type: number
        paymentId:
          description: |
            Payment ID, if a payment is collected.
          type: string
        subscriptionId:
          description: |
            The ID of the resulting new subscription.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        targetDate:
          description: >
            Date through which to calculate charges if an invoice is generated,
            as yyyy-mm-dd. Default is current date. This field is available only
            if the `preview` field in the request body is `true`.


            **Note:** This field is only available if you are on the latest
            Zuora API minor version, or you set the `Zuora-Version` request
            header to `207.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          format: date
          type: string
        taxAmount:
          description: >
            Tax amount on the invoice. This field is available only if the
            `preview` field in the request body is `true`.
          type: number
        totalDeltaMrr:
          description: >
            Change in the subscription monthly recurring revenue as a result of
            the update.
          type: number
        totalDeltaTcv:
          description: >
            Change in the total contracted value of the subscription as a result
            of the update.
          type: number
      type: object
    GETSubscriptionTypeWithSuccess:
      allOf:
        - properties:
            accountId:
              description: The ID of the account associated with this subscription.
              type: string
            accountName:
              description: The name of the account associated with this subscription.
              type: string
            accountNumber:
              description: The number of the account associated with this subscription.
              type: string
            autoRenew:
              description: >
                If `true`, the subscription automatically renews at the end of
                the term. Default is `false`.
              type: boolean
            billToContact:
              $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact'
            cancelReason:
              description: >
                The reason for a subscription cancellation copied from the
                `changeReason` field of a Cancel Subscription order action. 


                This field contains valid value only if a subscription is
                cancelled through the Orders UI or API. Otherwise, the value for
                this field will always be `null`.
              type: string
            contractEffectiveDate:
              description: |
                Effective contract date for this subscription, as yyyy-mm-dd.
              format: date
              type: string
            contractedMrr:
              description: >
                Monthly recurring revenue of the subscription, does not count in
                the discounts.
              type: number
            contractedNetMrr:
              description: >
                Monthly recurring revenue of the subscription inclusive of all
                the discounts applicable, including the fixed-amount discounts
                and percentage discounts.
              type: number
            asOfDayGrossMrr:
              description: >
                Monthly recurring revenue of the subscription exclusive of any
                discounts applicable as of specified day.
              type: number
            asOfDayNetMrr:
              description: >
                Monthly recurring revenue of the subscription inclusive of all
                the discounts applicable, including the fixed-amount discounts
                and percentage discounts as of specified day.
              type: number
            netTotalContractedValue:
              description: >
                Total contracted value of the subscription inclusive of all the
                discounts applicable, including the fixed-amount discounts and
                percentage discounts.
              type: number
            currency:
              description: >
                The currency of the subscription.

                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currencies</a> feature enabled.
              type: string
            currentTerm:
              description: |
                The length of the period for the current subscription term.
              format: int64
              type: integer
            currentTermPeriodType:
              description: |
                The period type for the current subscription term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            customerAcceptanceDate:
              description: >
                The date on which the services or products within a subscription
                have been accepted by the customer, as yyyy-mm-dd.
              format: date
              type: string
            externallyManagedBy:
              description: >
                An enum field on the Subscription object to indicate the name of
                a third-party store. This field is used to represent
                subscriptions created through third-party stores.
              enum:
                - Amazon
                - Apple
                - Google
                - Roku
              type: string
            id:
              description: |
                Subscription ID.
              type: string
            initialTerm:
              description: |
                The length of the period for the first subscription term.
              format: int64
              type: integer
            initialTermPeriodType:
              description: |
                The period type for the first subscription term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the
                subscription.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            invoiceOwnerAccountId:
              description: ''
              type: string
            invoiceOwnerAccountName:
              description: ''
              type: string
            invoiceOwnerAccountNumber:
              description: ''
              type: string
            invoiceScheduleId:
              description: >
                The ID of the invoice schedule associated with the subscription.


                If multiple invoice schedules are created for different terms of
                a subscription, this field stores the latest invoice schedule.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: integer
            invoiceSeparately:
              description: >
                Separates a single subscription from other subscriptions and
                creates an invoice for the subscription. 


                If the value is `true`, the subscription is billed separately
                from other subscriptions. If the value is `false`, the
                subscription is included with other subscriptions in the account
                invoice.
              type: boolean
            invoiceTemplateId:
              description: |
                The ID of the invoice template associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
            invoiceTemplateName:
              description: >
                The name of the invoice template associated with the
                subscription.


                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body.
                  
              type: string
            isLatestVersion:
              description: >-
                If `true`, the current subscription object is the latest
                version.
              type: boolean
            lastBookingDate:
              description: >-
                The last booking date of the subscription object. This field is
                writable only when the subscription is newly created as a first
                version subscription. You can override the date value when
                creating a subscription through the Subscribe and Amend API or
                the subscription creation UI (non-Orders). Otherwise, the
                default value `today` is set per the user's timezone. The value
                of this field is as follows:

                * For a new subscription created by the [Subscribe and Amend
                APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),
                this field has the value of the subscription creation date.

                * For a subscription changed by an amendment, this field has the
                value of the amendment booking date.

                * For a subscription created or changed by an order, this field
                has the value of the order date. 
              format: date
              type: string
            notes:
              description: |
                A string of up to 65,535 characters.
              type: string
            orderNumber:
              description: >
                The order number of the order in which the changes on the
                subscription are made. 


                **Note:** This field is only available if you have the [Order
                Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics)
                feature enabled. If you wish to have access to the feature,
                submit a request at [Zuora Global
                Support](http://support.zuora.com/). We will investigate your
                use cases and data before enabling this feature for you.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentTerm:
              description: >
                The name of the payment term associated with the subscription.
                For example, `Net 30`. The payment term determines the due dates
                of invoices.


                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
            scheduledCancelDate:
              description: The date when the subscription is scheduled to be canceled.
              format: date
              type: string
            scheduledSuspendDate:
              description: The date when the subscription is scheduled to be suspended.
              format: date
              type: string
            scheduledResumeDate:
              description: The date when the subscription is scheduled to be resumed.
              format: date
              type: string
            ramp:
              description: |
                Ramp information associated with the subscription.
              $ref: '#/components/schemas/SubscriptionRampResponse'
              type: object
            ratePlans:
              description: |
                Container for rate plans.
              items:
                $ref: '#/components/schemas/GETSubscriptionRatePlanType'
              type: array
            renewalSetting:
              description: >
                Specifies whether a termed subscription will remain `TERMED` or
                change to `EVERGREEN` when it is renewed. 


                Values are:


                * `RENEW_WITH_SPECIFIC_TERM` (default)

                * `RENEW_TO_EVERGREEN`
              type: string
            renewalTerm:
              description: |
                The length of the period for the subscription renewal term.
              format: int64
              type: integer
            renewalTermPeriodType:
              description: |
                The period type for the subscription renewal term.

                Values are:

                * `Month` (default)
                * `Year`
                * `Day`
                * `Week`
              type: string
            revision:
              description: >
                An auto-generated decimal value uniquely tagged with a
                subscription. The value always contains one decimal place, for
                example, the revision of a new subscription is 1.0. If a further
                version of the subscription is created, the revision value will
                be increased by 1. Also, the revision value is always
                incremental regardless of deletion of subscription versions.
              type: string
            sequenceSetId:
              description: |
                The ID of the sequence set associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
              type: string
              nullable: true
            communicationProfileId:
              default: false
              description: >
                The ID of the communication profile associated with the
                subscription.


                **Note**: If you have the [Flexible Billing

                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)

                feature disabled, this field is unavailable in the request body
                and the

                value of this field is `null` in the response body.
              type: string
            sequenceSetName:
              description: |
                The name of the sequence set associated with the subscription.

                **Note**: 
                  - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, the value of this field is `null` in the response body. 
                  - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body.
              type: string
            serviceActivationDate:
              description: >
                The date on which the services or products within a subscription
                have been activated and access has been provided to the
                customer, as yyyy-mm-dd
              format: date
              type: string
            shipToContact:
              $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact'
            soldToContact:
              $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact'
            status:
              description: |
                Subscription status; possible values are:

                * `Draft`
                * `Pending Activation`
                * `Pending Acceptance`
                * `Active`
                * `Cancelled`
                * `Suspended`
              type: string
            statusHistory:
              description: |
                Container for status history.
              items:
                $ref: '#/components/schemas/GETSubscriptionStatusHistoryType'
              type: array
            subscriptionEndDate:
              description: >
                The date when the subscription term ends, where the subscription
                ends at midnight the day before.

                For example, if the `subscriptionEndDate` is 12/31/2016, the
                subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.

                This date is the same as the term end date or the cancelation
                date, as appropriate.
              format: date
              type: string
            subscriptionNumber:
              description: Subscription number.
              type: string
            subscriptionStartDate:
              description: |
                Date the subscription becomes effective.
              format: date
              type: string
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
            termEndDate:
              description: >
                Date the subscription term ends. If the subscription is
                evergreen, this is null or is the cancellation date (if one has
                been set).
              format: date
              type: string
            termStartDate:
              description: >
                Date the subscription term begins. If this is a renewal
                subscription, this date is different from the subscription start
                date.
              format: date
              type: string
            termType:
              description: |
                Possible values are: `TERMED`, `EVERGREEN`.
              type: string
            totalContractedValue:
              description: |
                Total contracted value of the subscription.
              type: number
            version:
              description: >-
                This is the subscription version automatically generated by
                Zuora Billing. Each order or amendment creates a new version of
                the subscription, which incorporates the changes made in the
                order or amendment.
              format: int64
              type: integer
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectQTFields'
        - $ref: '#/components/schemas/SubscriptionObjectNSFields'
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
    PUTRenewSubscriptionType:
      example:
        runBilling: true
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to an invoice. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
          items:
            type: string
          type: array
        applyCredit:
          description: >
            If the value is true, the credit memo or unapplied payment on the
            order account will be automatically applied to the invoices
            generated by this order. The credit memo generated by this order
            will not be automatically applied to any invoices.


            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: boolean
        applyCreditBalance:
          description: >
            Whether to automatically apply a credit balance to an invoice.


            If the value is `true`, the credit balance is applied to the
            invoice. If the value is `false`, no action is taken.



            To view the credit balance adjustment, retrieve the details of the
            invoice using the Get Invoices method.


            Prerequisite: `invoice` must be `true`. 


            **Note:** 
              - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.
              - This field is deprecated if you have the Invoice Settlement feature enabled.
          type: boolean
        collect:
          default: false
          description: >
            Collects an automatic payment for a subscription. The collection
            generated in this operation is only for this subscription, not for
            the entire customer account.


            If the value is `true`, the automatic payment is collected. If the
            value is `false`, no action is taken.


            Prerequisite: The `invoice` or `runBilling` field must be `true`. 


            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `196.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          type: boolean
        creditMemoReasonCode:
          description: >-
            A code identifying the reason for the credit memo transaction that
            is generated by the request. The value must be an existing reason
            code. If you do not pass the field or pass the field with empty
            value, Zuora uses the default reason code.
          type: string
        documentDate:
          description: >
            The date of the billing document, in `yyyy-mm-dd` format. It
            represents the invoice date for invoices, credit memo date for
            credit memos, and debit memo date for debit memos.


            - If this field is specified, the specified date is used as the
            billing document date. 

            - If this field is not specified, the date specified in the
            `targetDate` is used as the billing document date.
          format: date
          type: string
        orderDate:
          description: >
            The date when the order is signed. If no additinal
            contractEffectiveDate is provided, this order will use this order
            date as the contract effective date.

            This field must be in the `yyyy-mm-dd` format.

            This field is required for Orders customers only, not applicable to
            Orders Harmonization customers.
          format: date
          type: string
        runBilling:
          default: false
          description: >
            Creates an invoice for a subscription. If you have the Invoice
            Settlement feature enabled, a credit memo might also be created
            based on the [invoice and credit memo generation
            rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).  



            The billing documents generated

            in this operation is only for this subscription, not for the entire

            customer account.



            Possible values:


            - `true`: An invoice is created. If you have the Invoice Settlement
            feature enabled, a credit memo might also be created.


            - `false`: No invoice is created.


            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `211.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          type: boolean
        targetDate:
          description: >
            Date through which to calculate charges if an invoice or a credit
            memo is generated, as yyyy-mm-dd. Default is current date.


            **Note**: 
              
            - This field is available only if you are on the latest Zuora API
            version, or you set the `Zuora-Version` request header to `211.0` or
            [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).


            - The credit memo is only available if you have the Invoice
            Settlement feature enabled.
          format: date
          type: string
      type: object
    PUTRenewSubscriptionResponseType:
      properties:
        creditMemoId:
          description: >
            The credit memo ID, if a credit memo is generated during the
            subscription process.


            **Note:** This container is only available if you set the Zuora REST
            API minor version to 207.0 or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            in the request header, and you have  [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        invoiceId:
          description: |
            Invoice ID, if one is generated.
          type: string
        paidAmount:
          description: |
            Payment amount, if payment is collected.
          type: number
        paymentId:
          description: |
            Payment ID, if payment is collected.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        termEndDate:
          description: |
            Date the new subscription term ends, as yyyy-mm-dd.
          format: date
          type: string
        termStartDate:
          description: |
            Date the new subscription term begins, as yyyy-mm-dd.
          format: date
          type: string
        totalDeltaMrr:
          description: >
            Change in the subscription monthly recurring revenue as a result of
            the update. For a renewal, this is the MRR of the subscription in
            the new term.
          type: number
        totalDeltaTcv:
          description: >
            Change in the total contracted value of the subscription as a result
            of the update. For a renewal, this is the TCV of the subscription in
            the new term.
          type: number
      type: object
    POSTSubscriptionCancellationType:
      example:
        cancellationPolicy: EndOfCurrentTerm
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to an invoice. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
          items:
            type: string
          type: array
        applyCredit:
          description: >
            If the value is true, the credit memo or unapplied payment on the
            order account will be automatically applied to the invoices
            generated by this order. The credit memo generated by this order
            will not be automatically applied to any invoices.


            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: boolean
        applyCreditBalance:
          description: >
            Whether to automatically apply a credit balance to an invoice.


            If the value is `true`, the credit balance is applied to the
            invoice. If the value is `false`, no action is taken.



            To view the credit balance adjustment, retrieve the details of the
            invoice using the Get Invoices method.


            Prerequisite: `invoice` must be `true`. 


            **Note:** 
              - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.
              - This field is deprecated if you have the Invoice Settlement feature enabled.
          type: boolean
        bookingDate:
          description: >
            The booking date that you want to set for the amendment contract
            when you cancel the subscription. The default value is the current
            date when you make the API call.
          format: date
          type: string
        cancellationEffectiveDate:
          description: >
            Date the cancellation takes effect, in the format yyyy-mm-dd.  Use
            only if `cancellationPolicy` is `SpecificDate`. Should not be
            earlier than the subscription contract-effective date, later than
            the subscription term-end date, or within a period for which the
            customer has been invoiced.
          format: date
          type: string
        cancellationPolicy:
          description: >
            Cancellation method. Possible values are: `EndOfCurrentTerm`,
            `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`,
            the `cancellationEffectiveDate` field is required.
          type: string
        collect:
          default: false
          description: >
            Collects an automatic payment for a subscription. The collection
            generated in this operation is only for this subscription, not for
            the entire customer account.


            If the value is `true`, the automatic payment is collected. If the
            value is `false`, no action is taken.


            Prerequisite: The `invoice` or `runBilling` field must be `true`. 


            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `196.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          type: boolean
        contractEffectiveDate:
          description: >
            The date when the customer notifies you that they want to cancel
            their subscription.
          format: date
          type: string
        creditMemoReasonCode:
          description: >-
            A code identifying the reason for the credit memo transaction that
            is generated by the request. The value must be an existing reason
            code. If you do not pass the field or pass the field with empty
            value, Zuora uses the default reason code.
          type: string
        documentDate:
          description: >
            The date of the billing document, in `yyyy-mm-dd` format. It
            represents the invoice date for invoices, credit memo date for
            credit memos, and debit memo date for debit memos.


            - If this field is specified, the specified date is used as the
            billing document date. 

            - If this field is not specified, the date specified in the
            `targetDate` is used as the billing document date.
          format: date
          type: string
        orderDate:
          description: >
            The date when the order is signed. If no additinal
            contractEffectiveDate is provided, this order will use this order
            date as the contract effective date.

            This field must be in the `yyyy-mm-dd` format.

            This field is required for Orders customers only, not applicable to
            Orders Harmonization customers. 
          format: date
          type: string
        runBilling:
          default: false
          description: >
            Creates an invoice for a subscription. If you have the Invoice
            Settlement feature enabled, a credit memo might also be created
            based on the [invoice and credit memo generation
            rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).  



            The billing documents generated

            in this operation is only for this subscription, not for the entire

            customer account.



            Possible values:


            - `true`: An invoice is created. If you have the Invoice Settlement
            feature enabled, a credit memo might also be created.



            - `false`: No invoice is created.


            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `211.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          type: boolean
        targetDate:
          description: >
            Date through which to calculate charges if an invoice or a credit
            memo is generated, as

            yyyy-mm-dd. Default is current date.

            **Note**: 
              - This field is available only if you are on the latest Zuora
            API version, or you set the `Zuora-Version` request header to
            `211.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              - The credit memo is only available if you have the Invoice
            Settlement feature enabled.
          format: date
          type: string
      required:
        - cancellationPolicy
      type: object
    POSTSubscriptionCancellationResponseType:
      properties:
        cancelledDate:
          description: >
            The date that the subscription was canceled. 


            This field is available in the Orders Harmonization tenants and the
            Subscribe and Amend tenants. This field is not available in the
            Orders tenants. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Common_subscription_information/AA_Overview_of_Subscriptions"
            target="_blank">Identify your tenant type for managing
            subscriptions</a>.
          format: date
          type: string
        creditMemoId:
          description: >
            The credit memo ID, if a credit memo is generated during the
            subscription process.


            **Note:** This container is only available if you set the Zuora REST
            API minor version to 207.0 or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            in the request header, and you have  [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        invoiceId:
          description: |
            ID of the invoice, if one is generated.
          type: string
        paidAmount:
          description: |
            Amount paid.
          type: number
        paymentId:
          description: |
            ID of the payment, if a payment is collected.
          type: string
        subscriptionId:
          description: |
            The subscription ID.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        totalDeltaMrr:
          description: >
            Change in the subscription monthly recurring revenue as a result of
            the update.
          type: number
        totalDeltaTcv:
          description: >
            Change in the total contracted value of the subscription as a result
            of the update.
          type: number
      type: object
    PUTSubscriptionResumeType:
      example:
        resumePolicy: Today
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to an invoice. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
          items:
            type: string
          type: array
        applyCredit:
          description: >
            If the value is true, the credit memo or unapplied payment on the
            order account will be automatically applied to the invoices
            generated by this order. The credit memo generated by this order
            will not be automatically applied to any invoices.


            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: boolean
        applyCreditBalance:
          description: >
            Whether to automatically apply a credit balance to an invoice.


            If the value is `true`, the credit balance is applied to the
            invoice. If the value is `false`, no action is taken.



            To view the credit balance adjustment, retrieve the details of the
            invoice using the Get Invoices method.


            Prerequisite: `invoice` must be `true`. 


            **Note:** This field is deprecated if you have the Invoice
            Settlement feature enabled.
          type: boolean
        bookingDate:
          description: >
            The booking date that you want to set for the amendment contract
            when you resume the subscription. If `extendsTerm` is `true`, which
            means you also extend the term, then this field is also the booking
            date for the Terms and Conditions amendment contract.


            This field must be in the `yyyy-mm-dd` format. The default value of
            this field is the current date when you make the API call. 
          format: date
          type: string
        collect:
          default: false
          description: >
            Collects an automatic payment for a subscription. The collection
            generated in this operation is only for this subscription, not for
            the entire customer account.


            If the value is `true`, the automatic payment is collected. If the
            value is `false`, no action is taken.


            Prerequisite: The `invoice` or `runBilling` field must be `true`. 


            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `196.0` or a later available version.
          type: boolean
        contractEffectiveDate:
          description: >
            The date when the customer notifies you that they want to resume
            their subscription.
          format: date
          type: string
        creditMemoReasonCode:
          description: >-
            A code identifying the reason for the credit memo transaction that
            is generated by the request. The value must be an existing reason
            code. If you do not pass the field or pass the field with empty
            value, Zuora uses the default reason code.
          type: string
        documentDate:
          description: >
            The date of the billing document, in `yyyy-mm-dd` format. It
            represents the invoice date for invoices, credit memo date for
            credit memos, and debit memo date for debit memos.


            - If this field is specified, the specified date is used as the
            billing document date. 

            - If this field is not specified, the date specified in the
            `targetDate` is used as the billing document date.
          format: date
          type: string
        extendsTerm:
          description: >
            Whether to extend the subscription term by the length of time the
            suspension is in effect.


            Values: `true`, `false`.
          type: boolean
        orderDate:
          description: >
            The date when the order is signed. If no additinal
            contractEffectiveDate is provided, this order will use this order
            date as the contract effective date.

            This field must be in the `yyyy-mm-dd` format.

            This field is required for Orders customers only, not applicable to
            Orders Harmonization customers.
          format: date
          type: string
        resumePeriods:
          description: >
            The length of the period used to specify when the subscription is
            resumed. The subscription resumption takes effect after a specified
            period based on the suspend date or today's date. You must use this
            field together with the `resumePeriodsType` field to specify the
            period.


            **Note:** This field is only applicable when the `suspendPolicy`
            field is set to `FixedPeriodsFromToday` or
            `FixedPeriodsFromSuspendDate`.
          type: string
        resumePeriodsType:
          description: >
            The period type used to define when the subscription resumption
            takes effect. The subscription resumption takes effect after a
            specified period based on the suspend date or today's date. You must
            use this field together with the `resumePeriods` field to specify
            the period.


            Values: `Day`, `Week`, `Month`, `Year`


            **Note:** This field is only applicable when the `suspendPolicy`
            field is set to `FixedPeriodsFromToday` or
            `FixedPeriodsFromSuspendDate`.
          type: string
        resumePolicy:
          description: >
            Resume methods. Specify a way to resume a subscription.


            Values:


            * `Today`: The subscription resumption takes effect on today's date.


            * `FixedPeriodsFromSuspendDate`: The subscription resumption takes
            effect after a specified period based on the suspend date. You must
            specify the `resumePeriods` and `resumePeriodsType` fields to define
            the period.


            * `SpecificDate`: The subscription resumption takes effect on a
            specific date. You must define the specific date in the
            `resumeSpecificDate` field.


            * `FixedPeriodsFromToday`: The subscription resumption takes effect
            after a specified period based on the today's date. You must specify
            the `resumePeriods` and `resumePeriodsType` fields to define the
            period.

            * `suspendDate`: The subscription resumption takes effect on the
            date of suspension of the subscription.
          type: string
        resumeSpecificDate:
          description: >
            A specific date when the subscription resumption takes effect, in
            the format yyyy-mm-dd.


            **Note:** This field is only applicable only when the `resumePolicy`
            field is set to `SpecificDate`.


            The value should not be earlier than the subscription suspension
            date.
          format: date
          type: string
        runBilling:
          default: false
          description: >
            Creates an invoice for a subscription. If you have the Invoice
            Settlement feature enabled, a credit memo might also be created
            based on the [invoice and credit memo generation
            rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).  



            The billing documents generated

            in this operation is only for this subscription, not for the entire

            customer account.



            Possible values:


            - `true`: An invoice is created. If you have the Invoice Settlement
            feature enabled, a credit memo might also be created.



            - `false`: No invoice is created.



            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `211.0` or a later available version.
          type: boolean
        targetDate:
          description: >
            Date through which to calculate charges if an invoice or a credit
            memo is generated, as

            yyyy-mm-dd. Default is current date.



            **Note:** 

            - This field is available only if you are on the latest Zuora API
            version, or you set the `Zuora-Version` request header to `211.0` or
            a  later available version.

            - The credit memo is only available if you have the Invoice
            Settlement feature enabled.
          format: date
          type: string
      required:
        - resumePolicy
      type: object
    PUTSubscriptionResumeResponseType:
      properties:
        creditMemoId:
          description: >
            The credit memo ID, if a credit memo is generated during the
            subscription process.


            **Note:** This container is only available if you set the Zuora REST
            API minor version to 207.0 or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            in the request header, and you have  [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        invoiceId:
          description: >
            Invoice ID, if an invoice is generated during the subscription
            process.
          type: string
        paidAmount:
          description: |
            Payment amount, if a payment is collected.
          type: number
        paymentId:
          description: |
            Payment ID, if a payment is collected.
          type: string
        resumeDate:
          description: |
            The date when subscription resumption takes effect, as yyyy-mm-dd.
          format: date
          type: string
        subscriptionId:
          description: |
            The subscription ID.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        termEndDate:
          description: |
            The date when the new subscription term ends, as yyyy-mm-dd.
          format: date
          type: string
        totalDeltaTcv:
          description: >
            Change in the total contracted value of the subscription as a result
            of the update.
          type: number
      type: object
    PUTSubscriptionSuspendType:
      example:
        suspendPolicy: Today
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to an invoice. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices.
          items:
            type: string
          type: array
        applyCredit:
          description: >
            If the value is true, the credit memo or unapplied payment on the
            order account will be automatically applied to the invoices
            generated by this order. The credit memo generated by this order
            will not be automatically applied to any invoices.



            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: boolean
        applyCreditBalance:
          description: >
            Whether to automatically apply a credit balance to an invoice.


            If the value is `true`, the credit balance is applied to the
            invoice. If the value is `false`, no action is taken.



            To view the credit balance adjustment, retrieve the details of the
            invoice using the Get Invoices method.


            Prerequisite: `invoice` must be `true`. 


            **Note:** 
              - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`.
              - This field is deprecated if you have the Invoice Settlement feature enabled.
          type: boolean
        bookingDate:
          description: >
            The booking date that you want to set for the amendment contract
            when you suspend the subscription. If `resume` is `true`, which
            means you also choose to resume the subscription at some point, then
            this field is also the booking date for the Resume amendment
            contract.


            This field must be in the `yyyy-mm-dd` format. The default value of
            this field is the current date when you make the API call. 
          format: date
          type: string
        collect:
          default: false
          description: >
            Collects an automatic payment for a subscription. The collection
            generated in this operation is only for this subscription, not for
            the entire customer account.


            If the value is `true`, the automatic payment is collected. If the
            value is `false`, no action is taken.


            Prerequisite: The `invoice` or `runBilling` field must be `true`. 


            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `196.0` or a later available version.
          type: boolean
        contractEffectiveDate:
          description: >
            The date when the customer notifies you that they want to amend
            their subscription.
          format: date
          type: string
        creditMemoReasonCode:
          description: >-
            A code identifying the reason for the credit memo transaction that
            is generated by the request. The value must be an existing reason
            code. If you do not pass the field or pass the field with empty
            value, Zuora uses the default reason code.
          type: string
        documentDate:
          description: >
            The date of the billing document, in `yyyy-mm-dd` format. It
            represents the invoice date for invoices, credit memo date for
            credit memos, and debit memo date for debit memos.


            - If this field is specified, the specified date is used as the
            billing document date. 

            - If this field is not specified, the date specified in the
            `targetDate` is used as the billing document date.
          format: date
          type: string
        extendsTerm:
          description: >
            Whether to extend the subscription term by the length of time the
            suspension is in effect. Values: `true`, `false`.
          type: boolean
        orderDate:
          description: >
            The date when the order is signed. If no additinal
            contractEffectiveDate is provided, this order will use this order
            date as the contract effective date.

            This field must be in the `yyyy-mm-dd` format.

            This field is required for Orders customers only, not applicable to
            Orders Harmonization customers.
          format: date
          type: string
        resume:
          description: >
            Whether to set when to resume a subscription when creating a suspend
            amendment. Values: `true`, `false`.
          type: boolean
        resumePeriods:
          description: >
            The length of the period used to specify when the subscription is
            resumed. The subscription resumption takes effect after a specified
            period based on the suspend date or today's date. You must use this
            field together with the `resumePeriodsType` field to specify the
            period.


            **Note:** This field is only applicable when the `suspendPolicy`
            field is set to `FixedPeriodsFromToday` or
            `FixedPeriodsFromSuspendDate`.
          type: string
        resumePeriodsType:
          description: >
            The period type used to define when the subscription resumption
            takes effect. The subscription resumption takes effect after a
            specified period based on the suspend date or today's date. You must
            use this field together with the resumePeriods field to specify the
            period.


            Values: `Day`, `Week`, `Month`, `Year`


            **Note:** This field is only applicable when the `suspendPolicy`
            field is set to `FixedPeriodsFromToday` or
            `FixedPeriodsFromSuspendDate`.
          type: string
        resumePolicy:
          description: >
            Resume methods. Specify a way to resume a subscription. Values:


            * `Today`: The subscription resumption takes effect on today's date.


            * `FixedPeriodsFromSuspendDate`: The subscription resumption takes
            effect after a specified period based on the suspend date. You must
            specify the `resumePeriods` and `resumePeriodsType` fields to define
            the period.


            * `SpecificDate`: The subscription resumption takes effect on a
            specific date. You must define the specific date in the
            `resumeSpecificDate` field.


            * `FixedPeriodsFromToday`: The subscription resumption takes effect
            after a specified period based on the today's date. You must specify
            the `resumePeriods` and `resumePeriodsType` fields to define the
            period.

            * `suspendDate`: The subscription resumption takes effect on the
            date of suspension of the subscription.
          type: string
        resumeSpecificDate:
          description: >
            A specific date when the subscription resumption takes effect, in
            the format yyyy-mm-dd.


            **Note:** This field is only applicable only when the `resumePolicy`
            field is set to `SpecificDate`.


            The value should not be earlier than the subscription suspension
            date.
          format: date
          type: string
        runBilling:
          default: false
          description: >
            Creates an invoice for a subscription. If you have the Invoice
            Settlement feature enabled, a credit memo might also be created
            based on the [invoice and credit memo generation
            rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).  



            The billing documents generated

            in this operation is only for this subscription, not for the entire

            customer account.



            Possible values:


            - `true`: An invoice is created. If you have the Invoice Settlement
            feature enabled, a credit memo might also be created.



            - `false`: No invoice is created.



            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `211.0` or a  later available version.
          type: boolean
        suspendPeriods:
          description: >
            The length of the period used to specify when the subscription
            suspension takes effect. The subscription suspension takes effect
            after a specified period based on today's date. You must use this
            field together with the `suspendPeriodsType` field to specify the
            period.


            **Note:** This field is only applicable only when the suspendPolicy
            field is set to FixedPeriodsFromToday.
          type: string
        suspendPeriodsType:
          description: >
            The period type used to define when the subscription suspension
            takes effect. The subscription suspension takes effect after a
            specified period based on today's date. You must use this field
            together with the suspendPeriods field to specify the period.


            Type: string (enum)


            Values: `Day`, `Week`, `Month`, `Year`


            **Note:** This field is only applicable only when the suspendPolicy
            field is set to FixedPeriodsFromToday.
          type: string
        suspendPolicy:
          description: >
            Suspend methods. Specify a way to suspend a subscription. 


            Value:


            * `Today`: The subscription suspension takes effect on today's date.

            * `EndOfLastInvoicePeriod`: The subscription suspension takes effect
            at the end of the last invoice period. The suspend date defaults to
            a date that is one day after the last invoiced period. You can
            choose this option to avoid any negative invoices (credits) issued
            back to the customer after the subscription suspension. 

            * `SpecificDate`: The subscription suspension takes effect on a
            specific date. You must define the specific date in the
            `suspendSpecificDate` field.

            * `FixedPeriodsFromToday`: The subscription suspension takes effect
            after a specified period based on today's date. You must specify the
            `suspendPeriods` and `suspendPeriodsType` fields to define the
            period.
          type: string
        suspendSpecificDate:
          description: >
            A specific date when the subscription suspension takes effect, in
            the format yyyy-mm-dd.


            **Note:** This field is only applicable only when the suspendPolicy
            field is set to SpecificDate.


            The value should not be earlier than the subscription contract
            effective date, later than the subscription term end date, or within
            a period for which the customer has been invoiced.
          format: date
          type: string
        targetDate:
          description: >
            Date through which to calculate charges if an invoice or a credit
            memo is generated, as

            yyyy-mm-dd. Default is current date.

            This field is available only if you are on the latest Zuora API
            version, or you set the `Zuora-Version` request header to `211.0` or
            a later available version.


            **Note:** The credit memo is only available if you have the Invoice
            Settlement feature enabled.
          format: date
          type: string
      required:
        - suspendPolicy
      type: object
    PUTSubscriptionSuspendResponseType:
      properties:
        creditMemoId:
          description: >
            The credit memo ID, if a credit memo is generated during the
            subscription process.


            **Note:** This container is only available if you set the Zuora REST
            API minor version to 207.0 or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)
            in the request header, and you have  [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        invoiceId:
          description: >
            Invoice ID, if an invoice is generated during the subscription
            process.
          type: string
        paidAmount:
          description: |
            Payment amount, if a payment is collected.
          type: number
        paymentId:
          description: |
            Payment ID, if a payment is collected.
          type: string
        resumeDate:
          description: >
            The date when subscription resumption takes effect, in the format
            yyyy-mm-dd.
          format: date
          type: string
          nullable: true
        subscriptionId:
          description: |
            The subscription ID.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        suspendDate:
          description: >
            The date when subscription suspension takes effect, in the format
            yyyy-mm-dd.
          format: date
          type: string
        termEndDate:
          description: >
            The date when the new subscription term ends, in the format
            yyyy-mm-dd.
          format: date
          type: string
        totalDeltaTcv:
          description: >
            Change in the total contracted value of the subscription as a result
            of the update.
          type: number
      type: object
    PUTDeleteSubscriptionResponseType:
      properties:
        success:
          description: Returns `true` if the request is processed successfully.
          type: boolean
      type: object
    PUTSubscriptionPatchSpecificVersionRequestType:
      example:
        customFields:
          CustomTag__c: internal
      properties:
        customFields:
          $ref: '#/components/schemas/SubscriptionObjectCustomFields'
        ratePlans:
          items:
            properties:
              charges:
                items:
                  properties:
                    chargeId:
                      description: >
                        Use either this field or the `chargeNumber` field to
                        specify the charge for which you will be updating the
                        custom fields. By using this field you actually specify
                        a specific charge segment of a charge. See [Segmented
                        rate plan
                        charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges)
                        for more information about charge segments.
                      type: string
                    chargeNumber:
                      description: >
                        Use either this field or the `chargeId` field to specify
                        the charge for which you will be updating the custom
                        fields. By using this field you actually specify the
                        last charge segment of a charge. See [Segmented rate
                        plan
                        charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges)
                        for more information about charge segments.
                      type: string
                    customFields:
                      $ref: '#/components/schemas/RatePlanChargeObjectCustomFields'
                  type: object
                type: array
              customFields:
                $ref: '#/components/schemas/RatePlanObjectCustomFields'
              ratePlanId:
                description: >-
                  The rate plan id in any version of the subscription. This will
                  be linked to the only one rate plan in the current version.
                type: string
            required:
              - ratePlanId
            type: object
          type: array
      type: object
    GETMetricsBySubscriptionNumbersResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            subscriptionMetrics:
              items:
                properties:
                  subscriptionNumber:
                    description: |
                      The number for the subscription.
                    type: string
                  contractedMrr:
                    description: |
                      Monthly recurring revenue of the subscription.
                    type: number
                  contractedNetMrr:
                    description: >
                      Monthly recurring revenue of the subscription rate plan
                      inclusive of all the discounts applicable, including the
                      fixed-amount discounts and percentage discounts.
                    type: number
                  asOfDayGrossMrr:
                    description: >
                      Monthly recurring revenue of the subscription rate plan
                      exclusive of any discounts applicable as of specified day.
                    type: number
                  asOfDayNetMrr:
                    description: >
                      Monthly recurring revenue of the subscription rate plan
                      inclusive of all the discounts applicable, including the
                      fixed-amount discounts and percentage discounts as of
                      specified day.
                    type: number
                  netTotalContractedValue:
                    description: >
                      Total contracted value of the subscription inclusive of
                      all the discounts applicable, including the fixed-amount
                      discounts and percentage discounts.
                    type: number
                  totalContractedValue:
                    description: |
                      Total contracted value of the subscription.
                    type: number
                type: object
              type: array
          type: object
    OrderActionRatePlanAmendment:
      description: |
        The amendment that is related to the subscription rate plan.
      properties:
        code:
          description: |
            The amendment code.
          type: string
        contractEffectiveDate:
          description: >
            The date when the amendment becomes effective for billing purposes,
            as `yyyy-mm-dd`.
          format: date
          type: string
        createdBy:
          description: |
            The ID of the user who created this amendment.
          type: string
        createdDate:
          description: >-
            The time that the amendment gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
        customerAcceptanceDate:
          description: >
            The date when the customer accepts the amendment changes to the
            subscription, as `yyyy-mm-dd`.
          format: date
          type: string
        description:
          description: |
            Description of the amendment.
          type: string
        effectiveDate:
          description: |
            The date when the amendment changes take effective. 
          format: date
          type: string
        id:
          description: |
            The amendment ID.
          type: string
        name:
          description: |
            The name of the amendment.
          type: string
        serviceActivationDate:
          description: |
            The date when service is activated, as `yyyy-mm-dd`.
          format: date
          type: string
        type:
          description: |
            Type of the amendment.
            Possible values are:


            - NewProduct
            - RemoveProduct
            - UpdateProduct
          type: string
        updatedBy:
          description: The ID of the user who updated this amendment.
          type: string
        updatedDate:
          description: >-
            The time that the amendment gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
        customFields:
          additionalProperties:
            description: >
              Custom fields of the Amendment object. The name of each custom
              field has the form <code>*customField*__c</code>. Custom field
              names are case sensitive. See <a
              href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
              target="_blank">Custom Fields</a> for more information.
          description: |
            Container for custom fields of an Amendment object.
          type: object
    OrderActionRatePlanRatePlanChargeObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Rate Plan Charge object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Rate Plan Charge object.
      title: ratePlanChargeFieldsCustom
      type: object
    OrderActionRatePlanEndConditions:
      description: |
        Specifies when a charge becomes inactive.
      properties:
        endDateCondition:
          description: >
            Condition for the charge to become inactive.


            If the value of this field is `Fixed_Period`, the charge is active
            for a predefined duration based on the value of the
            `upToPeriodsType` and `upToPeriods` fields.


            If the value of this field is `Specific_End_Date`, use the
            `specificEndDate` field to specify the date when then charge becomes
            inactive.
          enum:
            - Subscription_End
            - Fixed_Period
            - Specific_End_Date
          type: string
        specificEndDate:
          description: >
            Date in YYYY-MM-DD format. Only applicable if the value of the
            `endDateCondition` field is `Specific_End_Date`.
          format: date
          type: string
        upToPeriods:
          description: >
            Duration of the charge in billing periods, days, weeks, months, or
            years, depending on the value of the `upToPeriodsType` field. Only
            applicable if the value of the `endDateCondition` field is
            `Fixed_Period`.
          type: integer
        upToPeriodsType:
          description: >
            Unit of time that the charge duration is measured in. Only
            applicable if the value of the `endDateCondition` field is
            `Fixed_Period`.
          enum:
            - Billing_Periods
            - Days
            - Weeks
            - Months
            - Years
          type: string
      title: endDate
      type: object
    OrderActionRatePlanChargeTier:
      properties:
        endingUnit:
          description: |
            Limit on the number of units for which the tier is effective.
          type: number
        price:
          description: >
            Price or per-unit price of the tier, depending on the value of the
            `priceFormat` field.
          type: number
        priceFormat:
          description: |
            Specifies whether the tier has a fixed price or a per-unit price.
          enum:
            - FlatFee
            - PerUnit
          type: string
        startingUnit:
          description: |
            Number of units at which the tier becomes effective.
          type: number
        tier:
          description: |
            Index of the tier in the charge.
          minimum: 1
          type: integer
      required:
        - tier
        - startingUnit
        - price
        - priceFormat
      title: chargeTier
      type: object
    OrderActionRatePlanChargeModelDataOverride:
      description: >
        Container for charge model configuration data.


        **Note**: This field is only available if you have the High Water Mark,
        Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The
        charge models are available for customers with Enterprise and Nine
        editions by default. If you are a Growth customer, see [Zuora
        Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
        for pricing information.
      properties:
        chargeModelConfiguration:
          properties:
            customFieldPerUnitRate:
              description: >
                The custom field that carries the per-unit rate for each usage
                record. For example, `perUnitAmount__c`.


                This field is only available for the usage-based charges that
                use the Pre-Rated Per Unit Pricing charge model. The charge
                model is available for customers with Enterprise and Nine
                editions by default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.
              type: string
            customFieldTotalAmount:
              description: >
                The custom field that carries the total amount to charge for a
                usage record. For example, `totalAmount__c`.


                This field is only available for the usage-based charges that
                use the Pre-Rated Pricing charge model. The charge model is
                available for customers with Enterprise and Nine editions by
                default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.
              type: string
            formula:
              description: >
                The pricing formula to calculate actual rating amount for each
                usage record.


                This field is only available for the usage-based charges that
                use the Multi-Attribute Pricing charge model. The charge model
                is available for customers with Enterprise and Nine editions by
                default. If you are a Growth customer, see [Zuora
                Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
                for pricing information.
              type: string
          type: object
        tiers:
          description: >
            List of cumulative pricing tiers in the charge.


            **Note**: When you override tiers of the charge with a High Water
            Mark Pricing charge model, you have to provide all of the tiers,
            including the ones you do not want to change. The new tiers will
            completely override the previous ones. The High Water Mark Pricing
            charge models are available for customers with Enterprise and Nine
            editions by default. If you are a Growth customer, see [Zuora
            Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions)
            for pricing information.
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
          type: array
      title: chargeModelData
      type: object
    OrderActionRatePlanDiscountPricingOverride:
      description: |
        Pricing information about a discount charge.
      properties:
        applyDiscountTo:
          description: |
            Specifies which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        discountAmount:
          description: |
            Only applicable if the discount charge is a fixed-amount discount.
          type: number
        discountLevel:
          description: >
            Application scope of the discount charge. For example, if the value
            of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          description: |
            Only applicable if the discount charge is a percentage discount.
          type: number
        priceChangeOption:
          description: >
            Specifies how Zuora changes the price of the charge each time the
            subscription renews.
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      title: discount
      type: object
    OrderActionRatePlanOneTimeFlatFeePricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "flat fee"
        charge model. In this charge model, the charge has a fixed price.
      properties:
        listPrice:
          description: |
            Price of the charge.
          type: number
      required:
        - listPrice
      title: oneTimeFlatFee
      type: object
    OrderActionRatePlanOneTimePerUnitPricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "per unit"
        charge model. In this charge model, the charge has a fixed price per
        unit purchased.
      properties:
        listPrice:
          description: |
            Per-unit price of the charge.
          type: number
        quantity:
          description: |
            Number of units purchased.
          minimum: 0
          type: number
      title: oneTimePerUnit
      type: object
    OrderActionRatePlanOneTimeTieredPricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "tiered
        pricing" charge model. In this charge model, the charge has cumulative
        pricing tiers that become effective as units are purchased.
      properties:
        quantity:
          description: |
            Number of units purchased.
          minimum: 0
          type: number
        tiers:
          description: |
            List of cumulative pricing tiers in the charge.
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
          type: array
      title: oneTimeTiered
      type: object
    OrderActionRatePlanOneTimeVolumePricingOverride:
      description: >
        Pricing information about a one-time charge that uses the "volume
        pricing" charge model. In this charge model, the charge has a variable
        price per unit, depending on how many units are purchased.
      properties:
        quantity:
          description: |
            Number of units purchased.
          minimum: 0
          type: number
        tiers:
          description: |
            List of variable pricing tiers in the charge.
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
          type: array
      title: oneTimeVolume
      type: object
    OrderActionRatePlanPriceChangeParams:
      properties:
        priceChangeOption:
          description: >
            Specifies how Zuora changes the price of the charge each time the
            subscription renews.


            If the value of this field is `SpecificPercentageValue`, use the
            `priceIncreasePercentage` field to specify how much the price of the
            charge should change.
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
        priceIncreasePercentage:
          description: >
            Specifies the percentage by which the price of the charge should
            change each time the subscription renews. Only applicable if the
            value of the `priceChangeOption` field is `SpecificPercentageValue`.
          minimum: -100
          type: number
      type: object
    OrderActionRatePlanRecurringDeliveryPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              description: |
                Price of the charge in each recurring period.
              type: number
          type: object
      description: >
        Pricing information about a recurring charge that uses the Delivery
        Pricing charge model. In this charge model, the charge has a fixed
        price. This field is only available if you have the Delivery Pricing
        charge model enabled.
      title: recurringDelivery
    OrderActionRatePlanRecurringFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              description: |
                Price of the charge in each recurring period.
              type: number
            listPriceBase:
              description: |
                Specifies the duration of each recurring period.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. The
                value of this field is `null` if you do not set the value of the
                `listPriceBase` field to `Per_Specific_Months`.
              format: int32
              maximum: 200
              minimum: 1
              type: integer
          type: object
      description: >
        Pricing information about a recurring charge that uses the "flat fee"
        charge model. In this charge model, the charge has a fixed price.
      title: recurringFlatFee
    OrderActionRatePlanRecurringPerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              description: |
                Per-unit price of the charge in each recurring period.
              type: number
            listPriceBase:
              description: >
                Specifies the duration of each recurring period.


                **Note**: The `Per_Year` and `Per_Specific_Months` enum values
                are available only if you have the <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
                target="_blank">Annual List Price</a> feature
                enabled.              
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              description: |
                Number of units purchased.
              minimum: 0
              type: number
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.
              format: int32
              maximum: 200
              minimum: 1
              type: integer
          type: object
      description: >
        Pricing information about a recurring charge that uses the "per unit"
        charge model. In this charge model, the charge has a fixed price per
        unit purchased.
      title: recurringPerUnit
    OrderActionRatePlanRecurringTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPriceBase:
              description: |
                Specifies the duration of each recurring period.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              description: |
                Number of units purchased.
              minimum: 0
              type: number
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              description: |
                List of cumulative pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      description: >
        Pricing information about a recurring charge that uses the "tiered
        pricing" charge model. In this charge model, the charge has cumulative
        pricing tiers that become effective as units are purchased.
      title: recurringTiered
    OrderActionRatePlanRecurringVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPriceBase:
              description: >
                Specifies the duration of each recurring period.


                **Note**: The `Per_Year` and `Per_Specific_Months` enum values
                are available only if you have the <a
                href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price"
                target="_blank">Annual List Price</a> feature enabled.
              enum:
                - Per_Billing_Period
                - Per_Month
                - Per_Week
                - Per_Year
                - Per_Specific_Months
              type: string
            quantity:
              description: |
                Number of units purchased.
              minimum: 0
              type: number
            specificListPriceBase:
              description: >
                The number of months for the list price base of the charge. This
                field is required if you set the value of the `listPriceBase`
                field to `Per_Specific_Months`.
              format: int32
              maximum: 200
              minimum: 1
              type: integer
            tiers:
              description: |
                List of variable pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      description: >
        Pricing information about a recurring charge that uses the "volume
        pricing" charge model. In this charge model, the charge has a variable
        price per unit, depending on how many units are purchased.
      title: recurringVolume
    OrderActionRatePlanUsageFlatFeePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              description: |
                Price of the charge.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "flat fee" charge
        model. In this charge model, the charge has a fixed price.
      title: usageFlatFee
    OrderActionRatePlanUsageOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            includedUnits:
              description: |
                Number of free units that may be consumed.
              minimum: 0
              type: number
            numberOfPeriods:
              description: >
                Number of periods that Zuora considers when calculating overage
                charges with overage smoothing.
              minimum: 1
              type: integer
            overagePrice:
              description: |
                Price per overage unit consumed.
              type: number
            overageUnusedUnitsCreditOption:
              description: >
                Specifies whether to credit the customer for unused units.


                If the value of this field is `CreditBySpecificRate`, use the
                `unusedUnitsCreditRates` field to specify the rate at which to
                credit the customer for unused units.
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            unusedUnitsCreditRates:
              description: >
                Per-unit rate at which to credit the customer for unused units.
                Only applicable if the value of the
                `overageUnusedUnitsCreditOption` field is
                `CreditBySpecificRate`.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "overage" charge
        model. In this charge model, the charge has an allowance of free units
        and a fixed price per additional unit consumed.
      title: usageOverage
    OrderActionRatePlanUsagePerUnitPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              description: |
                Per-unit price of the charge.
              type: number
            ratingGroup:
              description: >
                Specifies how Zuora groups usage records when rating usage. See
                [Usage Rating by
                Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)
                for more information.
                  * ByBillingPeriod (default): The rating is based on all the usages in a billing period.
                  * ByUsageStartDate: The rating is based on all the usages on the same usage start date.
                  * ByUsageRecord: The rating is based on each usage record.
                  * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
          type: object
      description: >
        Pricing information about a usage charge that uses the "per unit" charge
        model. In this charge model, the charge has a fixed price per unit
        consumed.
      title: usagePerUnit
    OrderActionRatePlanUsageTieredPricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            ratingGroup:
              description: >
                Specifies how Zuora groups usage records when rating usage. See
                [Usage Rating by
                Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)
                for more information.
                  * ByBillingPeriod (default): The rating is based on all the usages in a billing period.
                  * ByUsageStartDate: The rating is based on all the usages on the same usage start date.
                  * ByUsageRecord: The rating is based on each usage record.
                  * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              description: |
                List of cumulative pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      description: >
        Pricing information about a usage charge that uses the "tiered pricing"
        charge model. In this charge model, the charge has cumulative pricing
        tiers that become effective as units are consumed.
      title: usageTiered
    OrderActionRatePlanUsageTieredWithOveragePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            numberOfPeriods:
              description: >
                Number of periods that Zuora considers when calculating overage
                charges with overage smoothing.
              minimum: 1
              type: integer
            overagePrice:
              description: |
                Price per overage unit consumed.
              type: number
            overageUnusedUnitsCreditOption:
              description: >
                Specifies whether to credit the customer for unused units.


                If the value of this field is `CreditBySpecificRate`, use the
                `unusedUnitsCreditRates` field to specify the rate at which to
                credit the customer for unused units.
              enum:
                - NoCredit
                - CreditBySpecificRate
              type: string
            tiers:
              description: |
                List of cumulative pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
            unusedUnitsCreditRates:
              description: >
                Per-unit rate at which to credit the customer for unused units.
                Only applicable if the value of the
                `overageUnusedUnitsCreditOption` field is
                `CreditBySpecificRate`.
              type: number
          type: object
      description: >
        Pricing information about a usage charge that uses the "tiered with
        overage" charge model. In this charge model, the charge has cumulative
        pricing tiers that become effective as units are consumed. The charge
        also has a fixed price per unit consumed beyond the limit of the final
        tier.
      title: usageTieredWithOverage
    OrderActionRatePlanUsageVolumePricingOverride:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            ratingGroup:
              description: >
                Specifies how Zuora groups usage records when rating usage. See
                [Usage Rating by
                Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group)
                for more information.
                  * ByBillingPeriod (default): The rating is based on all the usages in a billing period.
                  * ByUsageStartDate: The rating is based on all the usages on the same usage start date.
                  * ByUsageRecord: The rating is based on each usage record.
                  * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.
              enum:
                - ByBillingPeriod
                - ByUsageStartDate
                - ByUsageRecord
                - ByUsageUpload
              type: string
            tiers:
              description: |
                List of variable pricing tiers in the charge.
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
      description: >
        Pricing information about a usage charge that uses the "volume pricing"
        charge model. In this charge model, the charge has a variable price per
        unit, depending on how many units are consumed.
      title: usageVolume
    OrderActionRatePlanTriggerParams:
      description: |
        Specifies when a charge becomes active.
      properties:
        specificTriggerDate:
          description: >
            Date in YYYY-MM-DD format. Only applicable if the value of the
            `triggerEvent` field is `SpecificDate`.


            While this field is applicable, if this field is not set, your
            `CreateSubscription` order action creates a `Pending` order and a
            `Pending Acceptance` subscription. If at the same time the service
            activation date is required and not set, a `Pending Activation`
            subscription is created.


            While this field is applicable, if this field is not set, the
            following order actions create a `Pending` order but do not impact
            the subscription status. **Note**: This feature is in **Limited
            Availability**. If you want to have access to the feature, submit a
            request at [Zuora Global Support](http://support.zuora.com/).
             * AddProduct
             * UpdateProduct
             * RemoveProduct
             * RenewSubscription
             * TermsAndConditions
          format: date
          type: string
        triggerEvent:
          description: >
            Condition for the charge to become active.


            If the value of this field is `SpecificDate`, use the
            `specificTriggerDate` field to specify the date when the charge
            becomes active.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
          type: string
      title: startDate
      type: object
    OrderActionRatePlanChargeOverride:
      description: |
        Charge associated with a rate plan.
      properties:
        billing:
          description: |
            Billing information about the charge.
          properties:
            billCycleDay:
              description: >
                Day of the month that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofMonth`.
              maximum: 31
              minimum: 0
              type: integer
            billCycleType:
              description: >
                Specifies how Zuora determines the day that each billing period
                begins on.

                  * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.
                  * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.
                  * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.
                  * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.
                  * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.
              enum:
                - DefaultFromCustomer
                - SpecificDayofMonth
                - SubscriptionStartDay
                - ChargeTriggerDay
                - SpecificDayofWeek
              type: string
            billingPeriod:
              description: >
                Billing frequency of the charge. The value of this field
                controls the duration of each billing period.


                If the value of this field is `Specific_Months` or
                `Specific_Weeks`, use the `specificBillingPeriod` field to
                specify the duration of each billing period.
              enum:
                - Month
                - Quarter
                - Semi_Annual
                - Annual
                - Eighteen_Months
                - Two_Years
                - Three_Years
                - Five_Years
                - Specific_Months
                - Subscription_Term
                - Week
                - Specific_Weeks
              type: string
            billingPeriodAlignment:
              description: >
                Specifies how Zuora determines when to start new billing
                periods. You can use this field to align the billing periods of
                different charges.


                * `AlignToCharge` - Zuora starts a new billing period on the
                first billing day that falls on or after the date when the
                charge becomes active.

                * `AlignToSubscriptionStart` - Zuora starts a new billing period
                on the first billing day that falls on or after the start date
                of the subscription.

                * `AlignToTermStart` - For each term of the subscription, Zuora
                starts a new billing period on the first billing day that falls
                on or after the start date of the term.


                See the `billCycleType` field for information about how Zuora
                determines the billing day.


                **Note**: This field is not supported in one time charges. 
              enum:
                - AlignToCharge
                - AlignToSubscriptionStart
                - AlignToTermStart
              type: string
            billingTiming:
              description: >
                Specifies whether to invoice for a billing period on the first
                day of the billing period (billing in advance) or the first day
                of the next billing period (billing in arrears).
              enum:
                - IN_ADVANCE
                - IN_ARREARS
              type: string
            specificBillingPeriod:
              description: >
                Duration of each billing period in months or weeks, depending on
                the value of the `billingPeriod` field. Only applicable if the
                value of the `billingPeriod` field is `Specific_Months` or
                `Specific_Weeks`.
              type: integer
            weeklyBillCycleDay:
              description: >
                Day of the week that each billing period begins on. Only
                applicable if the value of the `billCycleType` field is
                `SpecificDayofWeek`.
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
          type: object
        chargeNumber:
          description: |
            Charge number of the charge. For example, C-00000307.

            If you do not set this field, Zuora will generate the charge number.
          maxLength: 50
          type: string
        customFields:
          $ref: >-
            #/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields
        description:
          description: |
            Description of the charge.
          maxLength: 500
          type: string
        endDate:
          $ref: '#/components/schemas/OrderActionRatePlanEndConditions'
        pricing:
          description: |
            Pricing information about the charge.
          properties:
            chargeModelData:
              $ref: '#/components/schemas/OrderActionRatePlanChargeModelDataOverride'
            discount:
              $ref: '#/components/schemas/OrderActionRatePlanDiscountPricingOverride'
            oneTimeFlatFee:
              $ref: >-
                #/components/schemas/OrderActionRatePlanOneTimeFlatFeePricingOverride
            oneTimePerUnit:
              $ref: >-
                #/components/schemas/OrderActionRatePlanOneTimePerUnitPricingOverride
            oneTimeTiered:
              $ref: >-
                #/components/schemas/OrderActionRatePlanOneTimeTieredPricingOverride
            oneTimeVolume:
              $ref: >-
                #/components/schemas/OrderActionRatePlanOneTimeVolumePricingOverride
            recurringDelivery:
              $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringDeliveryPricingOverride
            recurringFlatFee:
              $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringFlatFeePricingOverride
            recurringPerUnit:
              $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringPerUnitPricingOverride
            recurringTiered:
              $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringTieredPricingOverride
            recurringVolume:
              $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringVolumePricingOverride
            usageFlatFee:
              $ref: >-
                #/components/schemas/OrderActionRatePlanUsageFlatFeePricingOverride
            usageOverage:
              $ref: >-
                #/components/schemas/OrderActionRatePlanUsageOveragePricingOverride
            usagePerUnit:
              $ref: >-
                #/components/schemas/OrderActionRatePlanUsagePerUnitPricingOverride
            usageTiered:
              $ref: >-
                #/components/schemas/OrderActionRatePlanUsageTieredPricingOverride
            usageTieredWithOverage:
              $ref: >-
                #/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingOverride
            usageVolume:
              $ref: >-
                #/components/schemas/OrderActionRatePlanUsageVolumePricingOverride
          type: object
        productRatePlanChargeId:
          description: >
            Internal identifier of the product rate plan charge that the charge
            is based on.
          type: string
        revRecCode:
          description: |
            Revenue Recognition Code
          maxLength: 70
          type: string
        revRecTriggerCondition:
          description: |
            Specifies the revenue recognition trigger condition.

              * `Contract Effective Date`
              * `Service Activation Date`
              * `Customer Acceptance Date`
          enum:
            - Contract Effective Date
            - Service Activation Date
            - Customer Acceptance Date
          type: string
        revenueRecognitionRuleName:
          description: |
            Specifies the revenue recognition rule.

              * `Recognize upon invoicing`
              * `Recognize daily over time`
          enum:
            - Recognize upon invoicing
            - Recognize daily over time
          type: string
        startDate:
          $ref: '#/components/schemas/OrderActionRatePlanTriggerParams'
        uniqueToken:
          description: >
            Unique identifier for the charge. This identifier enables you to
            refer to the charge before the charge has an internal identifier in
            Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the charge.
            Then when you update the product, you can use the same unique
            identifier to specify which charge to modify.
          maxLength: 50
          type: string
      required:
        - productRatePlanChargeId
      title: charge
      type: object
    OrderActionRatePlanRatePlanObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Rate Plan object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Rate Plan object.
      title: RatePlanCustomFields
      type: object
    OrderActionRatePlanRatePlanOverride:
      description: |
        Rate plan associated with a subscription.
      properties:
        chargeOverrides:
          description: |
            List of charges associated with the rate plan.
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeOverride'
          type: array
        customFields:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields'
        newRatePlanId:
          description: |
            Internal identifier of the rate plan.
          type: string
        productRatePlanId:
          description: >
            Internal identifier of the product rate plan that the rate plan is
            based on.
          type: string
        uniqueToken:
          description: >
            Unique identifier for the rate plan. This identifier enables you to
            refer to the rate plan before the rate plan has an internal
            identifier in Zuora.


            For instance, suppose that you want to use a single order to add a
            product to a subscription and later update the same product. When
            you add the product, you can set a unique identifier for the rate
            plan. Then when you update the product, you can use the same unique
            identifier to specify which rate plan to modify.
          maxLength: 50
          type: string
      required:
        - productRatePlanId
      title: ratePlan
      type: object
    OrderActionRatePlanRemoveProduct:
      description: |
        Information about an order action of type `RemoveProduct`.
      properties:
        ratePlanId:
          description: |
            Internal identifier of the rate plan to remove.
          type: string
        uniqueToken:
          description: >-
            A unique string to represent the rate plan charge in the order. The
            unique token is used to perform multiple actions against a newly
            added rate plan. For example, if you want to add and update a
            product in the same order, you would assign a unique token to the
            product rate plan when added and use that token in future order
            actions.A unique string in the order to represent the rate plan.
          type: string
      title: removeProduct
      type: object
    OrderActionRatePlanBillingUpdate:
      properties:
        billingPeriodAlignment:
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
          type: string
      type: object
    OrderActionRatePlanDiscountPricingUpdate:
      properties:
        applyDiscountTo:
          description: |
            Specifies which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
          type: string
        discountLevel:
          description: >
            Application scope of the discount charge. For example, if the value
            of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
          type: string
        discountPercentage:
          description: >
            The amount of the discount as a percentage. This field is only used
            for percentage discounts.
          type: number
        priceChangeOption:
          description: >
            Specifies how Zuora changes the price of the charge each time the
            subscription renews.
          enum:
            - NoChange
            - UseLatestProductCatalogPricing
          type: string
      type: object
    OrderActionRatePlanRecurringDeliveryPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            deliverySchedule:
              $ref: '#/components/schemas/DeliveryScheduleParams'
            listPrice:
              type: number
          type: object
    OrderActionRatePlanRecurringFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
          type: object
    OrderActionRatePlanRecurringPerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
            quantity:
              minimum: 0
              type: number
          type: object
    OrderActionRatePlanRecurringTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanRecurringVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            quantity:
              minimum: 0
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanUsageFlatFeePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
          type: object
    OrderActionRatePlanUsageOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            includedUnits:
              description: >
                A certain quantity of units for free in the overage charge
                model. It cannot be negative. It must be 0 and above. Decimals
                are allowed.
              type: number
            overagePrice:
              type: number
          type: object
    OrderActionRatePlanUsagePerUnitPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            listPrice:
              type: number
          type: object
    OrderActionRatePlanUsageTieredPricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanUsageTieredWithOveragePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            overagePrice:
              type: number
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanUsageVolumePricingUpdate:
      allOf:
        - $ref: '#/components/schemas/OrderActionRatePlanPriceChangeParams'
        - properties:
            tiers:
              items:
                $ref: '#/components/schemas/OrderActionRatePlanChargeTier'
              type: array
          type: object
    OrderActionRatePlanPricingUpdate:
      properties:
        chargeModelData:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanChargeModelDataOverride'
          description: |
            Container for charge model configuration data.
        discount:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanDiscountPricingUpdate'
          description: |
            Pricing information about a discount charge.
        recurringDelivery:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringDeliveryPricingUpdate
          description: >
            Pricing information about a recurring charge that uses the Delivery
            Pricing charge model. In this charge model, the charge has a fixed
            price. This field is only available if you have the Delivery Pricing
            charge model enabled.
        recurringFlatFee:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringFlatFeePricingUpdate
          description: >
            Pricing information about a recurring charge that uses the "flat
            fee" charge model. In this charge model, the charge has a fixed
            price.
        recurringPerUnit:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringPerUnitPricingUpdate
          description: >
            Pricing information about a recurring charge that uses the "per
            unit" charge model. In this charge model, the charge has a fixed
            price per unit purchased.
        recurringTiered:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringTieredPricingUpdate
          description: >
            Pricing information about a recurring charge that uses the "tiered
            pricing" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            purchased.
        recurringVolume:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanRecurringVolumePricingUpdate
          description: >
            Pricing information about a recurring charge that uses the "volume
            pricing" charge model. In this charge model, the charge has a
            variable price per unit, depending on how many units are purchased.
        usageFlatFee:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanUsageFlatFeePricingUpdate
          description: >
            Pricing information about a usage charge that uses the "flat fee"
            charge model. In this charge model, the charge has a fixed price.
        usageOverage:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanUsageOveragePricingUpdate
          description: >
            Pricing information about a usage charge that uses the "overage"
            charge model. In this charge model, the charge has an allowance of
            free units and a fixed price per additional unit consumed.
        usagePerUnit:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanUsagePerUnitPricingUpdate
          description: >
            Pricing information about a usage charge that uses the "per unit"
            charge model. In this charge model, the charge has a fixed price per
            unit consumed.
        usageTiered:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsageTieredPricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "tiered
            pricing" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            consumed.
        usageTieredWithOverage:
          allOf:
            - $ref: >-
                #/components/schemas/OrderActionRatePlanUsageTieredWithOveragePricingUpdate
          description: >
            Pricing information about a usage charge that uses the "tiered with
            overage" charge model. In this charge model, the charge has
            cumulative pricing tiers that become effective as units are
            consumed. The charge also has a fixed price per unit consumed beyond
            the limit of the final tier.
        usageVolume:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanUsageVolumePricingUpdate'
          description: >
            Pricing information about a usage charge that uses the "volume
            pricing" charge model. In this charge model, the charge has a
            variable price per unit, depending on how many units are consumed.
      type: object
    OrderActionRatePlanChargeUpdate:
      description: >-
        The JSON object containing the information for a charge update in the
        'UpdateProduct' type order action.
      properties:
        billing:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanBillingUpdate'
          description: |
            Billing information about the charge.
        chargeNumber:
          description: |
            Read only. Identifies the charge to be updated.
          type: string
        customFields:
          $ref: >-
            #/components/schemas/OrderActionRatePlanRatePlanChargeObjectCustomFields
        description:
          description: |
            Description of the charge.
          type: string
        effectiveDate:
          $ref: '#/components/schemas/OrderActionRatePlanTriggerParams'
        pricing:
          allOf:
            - $ref: '#/components/schemas/OrderActionRatePlanPricingUpdate'
          description: |
            Pricing information about the charge.
        uniqueToken:
          description: >
            A unique string to represent the rate plan charge in the order. The
            unique token is used to perform multiple actions against a newly
            added rate plan. For example, if you want to add and update a
            product in the same order, you would assign a unique token to the
            product rate plan when added and use that token in future order
            actions.
          type: string
      type: object
    OrderActionRatePlanRatePlanUpdate:
      description: |
        Information about an order action of type `UpdateProduct`.
      properties:
        chargeUpdates:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanChargeUpdate'
          type: array
        customFields:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanObjectCustomFields'
        newRatePlanId:
          description: >
            Internal identifier of the updated rate plan in the new subscription
            version.
          type: string
        ratePlanId:
          description: |
            Internal identifier of the rate plan that was updated.
          type: string
        specificUpdateDate:
          description: >
            The specific date when the Update Product order action takes
            effect.  This field allows you to update a charge before a
            future-dated Update Product order action on the subscription. The
            format of the date is yyyy-mm-dd.


            **Note**: After you use this option, the charge's `TriggerEvent`
            field value will be changed to `SpecificDate`.  

            See [Update a Product on Subscription with Future-dated
            Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates)
            for more information about this feature.
          format: date
          type: string
        uniqueToken:
          description: >
            A unique string to represent the rate plan charge in the order. The
            unique token is used to perform multiple actions against a newly
            added rate plan. For example, if you want to add and update a
            product in the same order, you would assign a unique token to the
            product rate plan when added and use that token in future order
            actions.
          type: string
      title: updateProduct
      type: object
    OrderActionRatePlanOrderActionObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Order Action object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Order Action object.
      title: orderActionFieldsCustom
      type: object
    OrderActionRatePlanOrderAction:
      description: Represents the processed order action.
      properties:
        addProduct:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanOverride'
        id:
          description: The Id of the order action processed in the order.
          type: string
        removeProduct:
          $ref: '#/components/schemas/OrderActionRatePlanRemoveProduct'
        type:
          description: Type of the order action.
          enum:
            - AddProduct
            - UpdateProduct
            - RemoveProduct
          type: string
        updateProduct:
          $ref: '#/components/schemas/OrderActionRatePlanRatePlanUpdate'
        customFields:
          $ref: >-
            #/components/schemas/OrderActionRatePlanOrderActionObjectCustomFields
      type: object
    OrderActionRatePlanOrder:
      description: |
        The order that is related to the subscription rate plan.
      properties:
        id:
          description: The order ID.
          type: string
        orderActions:
          items:
            $ref: '#/components/schemas/OrderActionRatePlanOrderAction'
          type: array
        orderNumber:
          description: The order number of the order.
          type: string
      type: object
    GetOrderActionRatePlanResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            amendment:
              $ref: '#/components/schemas/OrderActionRatePlanAmendment'
            externallyManagedPlanId:
              description: >
                The unique identifier for the rate plan purchased on a
                third-party store. This field is used to represent a
                subscription rate plan created through third-party stores.
              type: string
            id:
              description: Unique subscription rate-plan ID.
              type: string
            lastChangeType:
              description: |
                Latest change type. Possible values are:

                - New
                - Update
                - Remove
              type: string
            order:
              $ref: '#/components/schemas/OrderActionRatePlanOrder'
            productId:
              description: |
                Product ID
              type: string
            productName:
              description: |
                The name of the product.
              type: string
            productRatePlanId:
              description: |
                Product rate plan ID
              type: string
            productSku:
              description: |
                The unique SKU for the product.
              type: string
            ratePlanName:
              description: |
                The name of the rate plan.
              type: string
            subscriptionId:
              description: |
                Subscription ID.
              type: string
            subscriptionVersion:
              description: |
                The version of the subscription.
          type: object
    OmniChannelAccountData:
      description: >
        The information of the account that you want to create while creating an
        omnichannel subscription.
      properties:
        accountNumber:
          maxLength: 70
          type: string
          description: The number of the account.
        name:
          maxLength: 255
          type: string
          description: The name of the account.
        currency:
          description: |
            Three uppercase character currency code.
          type: string
        notes:
          maxLength: 65535
          type: string
          description: The note for the account.
        billToContact:
          $ref: '#/components/schemas/ContactInfo'
        soldToContact:
          $ref: '#/components/schemas/ContactInfo'
        customFields:
          additionalProperties: true
          description: |
            Container for custom fields.
          title: CustomFields
          type: object
      required:
        - billToContact
        - currency
        - name
      type: object
    CreateOmniChannelSubscriptionRequest:
      example:
        externalSubscriptionId: original-transaction-id1
        accountId: 8a90b4488e602d56018e6062ff5700a3
        externalSourceSystem: Apple
        externalTransactionReason: Purchase
        externalState: Active
        state: Active
        externalProductId: external-product-id-1
        externalInAppOwnershipType: Purchased
        externalQuantity: 1
        currency: USD
        autoRenew: true
        externalPurchaseDate: '2024-02-01 00:01:15'
        externalActivationDate: '2024-02-01 00:01:15'
        externalExpirationDate: '2024-05-01 00:01:15'
        externalApplicationId: 004d58fca978fec3697fec4af1d10065
        externalBundleId: 43dcdc4562784ed8a59ece4ef7d98e57
        externalSubscriberId: 2466082b6d1149c184a09b15bd5be694
        externalPurchaseType: Purchased
        externalPrice: 100
        externalLastRenewalDate: '2024-10-01 00:00:00'
        externalNextRenewalDate: '2025-01-01 00:00:00'
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the account associated with this subscription.
              type: string
            externalSubscriptionId:
              description: >
                The original transaction ID of the notification. This must be
                unique in the tenant.
              type: string
            externalTransactionReason:
              description: |
                The latest transaction reason.
              type: string
            externalSourceSystem:
              description: >
                The source app store from which the channel subscription
                originated. For example, Apple, Google, Roku, Amazon.
              type: string
            externalState:
              description: >
                The original status from client, such as active, canceled,
                expired, pastDue.
              type: string
            state:
              description: |
                The common external subscription state.
              type: string
            externalProductId:
              description: |
                The product ID in the external system.
              type: string
            externalReplaceByProductId:
              description: >
                The product ID is going to replace the existing product ID in
                the `externalProductId` field during the subscription renewal.
              type: string
              nullable: true
            externalInAppOwnershipType:
              description: |
                Such as purchased, family_shared.
              type: string
            externalQuantity:
              description: |
                The quantity of the product, must be greather than 0. 
              default: 1
              type: integer
            currency:
              description: >
                The currency code of the transaction. If not specified, get
                value from the Account.
              type: string
            autoRenew:
              description: >
                If `true`, the subscription automatically renews at the end of
                the

                term.
              default: false
              type: boolean
            externalPurchaseDate:
              description: >
                When the App Store charged the user’s account for a purchase,
                restored product, subscription, 

                or subscription renewal after a lapse. UTC time, `yyyy-mm-dd
                hh:mm:ss`.
              type: string
              format: datetime
            externalActivationDate:
              description: >
                When the external subscription was activated on the external
                platform. 

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            externalExpirationDate:
              description: >
                This expiration date is a static value that applies for each
                transaction.

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            externalApplicationId:
              description: |
                The external application ID.
              type: string
            externalBundleId:
              description: |
                The external bundler ID.
              type: string
            externalSubscriberId:
              description: |
                The external subscriber ID.
              type: string
            externalPrice:
              description: |
                The price in external system.
              type: number
            externalPurchaseType:
              description: The external purchase type.
              type: string
            externalLastRenewalDate:
              description: >
                This last renewal date is a static value that applies for each
                transaction.

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            externalNextRenewalDate:
              description: >
                This next renewal date is a static value that applies for each
                transaction. 

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            accountIdentifierField:
              description: >-
                The account field used to identify the account in acountData. It
                could be a custom field.
              type: string
            accountData:
              $ref: '#/components/schemas/OmniChannelAccountData'
          required:
            - externalSubscriptionId
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
    CreateOmniChannelSubscriptionResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            subscriptionId:
              description: |
                The system generated ID in Billing.
              type: string
            subscriptionNumber:
              description: |
                The system generated subscription number.
              type: string
            accountId:
              description: |
                The ID of the account associated with this subscription.
              type: string
            accountNumber:
              description: |
                The number of the account associated with this subscription.
              type: string
    GetOmniChannelSubscriptionResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            id:
              description: |
                The system generated ID in Billing.
              type: string
            subscriptionNumber:
              description: |
                The system generated subscription number.
              type: string
            accountId:
              description: |
                The ID of the account associated with this subscription.
              type: string
            externalSubscriptionId:
              description: |
                The original transaction ID of the notification.
              type: string
            externalTransactionReason:
              description: |
                The latest transaction reason.
              type: string
            externalSourceSystem:
              description: >
                The source app store from which the channel subscription
                originated. For example, Apple, Google, Roku, Amazon.
              type: string
            externalState:
              description: >
                The original status from client, such as active, canceled,
                expired, pastDue.
              type: string
            state:
              description: |
                The common external subscription state.
              type: string
            externalProductId:
              description: |
                The product ID in the external system.
              type: string
            externalReplaceByProductId:
              description: >
                The product ID is going to replace the existing product ID in
                the `externalProductId` field during the subscription renewal.
              type: string
              nullable: true
            externalInAppOwnershipType:
              description: |
                Such as purchased, family_shared.
              type: string
            externalQuantity:
              description: |
                The quantity of the product, must be greater than 0. 
              default: 1
              type: integer
            currency:
              description: >
                The currency code of the transaction. If not specified, get
                value from the Account.
              type: string
            autoRenew:
              description: >
                If `true`, the subscription automatically renews at the end of
                the

                term. 
              default: false
              type: boolean
            originalPurchaseDate:
              description: >
                The value of `externalPurchaseDate` when this external
                subscription firstly created. 

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            externalPurchaseDate:
              description: >
                When the App Store charged the user’s account for a purchase,
                restored product, subscription, 

                or subscription renewal after a lapse. UTC time, `yyyy-mm-dd
                hh:mm:ss`.
              type: string
              format: datetime
            externalActivationDate:
              description: >
                When the external subscription was activated on the external
                platform. 

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            externalExpirationDate:
              description: >
                This expiration date is a static value that applies for each
                transaction.

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            externalApplicationId:
              description: |
                The external application ID.
              type: string
            externalBundleId:
              description: |
                The external bundler ID.
              type: string
            externalSubscriberId:
              description: |
                The external subscriber ID.
              type: string
            externalPrice:
              description: |
                The price in external system.
              type: number
            externalPurchaseType:
              description: The external purchase type.
              type: string
            externalLastRenewalDate:
              description: >
                This last renewal date is a static value that applies for each
                transaction.

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
            externalNextRenewalDate:
              description: >
                This next renewal date is a static value that applies for each
                transaction. 

                UTC time, `yyyy-mm-dd hh:mm:ss`.
              type: string
              format: datetime
          type: object
        - $ref: '#/components/schemas/SubscriptionObjectCustomFields'
      title: OmniChannelSubscription
    ChangeLogField:
      description: Represents the order information that will be returned in the GET call.
      properties:
        fieldName:
          description: The field name.
          type: string
        oldValue:
          description: The old value of this field.
          type: string
          nullable: true
        newValue:
          description: The new value of this field.
          type: string
      type: object
      title: ChangedField
    RatePlanChargeChangeLog:
      description: Represents the order information that will be returned in the GET call.
      properties:
        chargeNumber:
          description: Charge number.
          type: string
        ratePlanChargeId:
          description: Rate plan charge ID.
          type: string
        effectiveStartDate:
          description: Effective start date of this charge.
          type: string
        effectiveEndDate:
          description: Effective end date of this charge.
          type: string
        fields:
          description: >-
            Represents the fields whose values are changed for this charge. If
            the charge has no change, this field is empty.
          items:
            $ref: '#/components/schemas/ChangeLogField'
          type: array
      type: object
      title: SubscriptionRatePlanCharge
    RatePlanChangeLog:
      description: Represents the order information that will be returned in the GET call.
      properties:
        ratePlanNumber:
          description: Rate plan number.
          type: string
        ratePlanCharges:
          description: Represents the charges in this rate plan.
          items:
            $ref: '#/components/schemas/RatePlanChargeChangeLog'
          type: array
        fields:
          description: >-
            Represents the fields whose values are changed for the rate plan. If
            the rate plan has no change, this field is empty.
          items:
            $ref: '#/components/schemas/ChangeLogField'
          type: array
      type: object
      title: SubscriptionRatePlan
    SubscriptionChangeLog:
      description: Represents the order information that will be returned in the GET call.
      properties:
        subscriptionNumber:
          description: Subscription number.
          type: string
        accountNumber:
          description: Account number.
          type: string
        invoiceOwnerAccountNumber:
          description: Invoice owner account number of the subscription.
          type: string
        currency:
          description: The currency of the subscription.
          type: string
        orderNumber:
          description: The order number of the order which created this subscription.
          type: string
        version:
          description: The version of the subscription.
          format: int64
          type: integer
        changedTime:
          description: The create time of the subscription.
          type: string
        type:
          description: The type of the subscription.
          type: string
          enum:
            - Standard
            - OmniChannel
        externalSubscriptionId:
          description: External subscription ID.
          type: string
          nullable: true
        subscriptionStartDate:
          description: Start date of the subscription.
          type: string
        subscriptionEndDate:
          description: End date of the subscription.
          type: string
        termStartDate:
          description: Term start date of the subscription.
          type: string
        termEndDate:
          description: Term end date of the subscription.
          type: string
        ratePlans:
          description: Represents the rate plans in this subscription.
          items:
            $ref: '#/components/schemas/RatePlanChangeLog'
          type: array
        fields:
          description: >-
            Represents the fields whose values are changed for this
            subscription. If the subscription has no change, this field is
            empty.
          items:
            $ref: '#/components/schemas/ChangeLogField'
          type: array
      type: object
      title: Subscription
    GetSubscriptionChangeLogsResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            subscriptions:
              description: |
                Array of Subscriptions.
              items:
                $ref: '#/components/schemas/SubscriptionChangeLog'
              type: array
          type: object
    GetSubscriptionChangeLogResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            subscription:
              $ref: '#/components/schemas/SubscriptionChangeLog'
          type: object
    DestinationValidityPeriodInfo:
      description: >-
        Date range of the destination validity period to which the funds are
        transferred. It should be close to the source validity period.
      properties:
        endDate:
          description: End date of the destination validity period.
          format: date
          type: string
        startDate:
          description: Start date of the destination validity period.
          format: date
          type: string
      required:
        - startDate
        - endDate
      title: destinationValidityPeriod
      type: object
    SourceValidityPeriodInfo:
      description: >-
        Date range of the source validity period from which the funds are
        transferred. It should be close to the destination validity period.
      properties:
        endDate:
          description: End date of the source validity period.
          format: date
          type: string
        startDate:
          description: Start date of the source validity period.
          format: date
          type: string
      required:
        - startDate
        - endDate
      title: sourceValidityPeriod
      type: object
    POSTReverseRolloverRequestType:
      allOf:
        - properties:
            destinationValidityPeriod:
              $ref: '#/components/schemas/DestinationValidityPeriodInfo'
            prepaymentUom:
              description: >
                Specifies the units of measure for prepayment charge. Units of
                measure are configured in the web-based UI. Your values depend
                on your configuration in **Billing Settings**.


                **Values**: a valid unit of measure
              type: string
            sourceValidityPeriod:
              $ref: '#/components/schemas/SourceValidityPeriodInfo'
            subscriptionNumber:
              description: The unique identifier number of the subscription.
              maxLength: 100
              type: string
          required:
            - subscriptionNumber
            - prepaymentUom
            - sourceValidityPeriod
            - destinationValidityPeriod
          type: object
      example:
        destinationValidityPeriod:
          endDate: '2024-01-01'
          startDate: '2023-01-01'
        prepaymentUom: Each
        sourceValidityPeriod:
          endDate: '2025-01-01'
          startDate: '2024-01-01'
        subscriptionNumber: A-S00000009
    POSTReverseRolloverResponseType:
      properties:
        message:
          description: Indicates the result.
          type: string
        reverseRolloverFundCount:
          description: Indicates the number of funds which have been rolled back.
          format: int64
          type: integer
        success:
          description: Indicates whether the call succeeded.
          type: boolean
      type: object
    POSTTriggerRolloverRequestType:
      allOf:
        - properties:
            destinationValidityPeriod:
              $ref: '#/components/schemas/DestinationValidityPeriodInfo'
            prepaymentUom:
              description: >
                Specifies the units of measure for prepayment charge. Units of
                measure are configured in the web-based UI. Your values depend
                on your configuration in **Billing Settings**.


                **Values**: a valid unit of measure
              type: string
            priority:
              description: |
                Specifies the priority of rolled over fund in case of drawdown.

                **Values**: ApplyLast / ApplyFirst
              type: string
            sourceValidityPeriod:
              $ref: '#/components/schemas/SourceValidityPeriodInfo'
            subscriptionNumber:
              description: The unique identifier number of the subscription.
              maxLength: 100
              type: string
          required:
            - subscriptionNumber
            - prepaymentUom
            - sourceValidityPeriod
            - destinationValidityPeriod
            - priority
          type: object
      example:
        destinationValidityPeriod:
          endDate: '2025-01-01'
          startDate: '2024-01-01'
        prepaymentUom: Each
        priority: ApplyFirst
        sourceValidityPeriod:
          endDate: '2024-01-01'
          startDate: '2023-01-01'
        subscriptionNumber: A-S00000009
    POSTTriggerRolloverResponseType:
      properties:
        message:
          description: Indicates the result.
          type: string
        rolloverFundCount:
          description: Indicates the number of funds which have been rolled over.
          format: int64
          type: integer
        success:
          description: Indicates whether the call succeeded.
          type: boolean
      type: object
    POSTDepleteFundRequestType:
      properties:
        fundIds:
          description: |
            The unique ID of the fund. A maximum of 100 fund Ids are allowed.
          type: object
      example:
        fundIds:
          - 4028818c8d0c9db5018d0cbbdecd72c1
          - 4028818c8d0c9db5018d0cbbdecd72c2
    POSTDepleteFundResponseType:
      properties:
        fundIds:
          items:
            properties:
              fundId:
                description: |
                  The unique ID of the fund.
                type: string
              status:
                description: |
                  The status of the fund expiry.
                type: string
              message:
                description: |
                  The detail information of the fund expiry response.
                type: string
            type: object
          type: array
      type: object
    POSTUsageResponseType:
      properties:
        checkImportStatus:
          description: >
            The path for checking the status of the import.


            The possible status values at this path are `Pending`, `Processing`,
            `Completed`, `Canceled`, and `Failed`. Only `Completed` indicates
            that the file contents were imported successfully.
          type: string
        size:
          description: |
            The size of the uploaded file in bytes.
          format: int64
          type: integer
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    GETUsageRateDetailWrapper:
      properties:
        data:
          description: >
            Contains usage rate details for the invoice item as specified in the
            request.
          properties:
            amountWithoutTax:
              description: |
                The amount of the invoice item without tax.
              format: double
              type: number
            chargeNumber:
              description: >
                The unique number of the product rate plan charge associated
                with the invoice item.
              type: string
            invoiceId:
              description: |
                The unique ID of the invoice.
              type: string
            invoiceItemId:
              description: |
                The unique ID of the invoice item.
              type: string
            invoiceNumber:
              description: |
                The unique number of the invoice.
              type: string
            listPrice:
              description: >
                The list price of the product rate plan charge associated with
                the invoice item. For example, if the product rate plan charge
                uses the tiered charge model, its list price could be: 


                Tier / From / To / List Price / Price Format\n1 / 0 / 9 / 0.00 /
                Per Unit\n2 / 10 / 20 / 1.00 / Per Unit\n3 / 21 / 30 / 2.00 /
                Flat Fee\n4 / 31 /   / 3.00 / Per Unit\n
              type: string
            quantity:
              description: |
                The quantity of the invoice item.
              format: double
              type: number
            rateDetail:
              description: >
                The rate detail of the invoice item. It shows how the total
                amount is calculated. For example, if the product rate plan
                charge uses the tiered charge model, the rate detail for the
                associated invoice item could be: 


                Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00\nTier 2: 10-20, 11
                Each(s) x $1.00/Each = $11.00\nTier 3: 21-30, $2.00 Flat
                Fee\nTier 4: >=31, 15 Each(s) x $3.00/Each = $45.00\nTotal =
                $58.00. 


                The rate detail retrieved from this REST API operation is the
                same as the [Rate Detail presented on PDF
                invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices). 
              type: string
            servicePeriod:
              description: |
                The service period of the invoice item.
              type: string
            uom:
              description: |
                The unit of measurement of the invoice item.
              type: string
          type: object
        success:
          description: |
            Returns `true` if the request was processed successfully. 


            Returns `false` if the request was not processed successfully. 
          type: boolean
      type: object
    UsageObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Usage object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Usage object.
      title: usageFieldsCustom
      type: object
    ProxyCreateUsage:
      allOf:
        - properties:
            AccountId:
              description: |2-
                 The ID of the account associated with the usage data. This field is only required if no value is specified for the `AccountNumber` field.
                **Character limit**: 32 **Values**: a valid account ID. 
              type: string
            AccountNumber:
              description: |2-
                 The number of the account associated with the usage data. This field is only required if no value is specified for the `AccountId` field.
                **Character limit**: 50 **Values**: a valid account number. 
              type: string
            ChargeId:
              description: ' The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID. '
              type: string
            ChargeNumber:
              description: >
                A unique number for the rate plan charge related to the usage
                record. For example, C-00000007.
              maxLength: 50
              type: string
            Description:
              description: |
                A description of the usage record.
              maxLength: 200
              type: string
            EndDateTime:
              description: >2-
                 The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation.
                **Character limit**: 29 **Values**: a valid date and time
                value. 
              format: date-time
              type: string
            ProductRatePlanChargeNumber:
              description: >
                Specify a product rate plan charge number so that you can charge
                your customer with a dynamic usage charge for the corresponding
                uploaded usage record.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `146` or higher. Otherwise, an error occurs. 


                **Note**: This field is only available if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/usage-billing/dynamic-usage-charges"
                target="_blank">Dynamic Usage Charges</a> feature enabled.
              type: string
            Quantity:
              description: |
                Indicates the number of units used.

                **Character limit**: 16 

                **Values**: A valid decimal amount.  
              format: double
              type: number
            StartDateTime:
              description: |2-
                 The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation.
                **Character limit**: 29 **Values**: a valid date and time value 
              format: date-time
              type: string
            SubscriptionId:
              description: >
                The original ID of the subscription that contains the fees
                related to the usage data. 


                The ID of a subscription might change when you create amendments
                to the subscription. It is good practice to use the unique
                subscription number that you can specify in the
                `SubscriptionNumber` field.
              maxLength: 32
              type: string
            SubscriptionNumber:
              description: >
                The unique identifier number of the subscription that contains
                the fees related to the usage data.


                It is good practice to use this field when creating usage
                records.
              maxLength: 100
              type: string
            UOM:
              description: >
                Specifies the units to measure usage. Units of measure are
                configured in the web-based UI. Your values depend on your
                configuration in **Billing Settings**. **Character limit**:
                **Values**: a valid unit of measure 
              type: string
            UniqueKey:
              description: >
                The unique external reference of the usage record. See [Upload
                usage record with unique
                key](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage#Upload_usage_record_with_unique_key)
                for information on how to use this field.

                **Note**: This field is only available if you set the
                `X-Zuora-WSDL-Version` request header to `114` or later. This
                field is only available if you have the <a
                href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
                target="_blank">Prepaid with Drawdown</a> feature or the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
                target="_blank">Unbilled Usage</a> feature enabled. See [Upload
                usage record with unique
                key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key)
                for more information.
              type: string
          required:
            - Quantity
            - StartDateTime
            - UOM
          type: object
        - $ref: '#/components/schemas/UsageObjectCustomFields'
      example:
        AccountId: 8ad09378905a5af201907ca1edb524c2
        UOM: Minutes
        Quantity: 200
        StartDateTime: '2024-06-01T02:00:00.000+01:00'
    ProxyGetUsage:
      allOf:
        - properties:
            AccountId:
              description: |2-
                 The ID of the account associated with the usage data. This field is required if no value is specified for the `AccountNumber` field.
                **Character limit**: 32 **Values**: a valid account ID 
              type: string
            AccountNumber:
              description: |2-
                 The number of the account associated with the usage data. This field is required if no value is specified for the `AccountId` field.
                **Character limit**: 50 **Values**: a valid account number 
              type: string
            ChargeId:
              description: ' The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID '
              type: string
            CreatedById:
              description: |2-
                 The user ID of the person who uploaded the usage records.
                **Character limit**: 32 **Values**: automatically generated 
              type: string
            CreatedDate:
              description: |2-
                 The date when the usage was generated.
                **Character limit**: 29 **Values**: automatically generated 
              format: date-time
              type: string
            Description:
              description: |
                A description of the usage record.
              type: string
            EndDateTime:
              description: |2-
                 The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation.
                **Character limit**: 29 **Values**: a valid date and time value 
              format: date-time
              type: string
            Id:
              description: Object identifier.
              type: string
            ProductRatePlanChargeNumber:
              description: >
                Specify a product rate plan charge number so that you can charge
                your customer with a dynamic usage charge for the corresponding
                uploaded usage record.


                To use this field, you must set the `X-Zuora-WSDL-Version`
                request header to `146` or higher. Otherwise, an error occurs. 


                **Note**: This field is only available if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Dynamic_Usage_Charges"
                target="_blank">Dynamic Usage Charges</a> feature enabled.
              type: string
            Quantity:
              description: |
                Indicates the number of units used.

                **Character limit**: 16 

                **Values**: A valid decimal amount.
              format: double
              type: number
            RbeStatus:
              description: >2-
                 Indicates if the rating and billing engine (RBE) processed usage data for an invoice.
                **Character limit**: 9 **Values**: automatically generated to be
                one of the following values: `Importing`, `Pending`,
                `Processed` 
              type: string
            SourceType:
              description: >2-
                 Indicates if the usage records were imported from the web-based UI or the API.
                **Character limit**: 6 **Values**: automatically generated to be
                one of the following values: `API`, `Import` 
              type: string
            StartDateTime:
              description: |2-
                 The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation.
                **Character limit**: 29 **Values**: a valid date and time value 
              format: date-time
              type: string
            SubscriptionId:
              description: |2-
                 The original ID of the subscription that contains the fees related to the usage data.
                **Character limit**: 32 **Values**: a valid subscription ID 
              type: string
            SubscriptionNumber:
              description: >
                The unique identifier number of the subscription that contains
                the fees related to the usage data.
              type: string
            UOM:
              description: |2-
                 Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.
                **Character limit**: **Values**: a valid unit of measure 
              type: string
            UpdatedById:
              description: |2-
                 The ID of the user who last updated the usage upload.
                **Character limit**: 32 **Values**: automatically generated 
              type: string
            UpdatedDate:
              description: |2-
                 The date when the usage upload was last updated.
                **Character limit**: 29 **Values**: automatically generated 
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/UsageObjectCustomFields'
    ProxyModifyUsage:
      allOf:
        - properties:
            EndDateTime:
              description: |2-
                 The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation.
                **Character limit**: 29 **Values**: a valid date and time value 
              format: date-time
              type: string
            Quantity:
              description: |
                Indicates the number of units used.

                **Character limit**: 16 

                **Values**: A valid decimal amount.
              format: double
              type: number
            RbeStatus:
              description: >2-
                 Indicates if the rating and billing engine (RBE) processed usage data for an invoice.
                **Character limit**: 9 **Values**: automatically generated to be
                one of the following values: `Importing`, `Pending`,
                `Processed` 
              type: string
            StartDateTime:
              description: |2-
                 The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation.
                **Character limit**: 29 **Values**: a valid date and time value 
              format: date-time
              type: string
            UOM:
              description: |2-
                 Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**.
                **Character limit**: **Values**: a valid unit of measure 
              type: string
          type: object
        - $ref: '#/components/schemas/UsageObjectCustomFields'
      example:
        EndDateTime: '2024-06-30T02:00:00.000+01:00'
    RunMeterVersionRequest:
      type: object
      description: The request payload to run a specific version of a meter.
      properties:
        sourceOptions:
          type: array
          description: Settings for meter to run with local file.
          items:
            type: object
            properties:
              processorId:
                type: string
                description: >-
                  Source operator ID. Optional if there's only one local file
                  source in the meter.
              localFileId:
                type: string
                description: Internal ID of uploaded file.
        eventStoreSourceOptions:
          type: array
          description: Settings for meter to run with event store.
          items:
            type: object
            required:
              - processorId
            properties:
              processorId:
                type: string
                description: Source operator ID.
              startDate:
                type: string
                format: date
                description: Start date of event store to query from (e.g., 2025-01-01).
              endDate:
                type: string
                format: date
                description: End date of event store to query to (e.g., 2025-02-01).
    RunMeterVersionResponse:
      type: object
      description: Response payload after triggering a meter run.
      properties:
        success:
          type: boolean
          description: Whether the API request has succeeded.
        data:
          type: object
          properties:
            id:
              type: string
              description: Internal run history ID, unique within tenant.
            sessionId:
              type: string
              description: Corresponding session ID of this run.
            jobId:
              type: string
              description: Corresponding job ID of this run.
            meterId:
              type: integer
              description: Internal meter ID.
            version:
              type: string
              description: Version of the meter.
            revision:
              type: integer
              description: Revision number of this version run.
            runType:
              type: integer
              description: |
                The run type:
                - 1. NORMAL
                - 2. DEBUG
              minimum: 1
              maximum: 2
            runTypeDescription:
              type: string
              description: Description of the run type.
            startTime:
              type: string
              format: date-time
              description: Start time of this run.
            endTime:
              type: string
              format: date-time
              nullable: true
              description: End time of this run.
            status:
              type: integer
              description: |
                The run status:
                - 1. NEVER_RUN
                - 2. TESTING
                - 3. TESTING_FAILED
                - 4. TESTING_PASSED
                - 5. RUNNING
                - 6. PAUSED
                - 7. COMPLETED
                - 8. FAILED
                - 9. CANCELED
                - 10. INITIALIZING
                - 11. USAGE_PUSHING
                - 12. PUSH_COMPLETED
                - 13. CONSUME_COMPLETED
              minimum: 1
              maximum: 13
            statusDescription:
              type: string
              description: Description of the run status.
            canExportSummary:
              type: boolean
              description: Whether the summary is ready to export.
            hasLineageEnabled:
              type: boolean
              description: Whether lineage feature is enabled on this run.
    SourceOption:
      type: object
      properties:
        processorId:
          type: string
          description: >-
            The source operator ID. Optional if there is only one local file
            source.
        sampleFileId:
          type: integer
          description: Test meter with event definition sample file, specified by the ID.
        localFileId:
          type: integer
          description: Test meter with uploaded file, specified by the ID.
        testData:
          type: array
          description: Test meter with manually input data.
          items:
            type: object
            properties:
              Amount:
                type: number
                description: Amount
              Quantity:
                type: number
                description: Quantity
              UsageDate:
                type: string
                format: date
                description: UsageDate
              CostCenter:
                type: string
                description: CostCenter
              CustomerId:
                type: string
                description: CustomerId
              UsageIdentifier:
                type: string
                description: UsageIdentifier
        saveTestData:
          type: boolean
          description: Whether to save the test data.
        testDataName:
          type: string
          description: The name of the test data.
        testDataId:
          type: integer
          description: Test meter with previously saved test data, specified by the ID.
    EventStoreSourceOption:
      type: object
      properties:
        processorId:
          type: string
          description: The source operator ID for event store.
        startDate:
          type: string
          format: date
          description: The start date of the event store to query from, e.g., 2025-01-01.
        endDate:
          type: string
          format: date
          description: The end date of the event store to query to, e.g., 2025-02-01.
    TestSpecificMeterRequest:
      type: object
      properties:
        sourceOptions:
          type: array
          items:
            $ref: '#/components/schemas/SourceOption'
        eventStoreSourceOptions:
          type: array
          items:
            $ref: '#/components/schemas/EventStoreSourceOption'
    TestSpecificMeterResponse:
      type: object
      properties:
        id:
          type: string
          description: Internal run history ID, unique within tenant.
        sessionId:
          type: string
          description: The corresponding session ID of this run.
        jobId:
          type: string
          description: The corresponding job ID of this run.
        meterId:
          type: integer
          description: The meter ID.
        version:
          type: string
          description: The version of the meter.
        revision:
          type: integer
          description: The revision of the meter version when it runs.
        runType:
          type: integer
          description: The run type of the meter (1 for NORMAL, 2 for DEBUG).
          minimum: 1
          maximum: 2
        runTypeDescription:
          type: string
          description: Description of the run type.
        startTime:
          type: string
          description: The start time of the run in ISO 8601 format.
        endTime:
          type: string
          description: The end time of the run in ISO 8601 format.
        runStatus:
          type: string
          description: The status of the run (e.g., NEVER_RUN, TESTING, FAILED).
        runStatusDescription:
          type: string
          description: Description of the run status.
        canExportSummary:
          type: boolean
          description: Whether the summary is ready to export.
        hasLineageEnabled:
          type: boolean
          description: Whether lineage is enabled for this run.
    MediationErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the API request has succeeded or not.
        data:
          type: object
          description: >-
            Detailed response information for successful requests (e.g.,
            instance info, job details).
          properties:
            id:
              type: string
              description: The instance ID.
            sessionId:
              type: string
              description: The session ID of the meter instance.
            jobId:
              type: string
              description: The job ID of the meter instance.
            meterId:
              type: integer
              description: The ID of the meter.
            version:
              type: string
              description: The meter version.
            revision:
              type: string
              description: The meter revision.
            runType:
              type: integer
              description: The run type of the instance.
            runTypeDescription:
              type: string
              description: The description of the run type.
            startTime:
              type: string
              description: The start time of the instance.
            status:
              type: integer
              description: The job status of the instance.
            statusDescription:
              type: string
              description: The status description of the instance.
            canExportSummary:
              type: boolean
              description: >-
                Whether the instance can export summary information (internal
                usage).
            hasLineageEnabled:
              type: boolean
              description: Whether lineage is enabled for the meter (internal usage).
        error:
          type: object
          description: Contains error details when the request fails.
          properties:
            code:
              type: string
              description: >-
                The error reason code (e.g., "70002006" for authorization
                errors).
            message:
              type: string
              description: A human-readable description of the error.
    CreateSpecificMeterSummaryRequest:
      type: object
      properties:
        runType:
          type: string
          description: Specifies the type of run.
        sessionIds:
          type: array
          description: A list of specific run IDs to export.
          items:
            type: string
        operatorIds:
          type: array
          description: A list of operator IDs to filter by.
          items:
            type: string
        groupBy:
          type: array
          description: Specifies the fields used to group the summary results.
          items:
            type: string
        queryFromTime:
          type: string
          description: The minimum timestamp for the data to be exported.
        queryToTime:
          type: string
          description: The maximum timestamp for the data to be exported.
      example:
        runType: NORMAL
        queryFromTime: 2025-10-01T0000+0000
        queryToTime: 2025-11-17T23:59:59+0000
        operatorIds:
          - 4610a876-61ee-4e5e-a634-152e7a635f75
        sessionIds:
          - R-00002247
          - R-00002293
        groupBy:
          - errorCode
          - processorId
          - sessionId
    SummaryFilters:
      type: object
      properties:
        runType:
          type: string
          description: Specifies the type of run.
        sessionIds:
          type: array
          description: A list of specific run IDs to export.
          items:
            type: string
        operatorIds:
          type: array
          description: A list of operator IDs to filter by.
          items:
            type: string
        groupBy:
          type: array
          description: Specifies the fields used to group the summary results.
          items:
            type: string
        queryFromTime:
          type: string
          description: The minimum timestamp for the data to be exported.
        queryToTime:
          type: string
          description: The maximum timestamp for the data to be exported.
    SummaryGroupByResult:
      type: object
      properties:
        dimensions:
          description: >-
            Stores dimension details or attributes used in grouping or
            filtering.
          type: object
          additionalProperties:
            type: object
            description: Stores extra or custom fields not defined in the main schema.
        output:
          type: integer
          format: int64
          description: Represents the total number of output records or items.
        totalErrorCount:
          type: integer
          format: int64
          description: Indicates the total count of errors in the response.
    SummaryResponse:
      type: object
      properties:
        requestId:
          type: string
          description: Unique identifier for the API request.
        requestTime:
          type: string
          description: Timestamp indicating when the request was made.
        query:
          $ref: '#/components/schemas/SummaryFilters'
          description: Defines the filters or parameters applied to the summary query.
        output:
          type: array
          description: |
            Lists grouped summary results based on the specified fields.
          items:
            $ref: '#/components/schemas/SummaryGroupByResult'
    Error:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code identifying the failure type.
        message:
          type: string
          description: >-
            Human-readable description of the error that provides more context
            about what went wrong.
        detail:
          type: object
          description: >-
            Additional structured details about the error, such as validation
            issues or parameter-specific information.
    CreateSpecificMeterSummaryResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          $ref: '#/components/schemas/SummaryResponse'
          description: >
            List of audit trail entries for the specified meter. Each object
            represents a recorded event or operation associated with the meter.
        previousPage:
          type: string
          description: >-
            Cursor or URL for the previous page of audit records, if available.
            Used for backward pagination.
        nextPage:
          type: string
          description: >-
            Cursor or URL for the next page of audit records, if available. Used
            for forward pagination.
        error:
          $ref: '#/components/schemas/Error'
          description: >-
            Container for error information returned by the API when the request
            fails.
    RunStatusResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          type: object
          properties:
            runStatus:
              type: integer
              description: |
                The run status of the current version. Possible values:
                - 1: NEVER_RUN
                - 2: TESTING
                - 3: TESTING_FAILED
                - 4: TESTING_PASSED
                - 5: RUNNING
                - 6: PAUSED
                - 7: COMPLETED
                - 8: FAILED
                - 9: CANCELED
                - 10: INITIALIZING
                - 11: USAGE_PUSHING
                - 12: PUSH_COMPLETED
                - 13: CONSUME_COMPLETED
              minimum: 1
              maximum: 13
            runStatusDescription:
              type: string
              description: Description of the run status.
    MeterAuditRecord:
      type: object
      properties:
        errorTime:
          type: string
          description: >-
            Timestamp when an error occurred during the meter operation or event
            processing, if applicable.
        timestamp:
          type: string
          description: >-
            Timestamp when the audit entry was created, representing the exact
            time the event or operation was recorded.
        errorCode:
          type: string
          description: >-
            Unique identifier for the specific error type, used to categorize
            and troubleshoot issues. Present only when an error has occurred.
        errorMessage:
          type: string
          description: >-
            Descriptive message explaining the cause or nature of the error.
            Useful for debugging or logging.
        payload:
          description: >-
            Raw event data or metadata associated with the audited action,
            including event content, request body, or contextual details.
          type: object
          additionalProperties:
            type: object
        eventId:
          type: string
          description: >-
            Unique identifier assigned to the audited event. Enables correlation
            of events across systems for traceability.
        traceId:
          type: string
          description: >-
            Unique identifier used to trace the end-to-end flow of an event
            through the system. Useful for debugging distributed processes.
        operatorType:
          type: string
          description: 'Type of processor used. Examples: MAP, ENRICHMENT'
          enum:
            - ACCUMULATOR
            - AGGREGATOR
            - BILLING_RATING
            - CLICKHOUSE_SINK
            - CLICKHOUSE_SOURCE
            - DEDUPLICATE
            - EVENT_STORE_SINK
            - EVENT_STORE_SOURCE
            - FILTER
            - HTTP
            - KAFKA_SINK
            - KAFKA_SOURCE
            - LOCAL_FS_SOURCE
            - MAP
            - NATS_SINK
            - NATS_SOURCE
            - PARTITION
            - RATING
            - S3_SINK
            - S3_SOURCE
            - SAMPLE_COMMITTABLE_SINK
            - SCRIPT_ACCUMULATOR
            - SCRIPT_AGGREGATOR
            - SCRIPT_FILTER
            - SCRIPT_MAP
            - SNOWFLAKE_ERROR
            - SNOWFLAKE_SINK
            - SNOWFLAKE_SOURCE
            - STREAMING_API_SOURCE
            - SUBSCRIPTION_LOOKUP
            - TSTORE_SINK
            - USAGE_RECORD_SINK
            - USER_INPUT_SOURCE
        operatorName:
          type: string
          description: Name of the processor used in ther meter configuration.
        operatorId:
          type: string
          description: ID of the processor used in the meter configuration.
    GetAuditTrailResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          type: array
          description: >
            List of audit trail entries for the specified meter. Each object
            represents a recorded event or operation associated with the meter.
          items:
            $ref: '#/components/schemas/MeterAuditRecord'
        previousPage:
          type: string
          description: >-
            Cursor for the previous page of audit records, if available. Used
            for backward pagination.
        nextPage:
          type: string
          description: >-
            Cursor for the next page of audit records, if available. Used for
            forward pagination.
        error:
          $ref: '#/components/schemas/Error'
          description: >-
            Container for error information returned by the API when the request
            fails.
    GetAuditTrailExportResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          description: >
            List of audit trail entries for the specified meter. Each object
            represents a recorded event or operation associated with the meter.
          type: object
          additionalProperties:
            type: object
            description: >-
              Stores extra or custom fields that are not defined in the main
              schema.
        previousPage:
          type: string
          description: >-
            Cursor for the previous page of audit records, if available. Used
            for backward pagination.
        nextPage:
          type: string
          description: >-
            Cursor for the next page of audit records, if available. Used for
            forward pagination.
        error:
          $ref: '#/components/schemas/Error'
          description: >-
            Container for error information returned by the API when the request
            fails.
    ExportAuditTrailResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          description: >
            List of audit trail entries for the specified meter. Each object
            represents a recorded event or operation associated with the meter.
          type: object
          additionalProperties:
            type: object
            description: >-
              Stores extra or custom fields that are not defined in the main
              schema.
        previousPage:
          type: string
          description: >-
            Cursor for the previous page of audit records, if available. Used
            for backward pagination.
        nextPage:
          type: string
          description: >-
            Cursor for the next page of audit records, if available. Used for
            forward pagination.
        error:
          $ref: '#/components/schemas/Error'
          description: >-
            Container for error information returned by the API when the request
            fails.
    GetPresignedURLResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          type: string
          description: |
            The pre-signed URL to download a specific export file.
        previousPage:
          type: string
          description: >-
            Cursor for the previous page, if available. Used for backward
            pagination.
        nextPage:
          type: string
          description: Cursor for the next page, if available. Used for forward pagination.
        error:
          $ref: '#/components/schemas/Error'
          description: >-
            Container for error information returned by the API when the request
            fails.
    UsageFieldMapping:
      type: object
      properties:
        name:
          type: string
          description: Field name
        field:
          type: string
          description: Mapped field name
        required:
          type: boolean
          description: Indicates if the field is required
        dateFormat:
          type: string
          description: Date format if applicable
    MeterTypeDefinition:
      type: object
      properties:
        sourceType:
          type: string
          description: Source type, e.g., ZUORA_BULK_API or LOCAL_FILE
        schemaId:
          type: string
          description: Event definition ID
        fieldMappings:
          type: array
          items:
            $ref: '#/components/schemas/UsageFieldMapping'
          description: Field mappings from event definition to Zuora usage
        configs:
          type: object
          additionalProperties: true
          description: Configurations for accumulated meters (e.g., SUM)
    TransitionNode:
      type: object
      properties:
        id:
          type: string
          description: Operator ID
    MeterTask:
      type: object
      properties:
        id:
          type: string
          description: Operator ID
        name:
          type: string
          description: Operator name
        nodeType:
          type: string
          description: Operator node type (e.g., SOURCE, PROCESSOR, SINK)
        operatorType:
          type: string
          description: Operator type (e.g., KAFKA, S3, LOCAL_FILE)
        metadata:
          type: object
          additionalProperties: true
          description: Operator metadata
        predecessors:
          type: array
          items:
            $ref: '#/components/schemas/TransitionNode'
          description: Predecessor operators
        extraConfig:
          type: object
          additionalProperties: true
          description: Extra configurations for the operator
        setting:
          type: object
          additionalProperties: true
          description: Runtime settings for the operator
    MeterVersionExportResult:
      type: object
      properties:
        version:
          type: string
          description: The initial version of meter, default is 0.0.1
        versionDetail:
          type: string
          description: Detail description of this version
        metadata:
          type: string
          description: Version metadata, UI stores meter position data into this field
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/MeterTask'
          description: List of tasks for this version
    EventSchemaExportResult:
      type: object
      description: Schema details of an event associated with a meter
      properties:
        name:
          type: string
          description: Event definition name
        type:
          type: integer
          description: Schema type (1 = simple, 2 = advanced)
          minimum: 1
          maximum: 2
        schema:
          type: object
          description: JSON schema
          properties:
            description:
              type: string
              description: Schema description
            type:
              type: string
              enum:
                - object
              description: Schema base type
            title:
              type: string
              description: Schema title
            required:
              type: array
              description: Required fields in the event
              items:
                type: string
            properties:
              type: object
              description: Field definitions in the schema
              additionalProperties:
                type: object
                properties:
                  type:
                    type: string
                    description: Data type of the field
                  description:
                    type: string
                    description: Description of the field
      example:
        name: source(97)
        type: 1
        schema:
          description: A description
          type: object
          title: source
          required:
            - CustomerId
            - UsageIdentifier
            - UsageDate
          properties:
            Amount:
              type: number
              description: Amount
            Quantity:
              type: number
              description: Quantity
            UsageDate:
              type: string
              description: UsageDate
            CostCenter:
              type: string
              description: CostCenter
            CustomerId:
              type: string
              description: CustomerId
            UsageIdentifier:
              type: string
              description: UsageIdentifier
    ExportMeterResponse:
      type: object
      properties:
        name:
          type: string
          description: Meter name
        description:
          type: string
          description: Meter description
        type:
          type: string
          description: Meter type (e.g., CUSTOM, STANDARD)
        typeDefinition:
          $ref: '#/components/schemas/MeterTypeDefinition'
          description: The meter definition for non-CUSTOM meters
        latestVersion:
          type: string
          description: The latest version of the meter
        versions:
          type: array
          items:
            $ref: '#/components/schemas/MeterVersionExportResult'
          description: List of all versions for the meter
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/EventSchemaExportResult'
          description: List of event schemas used by this meter
    ImportMeterRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: string
          format: binary
          description: Meter definition file, should match format from Export Meter API
        globalId:
          type: string
          description: >-
            If present and matches an existing meter, updates it. Else, creates
            a new meter with this globalId.
    ImportMeterResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            id:
              type: string
              description: Internal meter ID, unique within tenant
            name:
              type: string
              description: Meter name
            description:
              type: string
              description: Meter description
            type:
              type: string
              description: Meter type
            typeDefinition:
              $ref: '#/components/schemas/MeterTypeDefinition'
              description: The meter definition for non-CUSTOM meters
            latestVersion:
              type: string
              description: The latest version of the meter
            globalId:
              type: string
              description: Meter global ID used for ingestion via Streaming API
            uniqueUploadUrl:
              type: string
              description: The upload URL for usage ingestion
            activeVersionRunStatus:
              type: integer
              description: Run status of the active version
            activeVersionRunStatusDescription:
              type: string
              description: Description of active version run status
            latestVersionRunStatus:
              type: integer
              description: Run status of the latest version
            latestVersionRunStatusDescription:
              type: string
              description: Description of latest version run status
            createdAt:
              type: string
              description: Timestamp of meter creation
            updatedAt:
              type: string
              description: Timestamp of meter update
    CreateFileResponse:
      type: object
      properties:
        id:
          type: string
          description: Internal file ID
        name:
          type: string
          description: File name
        resourceId:
          type: string
          description: Resource ID of the file
        format:
          type: string
          description: File format (CSV, Excel, JSON)
        hasHeader:
          type: boolean
          description: Indicates if the file has a header
        firstRow:
          type: integer
          description: The first row number in the CSV file
        delimiter:
          type: string
          description: Delimiter used in the CSV file
        sheet:
          type: string
          description: The sheet name in the Excel file
        dataRange:
          type: string
          description: Data range in the Excel file
        lines:
          type: integer
          description: Number of lines in the file
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp
    StreamingEvent:
      type: object
      description: A usage event to be ingested into Zuora Mediation.
      properties:
        CustomerId:
          type: string
          description: Unique identifier for the customer.
        UsageIdentifier:
          type: string
          description: Identifier for the usage type.
        UsageDate:
          type: string
          format: date-time
          description: Date and time when the usage occurred.
        Quantity:
          type: number
          description: Quantity of usage.
      required:
        - CustomerId
        - UsageIdentifier
        - UsageDate
        - Quantity
    StreamingIngestionSuccessResponse:
      type: object
      description: Successful ingestion response.
      properties:
        success:
          type: boolean
          description: Whether the ingestion was successful.
        message:
          type: string
          description: Response message with details.
    StreamingIngestionAuthError:
      type: object
      description: >-
        Response for authentication, authorization, or other system-level
        errors.
      properties:
        message:
          type: string
          description: Error message describing the problem.
      required:
        - message
    BulkDeleteEventRequest:
      type: object
      required:
        - file
        - storeId
      properties:
        file:
          type: string
          format: binary
          description: The file that contains the event IDs to delete.
        storeId:
          type: integer
          description: ID of the event store to delete events from.
    BulkDeleteEventResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the bulk delete request was successful.
        data:
          type: object
          properties:
            queryId:
              type: string
              description: Query ID to track the bulk delete operation.
    LatestEventStoreJobResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          type: object
          properties:
            id:
              type: string
              description: Internal event store query history ID.
            eventStoreId:
              type: string
              description: Related event store ID.
            queryId:
              type: string
              description: Query ID.
            status:
              type: integer
              description: |
                Run status of the job. Possible values:
                - 5: RUNNING
                - 6: PAUSED
                - 7: COMPLETED
                - 8: FAILED
              minimum: 5
              maximum: 8
            operationType:
              type: string
              description: Operation type.
            inputRecordCount:
              type: integer
              description: Input record count of this query.
            uniqueRecordCount:
              type: integer
              description: Unique record count of this query.
            modifiedRecordCount:
              type: integer
              description: Modified record count of this query.
            createdAt:
              type: string
              description: Created timestamp of the query history.
            updatedAt:
              type: string
              description: Updated timestamp of the query history.
    SubmitEventStoreQueryRequest:
      type: object
      required:
        - query
      properties:
        query:
          type: string
          description: The query clause.
      example:
        query: select * from usage_event
    SubmitEventStoreQueryResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          description: >-
            Contains metadata and result details for the submitted event store
            query.
          type: object
          properties:
            queryId:
              type: string
              description: >-
                Unique identifier of the submitted event store query. Use this
                ID to poll for status and fetch results.
          additionalProperties:
            type: object
            description: >-
              Stores extra or custom fields that are not defined in the main
              schema.
        previousPage:
          type: string
          description: >-
            Cursor or URL for the previous page of audit records, if available.
            Used for backward pagination.
        nextPage:
          type: string
          description: >-
            Cursor or URL for the next page of audit records, if available. Used
            for forward pagination.
        error:
          $ref: '#/components/schemas/Error'
          description: >-
            Container for error information returned by the API when the request
            fails.
    QueryResult:
      type: object
      properties:
        isFailed:
          type: boolean
          description: A boolean flag indicating whether the query execution has failed.
        totalCount:
          type: integer
          format: int32
          description: >-
            The total number of rows that match the conditions defined in the
            executed query.
        columns:
          type: array
          description: A list containing details of each column in the store.
          items:
            type: object
            properties:
              name:
                type: string
                description: The column name.
              logicalType:
                type: object
                description: Logical type information for the column.
                properties:
                  type:
                    type: string
                    description: >-
                      The data type of the column (for example, VARCHAR, BIGINT,
                      DECIMAL).
                  nullable:
                    type: boolean
                    description: Indicates whether the column can contain null values.
                  length:
                    type: integer
                    format: int32
                    description: For string types, the maximum length.
                  precision:
                    type: integer
                    description: For DECIMAL types, the total number of digits.
                  scale:
                    type: integer
                    description: >-
                      For DECIMAL types, the number of digits to the right of
                      the decimal point.
                additionalProperties: false
              comment:
                type: string
                nullable: true
                description: Optional comment or description for the column.
            additionalProperties: false
        rows:
          type: array
          description: The list of rows returned by the query.
          items:
            type: object
            properties:
              kind:
                type: string
                description: The kind of change for the row (for example, INSERT).
              fields:
                type: array
                description: >-
                  The ordered list of field values for this row. Each position
                  corresponds to a column in the columns array.
                items: {}
            additionalProperties: false
        message:
          type: string
          description: Error message displayed for a failed query execution.
        ready:
          type: boolean
          description: A boolean flag indicating whether the query execution has completed.
    GetQueryResultsResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates whether the request was successful.
        data:
          description: >-
            Contains the query result object, including the query ID, execution
            status flags, total row count, column metadata, and the list of rows
            returned by the query.
          $ref: '#/components/schemas/QueryResult'
        previousPage:
          type: string
          description: >-
            Cursor for the previous page of audit records, if available. Used
            for backward pagination.
        nextPage:
          type: string
          description: >-
            Cursor for the next page of audit records, if available. Used for
            forward pagination.
    CommitmentStatus:
      type: string
      enum:
        - Active
        - Canceled
      description: |
        Status of the commitment.
    CommitmentCustomFields:
      type: object
      description: Container for custom fields of a Commitment object.
      additionalProperties:
        description: A custom field on the Commitment object.
        type: string
    GetCommitmentResponse:
      type: object
      properties:
        id:
          type: string
          description: |
            ID of the commitment.
        status:
          $ref: '#/components/schemas/CommitmentStatus'
        version:
          type: integer
          description: |
            Version of the commitment.
        startDate:
          type: string
          format: date
          description: The start date of the commitment.
        endDate:
          type: string
          format: date
          description: The end date of the commitment.
        totalAmount:
          type: number
          format: double
          description: The commitment amount.
        currency:
          type: string
          description: |
            Currency of the commitment.
        orderNumber:
          type: string
          maxLength: 32
          description: The number of the order.
        orderId:
          type: string
          maxLength: 32
          description: The ID of the order.
        accountId:
          type: string
          maxLength: 32
          description: |
            The ID of the commitment owner account.
        accountNumber:
          type: string
          maxLength: 100
          description: >-
            Use this field to assign an existing account as the owner of an
            Commitment.
        commitmentNumber:
          type: string
          maxLength: 100
          description: |
            The number of the commitment.
        name:
          type: string
          maxLength: 255
          description: |
            The name of the commitment.
        type:
          type: string
          description: |
            The type of the commitment.
          enum:
            - MinCommitment
            - MaxCommitment
        description:
          type: string
          maxLength: 500
          description: |
            The description about this commitment.
        priority:
          type: integer
          description: >
            The priority of the commitment.

            It defines the evaluation order of the commitment. The lower the
            number, the higher the priority.

            When two commitments have the same priority, the one with the
            earlier created time will be evaluated first.
        customFields:
          $ref: '#/components/schemas/CommitmentCustomFields'
        accountReceivableAccountingCode:
          description: The accounting code on the Commitment object for customers
          type: string
          maxLength: 200
        adjustmentLiabilityAccountingCode:
          type: string
          maxLength: 100
          description: >
            The accounting code on the commitment for customers.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        adjustmentRevenueAccountingCode:
          type: string
          maxLength: 100
          description: >
            The accounting code on the commitment for customers.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        contractAssetAccountingCode:
          type: string
          maxLength: 100
          description: >
            The accounting code on the commitment for customers.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        contractLiabilityAccountingCode:
          type: string
          maxLength: 100
          description: >
            The accounting code on the commitment for customers.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        contractRecognizedRevenueAccountingCode:
          type: string
          maxLength: 100
          description: >
            The accounting code on the commitment for customers.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        deferredRevenueAccountingCode:
          type: string
          maxLength: 100
          description: The deferred revenue accounting code for the commitment.
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          default: true
          description: >
            The flag to exclude commitment related booking items from revenue
            accounting.
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            The flag to exclude commitment related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        eligibleAccountConditions:
          $ref: '#/components/schemas/EligibleAccountCondition'
        eligibleChargeConditions:
          $ref: '#/components/schemas/EligibleChargeCondition'
        periodAlignmentOption:
          $ref: '#/components/schemas/PeriodAlignmentOptionEnum'
        specificPeriodAlignmentDate:
          type: string
          format: date
          description: >-
            The specific date for period alignment, required if
            `periodAlignmentOption` is `SpecificDate`.
        isAllocationEligible:
          type: boolean
          description: >
            This field is used to identify if the commitment is allocation
            eligible in revenue recognition.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        isUnbilled:
          type: boolean
          description: >
            This field is used to dictate how to perform the accounting during
            revenue recognition.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        recognizedRevenueAccountingCode:
          type: string
          maxLength: 100
          description: The recognized revenue accounting code for the commitment.
        revenueAmortizationMethod:
          description: >
            This field is used to dictate the type of revenue amortization
            method.
          type: string
          maxLength: 200
        revenueRecognitionRule:
          type: string
          description: The revenue recognition rule for the commitment.
        revenueRecognitionTiming:
          description: >
            This field is used to dictate the type of revenue recognition
            timing.
          type: string
          maxLength: 200
        unbilledReceivablesAccountingCode:
          type: string
          maxLength: 100
          description: >
            The accounting code on the commitment for customers.


            **Note**: This field is only available if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature enabled.
        taxable:
          type: boolean
          description: >
            Determines whether the true-up invoice of a commitment is taxable.
            If the value is `true`, the tax code and tax mode are required. 
        taxCode:
          type: string
          description: >
            Identifies which tax rules and tax rates to apply to the
            corresponding billing document.
        taxMode:
          type: string
          description: >
            The tax mode that determines whether tax is included or exclueded
            from the billing document.
          enum:
            - TaxInclusive
            - TaxExclusive
    GetCommitmentsResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of commitments returned.
          example: 1
        page:
          type: integer
          description: Current page number.
          example: 1
        page_size:
          type: integer
          description: Number of commitments per page.
          example: 1
        commitments:
          type: array
          description: |
            List of commitments.
          items:
            $ref: '#/components/schemas/GetCommitmentResponse'
    PeriodStatusResponse:
      type: string
      enum:
        - Active
        - Canceled
        - Evaluated
        - ActiveWithDrawdown
      description: |
        Status of the commitment period.
    CommitmentPeriod:
      type: object
      title: CommitmentPeriod
      properties:
        id:
          type: string
          description: ID of the commitment period.
        commitmentId:
          type: string
          description: ID of the commitment.
        commitmentNumber:
          type: string
          description: The number of the commitment.
        version:
          type: integer
          description: Version of the commitment period.
        type:
          $ref: '#/components/schemas/CommitmentTypeEnum'
        priority:
          type: integer
          description: Priority of the commitment.
        currency:
          type: string
          description: Currency of the commitment.
        isProrated:
          type: boolean
          description: Indicates if the period is prorated.
        amount:
          description: The total amount of the commitment within the current period.
          type: number
          format: double
        status:
          $ref: '#/components/schemas/PeriodStatusResponse'
        startDate:
          description: Ths start date of the commitment period.
          type: string
          format: date
        endDate:
          description: The end date of the commitment period.
          type: string
          format: date
    ListCommitmentPeriodsResponse:
      title: ListCommitmentPeriodsResponse
      properties:
        total:
          type: integer
          description: >-
            Total number of periods available for the given commitment/Total
            commitments for given account.
        page:
          type: integer
          description: The current page number.
        pageSize:
          type: integer
          description: The number of results returned per page.
        periods:
          description: A list of commitment period objects.
          type: array
          items:
            $ref: '#/components/schemas/CommitmentPeriod'
    PeriodBalanceStatus:
      type: string
      enum:
        - ACTIVE
        - EVALUATED
        - ACTIVE_WITH_DRAWDOWN
      description: >
        A subset of the Period status. Periods in the 'Cancelled' status will
        not be included.
    PeriodBalance:
      type: object
      title: PeriodBalance
      properties:
        id:
          type: string
          description: ID of the commitment period.
        committedAmount:
          description: The total amount of the commitment within the current period.
          type: number
          format: double
        balance:
          description: The balance amount to be spent within the current period.
          type: number
          format: double
        totalSpend:
          description: The total amount spent within the current period.
          type: number
          format: double
        status:
          $ref: '#/components/schemas/PeriodBalanceStatus'
        startDate:
          description: Ths start date of the commitment period.
          type: string
          format: date
        endDate:
          description: The end date of the commitment period.
          type: string
          format: date
    GetCommitmentBalanceResponse:
      title: GetCommitmentBalanceResponse
      properties:
        total:
          type: integer
          description: Total commitments for the given account.
        page:
          type: integer
          description: The current page number.
        pageSize:
          type: integer
          description: The number of results returned per page.
        periods:
          description: A list of commitment period objects.
          type: array
          items:
            $ref: '#/components/schemas/PeriodBalance'
    CommitmentScheduleStatus:
      type: string
      enum:
        - Active
        - Canceled
        - Evaluated
      description: |
        Status of the commitment schedule.
    ListCommitmentScheduleOutput:
      type: object
      title: ListCommitmentScheduleOutput
      properties:
        id:
          type: string
          description: ID of the commitment schedule.
        commitmentId:
          type: string
          description: ID of the commitment.
        commitmentNumber:
          type: string
          description: The number of the commitment.
        version:
          description: Version of the commitment schedule.
          type: integer
        startDate:
          description: Ths start date of the commitment schedule.
          type: string
          format: date
        endDate:
          description: The end date of the commitment schedule.
          type: string
          format: date
        totalAmount:
          description: The total amount of the commitment schedule.
          type: number
          format: double
        amount:
          description: The non-prorated actual amount of the commitment schedule.
          type: number
          format: double
        amountBase:
          $ref: '#/components/schemas/AmountBaseEnum'
        periodType:
          $ref: '#/components/schemas/PeriodTypeEnum'
        specificPeriodLength:
          description: >-
            The specific length of the period, required if `periodType` is
            `SpecificMonths`.
          type: integer
        status:
          $ref: '#/components/schemas/CommitmentScheduleStatus'
    GetCommitmentScheduleResponse:
      title: GetCommitmentScheduleResponse
      properties:
        schedules:
          description: A list of commitment schedule objects.
          type: array
          items:
            $ref: '#/components/schemas/ListCommitmentScheduleOutput'
        total:
          type: integer
          description: Total number of schedules available for the given commitment.
        page:
          type: integer
          description: The current page number.
        pageSize:
          type: integer
          description: The number of results returned per page.
    GETAdjustmentByIdResponseType:
      allOf:
        - properties:
            adjustmentId:
              description: |
                The system generated delivery adjustment ID.
              format: UUID
              type: string
            adjustmentNumber:
              description: |
                The system generated delivery adjustment Number.
              type: string
            amount:
              description: |
                The amount of the delivery adjustment.
              type: number
            billingDate:
              description: >
                The billing date is same as the delivery date of the delivery
                adjustment, in `yyyy-mm-dd` format.
              format: date
              type: string
            chargeNumber:
              description: >
                The charge number in the subscription for which the delivery
                adjustment is created.
              type: string
            creditMemoNumber:
              description: |
                The Credit Memo generated for the delivery adjustment.
              type: string
            debitMemoNumber:
              description: >
                The Debit Memo generated to write off the Credit Memo for the
                delivery adjustment.    

                **Note**: This field is only available when the delivery
                adjustment is in `Cancelled` status.
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for the deferred revenue, such as Monthly
                Recurring Liability. 


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            deliveryDate:
              description: |
                The delivery adjustment date, in `yyyy-mm-dd` format.
              format: date
              type: string
            deliveryDay:
              description: |
                The delivery adjustment day of the week.
              format: string
              type: string
            reason:
              description: |
                The reason for the delivery adjustment.
              type: string
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for the recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            status:
              description: >
                The status of the delivery adjustment will be `Billed` or
                `Cancelled`.               
              type: string
            subscriptionNumber:
              description: >
                The subscription number for which the delivery adjustment is
                created.
              type: string
          type: object
    GETAdjustmentsBySubscriptionNumberResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            adjustments:
              description: |
                Container for all the delivery adjustments of a subscription.
              items:
                $ref: '#/components/schemas/GETAdjustmentByIdResponseType'
              type: array
          type: object
    POSTCreateBillingAdjustmentRequestType:
      example:
        chargeNumbers:
          - string
          - string
        deferredRevenueAccountingCode: string
        endDate: '2023-02-27'
        exclusion:
          - chargeNumbers:
              - string
              - string
            deliveryDate: '2023-02-26'
          - chargeNumbers:
              - string
              - string
            deliveryDate: '2023-05-27'
        reason: string
        recognizedRevenueAccountingCode: string
        revenueRecognitionRuleName: string
        startDate: '2023-02-26'
        subscriptionNumber: string
        type: DeliveryCredit
      properties:
        accountNumber:
          description: |
            The account number for which the delivery adjustment is created.  

            **Note**: 
              - The account number should be of the subscription owner.
              - Only one of accountNumber or subscriptionNumber should be provided.
          type: string
        chargeNumbers:
          description: >
            An optional container to specify charge numbers in the subscription
            for which the delivery adjustment needs to be created.
          items:
            type: string
          type: array
        deferredRevenueAccountingCode:
          description: >
            The accounting code for the deferred revenue, such as Monthly
            Recurring Liability.


            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
          type: string
        endDate:
          description: >
            The end date of the delivery adjustment, in `yyyy-mm-dd` format.
            This is inclusive.
          format: date
          type: string
        exclusion:
          description: >
            The charge numbers and the corresponding dates for exclusion of
            delivery adjustment.
          items:
            properties:
              chargeNumbers:
                description: >
                  The charge numbers to be excluded from delivery adjustment on
                  the specified delivery date.
                items:
                  type: string
                type: array
              deliveryDate:
                description: >
                  The date on which the delivery adjustment has to be excluded,
                  in `yyyy-mm-dd` format.
                format: date
                type: string
            type: object
          type: array
        reason:
          description: |
            The reason for the delivery adjustment.
          type: string
        recognizedRevenueAccountingCode:
          description: >
            The accounting code for the recognized revenue, such as Monthly
            Recurring Charges or Overage Charges.


            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
          type: string
        revenueRecognitionRuleName:
          description: >
            The name of the revenue recognition rule governing the revenue
            schedule.



            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
          type: string
        startDate:
          description: >
            The start date of the delivery adjustment, in `yyyy-mm-dd` format.
            This is inclusive.
          format: date
          type: string
        subscriptionNumber:
          description: >
            The subscription number for which the delivery adjustment is
            created.


            **Note**: Only one of accountNumber or subscriptionNumber should be
            provided.
          type: string
        type:
          description: |
            The type of delivery adjustment.
          enum:
            - DeliveryCredit
          type: string
        creditMemoCustomFields:
          additionalProperties:
            description: >
              Custom fields of the Credit Memo object.  The name of each custom
              field has the form <code>*customField*__c</code>.  Custom field
              names are case sensitive. See <a
              href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
              target="_blank">Manage Custom Fields</a> for more information.
            type: object
          description: >
            Container for custom fields of the Credit Memo object. When creating
            a delivery adjustment, Zuora generates a credit memo automatically.
            You can use this field to specify the custom fields of the credit
            memo associated with this adjustment.
          title: creditMemoCustomFields
          type: object
      required:
        - startDate
        - endDate
      type: object
    POSTAdjustmentResponseType:
      allOf:
        - properties:
            adjustmentId:
              description: |
                The system generated delivery adjustment ID.
              format: UUID
              type: string
            adjustmentNumber:
              description: |
                The system generated delivery adjustment number.
              format: string
              type: string
            amount:
              description: |
                The amount of the delivery adjustment.
              type: number
            billingDate:
              description: >
                The billing date is same as the delivery date of the delivery
                adjustment, in `yyyy-mm-dd` format.
              format: date
              type: string
            chargeNumber:
              description: >
                The charge number in the subscription for which the delivery
                adjustment is created.
              type: string
            creditMemoNumber:
              description: |
                The Credit Memo generated for the delivery adjustment.
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for the deferred revenue, such as Monthly
                Recurring Liability.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            deliveryDate:
              description: |
                The delivery adjustment date, in `yyyy-mm-dd` format.
              format: date
              type: string
            deliveryDay:
              description: |
                The delivery adjustment day of the week.
              type: string
            eligible:
              description: >
                The eligible flag is set as true for a successfully created
                delivery adjustment.
              type: boolean
            reason:
              description: |
                The reason for the delivery adjustment.
              type: string
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for the recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            status:
              description: >
                The status of the delivery adjustment will be `Billed` or
                `Cancelled`.
              type: string
            subscriptionNumber:
              description: >
                The subscription number for which the delivery adjustment is
                created.
              type: string
          type: object
    POSTIneligibleAdjustmentResponseType:
      allOf:
        - properties:
            adjustmentId:
              description: |
                The system generated delivery adjustment ID.
              format: UUID
              type: string
            adjustmentNumber:
              description: |
                The system generated delivery adjustment number.
              format: string
              type: string
            amount:
              description: |
                The amount of the delivery adjustment.
              type: number
            billingDate:
              description: |
                The billing date of the delivery adjustment.
              format: date
              type: string
            chargeNumber:
              description: >
                The charge number in the subscription for which the delivery
                adjustment is created.
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for the deferred revenue, such as Monthly
                Recurring Liability.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            deliveryDate:
              description: |
                The delivery adjustment date, in `yyyy-mm-dd` format.
              format: date
              type: string
            deliveryDay:
              description: |
                The delivery adjustment day of the week.
              format: string
              type: string
            eligible:
              description: >
                The eligible flag is set as false for an unsuccessful delivery
                adjustment.
              type: boolean
            errorMessage:
              description: >
                The reason due to which a delivery adjustment is not eligible on
                the given date. 
              type: string
            reason:
              description: |
                The reason for the delivery adjustment.
              type: string
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for the recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.


                **Note**: For the credit memo generated by the delivery
                adjustment, if this field is not specified, the value inherits
                from the subscription rate plan charge.
              type: string
            status:
              description: |
                The status of the delivery adjustment.
              type: string
            subscriptionNumber:
              description: >
                The subscription number for which the delivery adjustment is
                created.
              type: string
          type: object
    GETAdjustmentsResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            adjustments:
              description: |
                Container for delivery adjustments of a subscription.
              items:
                $ref: '#/components/schemas/POSTAdjustmentResponseType'
              type: array
            ineligibleAdjustments:
              description: |
                Container for ineligible delivery adjustments of a subscription.
              items:
                $ref: '#/components/schemas/POSTIneligibleAdjustmentResponseType'
              type: array
            totalAmount:
              description: |
                The total amount of all the delivery adjustments.
              type: number
            totalNumberOfDeliveries:
              description: |
                The total number of all delivery adjustments.
              type: number
          type: object
    POSTPreviewBillingAdjustmentRequestType:
      example:
        chargeNumbers:
          - string
          - string
        deferredRevenueAccountingCode: string
        endDate: '2023-02-27'
        exclusion:
          - chargeNumbers:
              - string
              - string
            deliveryDate: '2023-02-26'
          - chargeNumbers:
              - string
              - string
            deliveryDate: '2023-05-27'
        reason: string
        recognizedRevenueAccountingCode: string
        revenueRecognitionRuleName: string
        startDate: '2023-02-26'
        subscriptionNumber: string
        type: DeliveryCredit
      properties:
        accountNumber:
          description: |
            The account number for which the delivery adjustment is created.
            **Note**: 
              - The account number should be of the subscription owner.
              - Only one of accountNumber or subscriptionNumber should be provided.
          type: string
        chargeNumbers:
          description: >
            An optional container to specify charge numbers in the subscription
            for which the delivery adjustment needs to be created.
          items:
            type: string
          type: array
        deferredRevenueAccountingCode:
          description: >
            The accounting code for the deferred revenue, such as Monthly
            Recurring Liability.


            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
          type: string
        endDate:
          description: >
            The end date of the delivery adjustment, in `yyyy-mm-dd` format.
            This is inclusive.
          format: date
          type: string
        reason:
          description: |
            The reason for the delivery adjustment.
          type: string
        recognizedRevenueAccountingCode:
          description: >
            The accounting code for the recognized revenue, such as Monthly
            Recurring Charges or Overage Charges.


            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
          type: string
        revenueRecognitionRuleName:
          description: >
            The name of the revenue recognition rule governing the revenue
            schedule.


            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
          type: string
        startDate:
          description: >
            The start date of the delivery adjustment, in `yyyy-mm-dd` format.
            This is inclusive.
          format: date
          type: string
        subscriptionNumber:
          description: >
            The subscription number for which the delivery adjustment is
            created.


            **Note**: Only one of accountNumber or subscriptionNumber should be
            provided.
          type: string
        type:
          description: |
            The type of delivery adjustment.
          enum:
            - DeliveryCredit
          type: string
      required:
        - startDate
        - endDate
      type: object
    CancelBillingAdjustmentRequest:
      example:
        debitMemoCustomFields:
          trackingNumber__c: '001'
      description: |
        Information about `CancelBillingAdjustment`.
      properties:
        debitMemoCustomFields:
          additionalProperties:
            description: >
              Custom fields of the Debit Memo object.  The name of each custom
              field has the form <code>*customField*__c</code>.  Custom field
              names are case sensitive. See <a
              href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
              target="_blank">Manage Custom Fields</a> for more information.
            type: object
          description: >
            Container for custom fields of the Debit Memo object. When
            cancelling a delivery adjustment, Zuora generates a debit memo
            automatically. You can use this field to specify the custom fields
            of the debit memo associated with the cancellation of adjustment.
          title: debitMemoCustomFields
          type: object
    GETCancelAdjustmentResponseType:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            debitMemoNumber:
              description: >
                The Debit Memo generated to write off the Credit Memo for the
                delivery adjustment.       
              type: string
          type: object
    GETBillingDocumentsResponseType:
      properties:
        accountId:
          description: The ID of the customer account associated with the billing document.
          format: uuid
          type: string
        amount:
          description: |
            The total amount of the billing document.
          format: double
          type: number
        balance:
          description: |
            The balance of the billing document.
          format: double
          type: number
        documentDate:
          description: >
            The date of the billing document. The date can be the invoice date
            for invoices, credit memo date for credit memos, or debit memo date
            for debit memos.
          format: date
          type: string
        documentNumber:
          description: |
            The number of the billing document.
          type: string
        documentType:
          description: |
            The type of the billing document.
          enum:
            - Invoice
            - CreditMemo
            - DebitMemo
          type: string
        id:
          description: |
            The ID of the billing document.
          type: string
        status:
          description: |
            The current status of the billing document.
          enum:
            - Draft
            - Posted
            - Canceled
            - Error
          type: string
        currency:
          description: >
            The currency of the billing document.


            **Note:** By default, the currency on a billing document matches the
            default currency set on the associated account. 

            However, Zuora now offers a Multiple Currencies feature to support
            different currencies for billing documents, allowing flexibility
            beyond the account-level currency. 

            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currency</a>.
          type: string
          nullable: true
      title: documents
      type: object
    BillingDocumentQueryResponseElementType:
      properties:
        documents:
          description: |
            Container for billing documents.
          items:
            $ref: '#/components/schemas/GETBillingDocumentsResponseType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTBillingDocumentFilesDeletionJobRequest:
      example:
        accountIds:
          - 4028905558b483220158b48983dd0015
          - 6028905558b483220158b68983dd0016
      properties:
        accountIds:
          description: >
            Container for the IDs of the accounts that you want to create the
            billing document files deletion job for.


            **Note**: When creating jobs to delete billing document PDF files,
            you must specify either set of `accountIds` or `accountKeys` in the
            request body.
          items:
            type: string
          type: array
        accountKeys:
          description: >
            Container for the IDs and/or numbers of the accounts that you want
            to create the billing document files deletion job for.


            **Note**: When creating jobs to delete billing document PDF files,
            you must specify either set of `accountIds` or `accountKeys` in the
            request body.
          items:
            type: string
          type: array
      type: object
    POSTBillingDocumentFilesDeletionJobResponse:
      properties:
        id:
          description: |
            The unique ID of the billing document file deletion job.
          type: string
        status:
          description: |
            The status of the billing document file deletion job.
          enum:
            - Pending
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETBillingDocumentFilesDeletionJobResponse:
      properties:
        id:
          description: |
            The unique ID of the billing document file deletion job.
          type: string
        status:
          description: |
            The status of the billing document file deletion job.
          enum:
            - Pending
            - Processing
            - Completed
            - Error
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    PostGenerateBillingDocumentType:
      example:
        subscriptionIds:
          - 8ad09be490a1ec6a0190a56eb69d4cd3
        effectiveDate: '2024-07-01'
        targetDate: '2024-08-31'
      properties:
        autoPost:
          default: false
          description: >
            Whether to automatically post the billing documents after the draft
            billing documents are generated. 


            If an error occurs during posting billing documents, the draft
            billing documents are not generated too.
          enum:
            - true
            - false
          type: boolean
        autoRenew:
          default: false
          description: >
            Whether to automatically renew the subscriptions with **Auto Renew**
            set to **Yes**. 
          enum:
            - true
            - false
          type: boolean
        chargeTypeToExclude:
          description: >
            The types of the charges to be excluded from the generation of
            billing documents. The field values are case insensitive. Supported
            values include `onetime`, `recurring`, and `usage`. 
          items:
            type: string
          type: array
        creditMemoReasonCode:
          description: >-
            A code identifying the reason for the credit memo transaction that
            is generated by the request. The value must be an existing reason
            code. If you do not pass the field or pass the field with empty
            value, Zuora uses the default reason code.
          type: string
        effectiveDate:
          description: >
            The date on which to generate the billing documents, in `yyyy-mm-dd`
            format.
          format: date
          type: string
        includeSubscriptions:
          default: true
          description: |
            Indicates whether to bill subscriptions in the bill run.
          type: boolean
        includeOrderLineItems:
          default: true
          description: |
            Indicates whether to bill order line items in the bill run.
          type: boolean
        subscriptionIds:
          description: >
            The IDs of the subscriptions that you want to create the billing
            documents for. Each value must be the ID of the latest version of an
            active subscription.
          items:
            type: string
          type: array
        targetDate:
          description: >
            The date used to determine which charges are to be billed, in
            `yyyy-mm-dd` format.
          format: date
          type: string
      type: object
    CreditMemoResponseType:
      properties:
        id:
          description: |
            The ID of the generated credit memo.
          type: string
      title: creditMemos
      type: object
    InvoiceResponseType:
      properties:
        id:
          description: |
            The ID of the generated invoice.
          type: string
      title: invoices
      type: object
    GenerateBillingDocumentResponseType:
      properties:
        creditMemos:
          description: >
            Container for generated credit memos.


            **Note:** This container is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: '#/components/schemas/CreditMemoResponseType'
          type: array
        invoices:
          description: |
            Container for generated invoics.
          items:
            $ref: '#/components/schemas/InvoiceResponseType'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    DiscountItemObjectNSFields:
      description: >
        Container for discount Item fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the invoice item's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the invoice item was synchronized with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: discountItemFieldsNS
      type: object
    DiscountItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Discount Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Discount Item object.
      title: discountItemFieldsCustom
      type: object
    PutDiscountItemType:
      allOf:
        - properties:
            accountingCode:
              description: |
                The accounting code associated with the discount item.
              type: string
            adjustmentLiabilityAccountingCode:
              description: >
                The accounting code for adjustment liability.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            adjustmentRevenueAccountingCode:
              description: >
                The accounting code for adjustment revenue.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            amount:
              description: >
                The amount of the discount item.

                - Should be a negative number. For example, `-10`.

                - Always a fixed amount no matter whether the discount charge
                associated with the discount item uses the [fixed-amount model
                or percentage
                model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model).

                - For tax-exclusive discount items, this amount indicates the
                discount item amount excluding tax.

                - For tax-inclusive discount items, this amount indicates the
                discount item amount including tax.
              format: number
              type: string
            bookingReference:
              description: |
                The booking reference of the discount item.
              type: string
            chargeDate:
              description: >
                The date when the discount item is charged, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            chargeName:
              description: >
                The name of the charge associated with the discount item.

                This field is required if the `productRatePlanChargeId` field is
                not specified in the request.
              type: string
            contractAssetAccountingCode:
              description: >
                The accounting code for contract asset.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            contractLiabilityAccountingCode:
              description: >
                The accounting code for contract liability.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            contractRecognizedRevenueAccountingCode:
              description: >
                The accounting code for contract recognized revenue.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for the deferred revenue, such as Monthly
                Recurring Liability.

                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            description:
              description: |
                The description of the discount item.
              type: string
            id:
              description: |
                The unique ID of the discount item.
              type: string
            itemType:
              description: |
                The type of the discount item.
              type: string
            purchaseOrderNumber:
              description: |
                The purchase order number associated with the discount item.
              type: string
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for the recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.

                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            revRecCode:
              description: |
                The revenue recognition code.
              type: string
            revRecTriggerCondition:
              description: |
                The date when revenue recognition is triggered.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
              type: string
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.

                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            sku:
              description: >
                The SKU of the invoice item. The SKU of the discount item must
                be different from the SKU of any existing product.
              type: string
            unbilledReceivablesAccountingCode:
              description: >
                The accounting code for unbilled receivables.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            unitPrice:
              description: >
                The per-unit price of the discount item.

                If the discount charge associated with the discount item uses
                the percentage model, the unit price will display as a
                percentage amount in PDF. For example: if unit price is 5.00, it
                will display as 5.00% in PDF.
              format: number
              type: string
          required:
            - amount
          title: invoiceItems
          type: object
        - $ref: '#/components/schemas/DiscountItemObjectNSFields'
        - $ref: '#/components/schemas/DiscountItemObjectCustomFields'
    InvoiceItemObjectNSFields:
      description: >
        Container for Invoice Item fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the invoice item's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the invoice item was synchronized with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: invoiceItemFieldsNS
      type: object
    InvoiceItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Invoice Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Invoice Item object.
      title: invoiceItemFieldsCustom
      type: object
    PutInvoiceItemType:
      allOf:
        - properties:
            accountingCode:
              description: |
                The accounting code associated with the invoice item.
              type: string
            adjustmentLiabilityAccountingCode:
              description: >
                The accounting code for adjustment liability. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            adjustmentRevenueAccountingCode:
              description: >
                The accounting code for adjustment revenue. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            amount:
              description: >
                The amount of the invoice item. 


                - For tax-inclusive invoice items, the amount indicates the
                invoice item amount including tax. 

                - For tax-exclusive invoice items, the amount indicates the
                invoice item amount excluding tax.
              type: number
            bookingReference:
              description: |
                The booking reference of the invoice item.  


                **Note**: This field is only available if `id` is null.
              type: string
            chargeDate:
              description: >
                The date when the invoice item is charged, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            chargeName:
              description: >
                The name of the charge associated with the invoice item. 


                This field is required if the `productRatePlanChargeId` field is
                not specified in the request.
              type: string
            contractAssetAccountingCode:
              description: >
                The accounting code for contract asset. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            contractLiabilityAccountingCode:
              description: >
                The accounting code for contract liability. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            contractRecognizedRevenueAccountingCode:
              description: >
                The accounting code for contract recognized revenue. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for the deferred revenue, such as Monthly
                Recurring Liability.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            delete:
              description: >
                Indicates whether to delete the existing invoice item.



                **Note**: Set this field to `true` and specify an item `id` to
                delete an item.
              type: boolean
            description:
              description: |
                The description of the invoice item.
              type: string
            discountItems:
              description: >
                Container for discount items. The maximum number of discount
                items is 10.
              items:
                $ref: '#/components/schemas/PutDiscountItemType'
              type: array
            excludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the invoice item from revenue accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: boolean
            id:
              description: >
                The unique ID of the invoice item.

                - Specify this field when updating or deleting an existing memo
                item. 

                - Do not specify this field when creating a memo item.
              type: string
            itemType:
              description: |
                The type of the invoice item.
              type: string
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the invoice item is
                created from. 


                If you specify the ID of a product rate plan charge in this
                field, no matter whether the following fields are specified with
                values, the following fields use the values from the
                corresponding product rate plan charge instead of the specified
                values:
                  - `chargeName`
                  - `sku`
                  - `uom`
                  - `taxCode`
                  - `taxMode`
                  - `accountingCode`
                  - `deferredRevenueAccountingCode`
                  - `recognizedRevenueAccountingCode`


                **Note**: Do not specify the invoice item `id` when specifying
                this field. 
              type: string
            purchaseOrderNumber:
              description: |
                The purchase order number associated the invoice item.
              type: string
            quantity:
              description: |
                The number of units for the invoice item.
              format: number
              type: string
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for the recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            revRecCode:
              description: |
                The revenue recognition code.
              type: string
            revRecTriggerCondition:
              description: |
                The date when revenue recognition is triggered.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
              type: string
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            serviceEndDate:
              description: |
                The service end date of the invoice item.
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the invoice item.
              format: date
              type: string
            sku:
              description: >
                The SKU of the invoice item. The SKU of the invoice item must be
                different from the SKU of any existing product.
              type: string
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to the invoice item.


                **Note:** 

                - This field is only available if you have Taxation enabled.

                - If the values of both `taxCode` and `taxMode` fields are
                changed to `null` when updating a standalone invoice, the
                corresponding `invoiceItems` > `taxItems` field and its nested
                fields specified in the creation request will be removed.
              type: string
            taxMode:
              description: >
                The tax mode of the invoice item, indicating whether the amount
                of the invoice item includes tax.


                **Note:** 

                - This field is only available if you have Taxation enabled.

                - If the values of both `taxCode` and `taxMode` fields are
                changed to `null` when updating a standalone invoice, the
                corresponding `invoiceItems` > `taxItems` field and its nested
                fields specified in the creation request will be removed.
              enum:
                - TaxInclusive
                - TaxExclusive
              type: string
            unbilledReceivablesAccountingCode:
              description: >
                The accounting code for unbilled receivables. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            unitPrice:
              description: |
                The per-unit price of the invoice item.
              format: number
              type: string
            uom:
              description: |
                The unit of measure.
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceItemObjectNSFields'
        - $ref: '#/components/schemas/InvoiceItemObjectCustomFields'
    InvoiceObjectNSFields:
      description: >
        Container for Invoice fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the invoice's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the invoice was synchronized with NetSuite. Only available
            if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: invoiceFieldsNS
      type: object
    InvoiceObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Invoice object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Invoice object.
      title: invoiceFieldsCustom
      type: object
    BatchInvoiceType:
      allOf:
        - properties:
            autoPay:
              description: >
                Whether invoices are automatically picked up for processing in
                the corresponding payment run.


                By default, invoices are automatically picked up for processing
                in the corresponding payment run.
              type: boolean
            comments:
              description: >
                Additional information related to the invoice that a Zuora user
                added to the invoice.
              maxLength: 255
              type: string
            dueDate:
              description: |
                The date by which the payment for this invoice is due.
              format: date
              type: string
            id:
              description: |
                The ID of the invoice to be updated.
              type: string
            invoiceDate:
              description: >
                The new invoice date of the invoice. The new invoice date cannot
                fall in a closed accounting period.


                You can only specify `invoiceDate` or `dueDate` in one request.
                Otherwise, an error occurs.
              format: date
              type: string
            invoiceItems:
              description: >
                Container for invoice items. The maximum number of items is
                1,000.
              items:
                $ref: '#/components/schemas/PutInvoiceItemType'
              type: array
            transferredToAccounting:
              description: >
                Whether the invoice was transferred to an external accounting
                system.
              enum:
                - Processing
                - 'Yes'
                - Error
                - Ignore
              type: string
            templateId:
              description: >
                The ID of the invoice template associated with the invoice.


                **Note**: This field is only available if you have the <a

                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"

                target="_blank">Flexible Billing Attributes</a> feature enabled.
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceObjectNSFields'
        - $ref: '#/components/schemas/InvoiceObjectCustomFields'
      title: invoices
    PutBatchInvoiceType:
      example:
        invoices:
          - id: 2c93808457d787030157e031d86c4c57
            invoiceDate: '2017-12-16'
          - id: 2c92c8955bd63cc1015bd7c151af02ab
            invoiceDate: '2017-12-16'
      properties:
        invoices:
          description: |
            Container for invoice update details.
          items:
            $ref: '#/components/schemas/BatchInvoiceType'
          type: array
      type: object
    ContactCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Contact object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.

            
            
      type: object
    PostCreateInvoiceContactType:
      allOf:
        - properties:
            address1:
              description: |
                First address line, 255 characters or less.
              maxLength: 255
              type: string
            address2:
              description: |
                Second address line, 255 characters or less.
              type: string
            city:
              description: |
                City, 40 characters or less.
              maxLength: 40
              type: string
            country:
              description: >
                Country; must be a valid country name or abbreviation. If using
                Zuora Tax, you must specify a country in the ship-to or sold-to
                contact to calculate tax. A bill-to contact may be used if no
                ship-to or sold-to contact is provided.
              type: string
            county:
              description: >
                County; 32 characters or less. May optionally be used by Zuora
                Tax to calculate county tax.
              maxLength: 32
              type: string
            fax:
              description: |
                Fax phone number, 40 characters or less.
              maxLength: 40
              type: string
            firstName:
              description: |
                First name, 100 characters or less.
              maxLength: 100
              type: string
            homePhone:
              description: |
                Home phone number, 40 characters or less.
              maxLength: 40
              type: string
            lastName:
              description: |
                Last name, 100 characters or less.
              maxLength: 100
              type: string
            mobilePhone:
              description: |
                Mobile phone number, 40 characters or less.
              maxLength: 40
              type: string
            nickname:
              description: |
                Nickname for this contact
              type: string
            otherPhone:
              description: |
                Other phone number, 40 characters or less.
              maxLength: 40
              type: string
            otherPhoneType:
              description: |
                Possible values are: `Work`, `Mobile`, `Home`, `Other`.
              type: string
            personalEmail:
              description: |
                Personal email address.
              maxLength: 80
              type: string
              format: email
            state:
              description: >
                State; must be a valid subregion (state or province) name or
                code.

                For more information, see <a

                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"

                target="_blank">View subregions of a specific country or
                region</a>.

                If using Zuora Tax, be aware that Zuora Tax requires a

                state (in the US) or province (in Canada) in this field for the

                ship-to or sold-to contact to calculate tax, and that a bill-to
                contact may be

                used if no ship-to or sold-to contact is provided.
              type: string
            taxRegion:
              description: >
                If using Zuora Tax, a region string as optionally defined in
                your tax rules. Not required.
              type: string
            workEmail:
              description: |
                Work email address, 80 characters or less.
              maxLength: 80
              type: string
            workPhone:
              description: |
                Work phone number, 40 characters or less.
              maxLength: 40
              type: string
            zipCode:
              description: |
                Zip code, 20 characters or less.
              maxLength: 20
              type: string
          required:
            - firstName
            - lastName
          type: object
        - $ref: '#/components/schemas/ContactCustomFields'
      description: >
        Container for bill-to, sold-to, or ship-to contact information. A new
        Contact will be created under the invoice owner account.
                    
        **Note**: If you have the <a
        href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
        target="_blank">Flexible Billing Attributes</a> feature disabled, this
        field is unavailable in the request body.
      title: Contact
    InvoiceWithCustomRatesType:
      allOf:
        - properties:
            currency:
              description: >
                The currency code for either Reporting or Home currency.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or later.
              type: string
            customFxRate:
              description: >
                The Custom FX conversion rate between Home/Reporting and
                Transactional currency items.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or later.
              format: decimal
              type: number
            rateDate:
              description: >
                The date on which a particular currency rate is fixed or
                obtained on.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or later.
              format: date
              type: string
          required:
            - currency
            - customFxRate
          type: object
      title: customRates
    TaxationItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Taxation Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Taxation Item object.
      title: taxationItemFieldsCustom
      type: object
    PostTaxationItemType:
      allOf:
        - properties:
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: number
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            name:
              description: |
                The name of taxation.
              type: string
            taxAmount:
              description: |
                The amount of the taxation item in the invoice item.
              format: number
              type: string
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific invoice item.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: >
                The date that the tax is applied to the invoice item, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            taxMode:
              description: >
                The tax mode of the invoice item, indicating whether the amount
                of the invoice item includes tax.
              enum:
                - TaxInclusive
                - TaxExclusive
              type: string
            taxRate:
              description: |
                The tax rate applied to the invoice item.
              format: number
              type: string
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the invoice item.
              enum:
                - Percentage
                - FlatFee
              type: string
          required:
            - name
            - taxAmount
            - taxDate
            - taxMode
            - taxRate
            - taxRateType
          title: taxItems
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
    PostDiscountItemType:
      allOf:
        - properties:
            accountingCode:
              description: |
                The accounting code associated with the discount item.
              type: string
            accountsReceivableAccountingCode:
              description: |
                The accounting code for accounts receivable.
              type: string
            adjustmentLiabilityAccountingCode:
              description: >
                The accounting code for adjustment liability.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            adjustmentRevenueAccountingCode:
              description: >
                The accounting code for adjustment revenue.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            amount:
              description: >
                The amount of the discount item.

                - Should be a negative number. For example, `-10`.

                - Always a fixed amount no matter whether the discount charge
                associated with the discount item uses the [fixed-amount model
                or percentage
                model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model).

                - For tax-exclusive discount items, this amount indicates the
                discount item amount excluding tax.

                - For tax-inclusive discount items, this amount indicates the
                discount item amount including tax.
              type: number
            bookingReference:
              description: |
                The booking reference of the discount item.
              type: string
            chargeDate:
              description: >
                The date when the discount item is charged, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            chargeName:
              description: >
                The name of the charge associated with the discount item.

                This field is required if the `productRatePlanChargeId` field is
                not specified in the request body.
              type: string
            contractAssetAccountingCode:
              description: >
                The accounting code for contract asset.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            contractLiabilityAccountingCode:
              description: >
                The accounting code for contract liability.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            contractRecognizedRevenueAccountingCode:
              description: >
                The accounting code for contract recognized revenue.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for the deferred revenue, such as Monthly
                Recurring Liability.

                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            description:
              description: |
                The description of the discount item.
              type: string
            itemType:
              description: |
                The type of the discount item.
              type: string
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the discount item is
                created from.


                If you specify a value for the `productRatePlanChargeId` field
                in the request, Zuora directly copies the values of the
                following fields from the corresponding product rate plan
                charge, regardless of the values specified in the request body:

                - `chargeName`

                - `sku`


                If you specify a value for the `productRatePlanChargeId` field
                in the request, Zuora directly copies the values of the
                following fields from the corresponding discount charge that
                [uses discount specific accounting codes, rule and segment to
                manage
                revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue),
                regardless of the values specified in the request body:

                - `accountingCode`

                - `deferredRevenueAccountingCode`

                - `recognizedRevenueAccountingCode`


                If you specify a value for the `productRatePlanChargeId` field
                in the request, Zuora directly copies the values of the
                following fields from the corresponding invoice item charge if
                the discount charge DOES NOT [use discount specific accounting
                codes, rule and segment to manage
                revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue),
                regardless of the values specified in the request body:

                - `accountingCode`

                - `deferredRevenueAccountingCode`

                - `recognizedRevenueAccountingCode`
              type: string
            purchaseOrderNumber:
              description: |
                The purchase order number associated with the discount item.
              type: string
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for the recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.

                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            revRecCode:
              description: |
                The revenue recognition code.
              type: string
            revRecTriggerCondition:
              description: |
                The date when revenue recognition is triggered.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
              type: string
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.

                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            sku:
              description: >
                The SKU of the invoice item. The SKU of the discount item must
                be different from the SKU of any existing product.
              type: string
            taxItems:
              description: >
                Container for taxation items. The maximum number of taxation
                items is 5.


                **Note**: This field is only available only if you have Taxation
                enabled.
              items:
                $ref: '#/components/schemas/PostTaxationItemType'
              type: array
            unbilledReceivablesAccountingCode:
              description: >
                The accounting code for unbilled receivables.

                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: string
            unitPrice:
              description: >
                The per-unit price of the discount item.

                If the discount charge associated with the discount item uses
                the percentage model, the unit price will display as a
                percentage amount in PDF. For example: if unit price is 5.00, it
                will display as 5.00% in PDF.
              type: number
          required:
            - amount
          title: invoiceItems
          type: object
        - $ref: '#/components/schemas/DiscountItemObjectNSFields'
        - $ref: '#/components/schemas/DiscountItemObjectCustomFields'
    PostInvoiceItemType:
      allOf:
        - properties:
            accountingCode:
              description: |
                The accounting code associated with the invoice item.
              type: string
            adjustmentLiabilityAccountingCode:
              description: >
                The accounting code for adjustment liability. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            adjustmentRevenueAccountingCode:
              description: >
                The accounting code for adjustment revenue. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            amount:
              description: >
                The amount of the invoice item. 


                - For tax-inclusive invoice items, the amount indicates the
                invoice item amount including tax. 

                - For tax-exclusive invoice items, the amount indicates the
                invoice item amount excluding tax.
              type: number
            bookingReference:
              description: |
                The booking reference of the invoice item.
              type: string
            chargeDate:
              description: >
                The date when the invoice item is charged, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            chargeName:
              description: >
                The name of the charge associated with the invoice item. 


                This field is required if the `productRatePlanChargeId` field is
                not specified in the request.
              type: string
            contractAssetAccountingCode:
              description: >
                The accounting code for contract asset. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            contractLiabilityAccountingCode:
              description: >
                The accounting code for contract liability. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            contractRecognizedRevenueAccountingCode:
              description: >
                The accounting code for contract recognized revenue. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            deferredRevenueAccountingCode:
              description: >
                The accounting code for the deferred revenue, such as Monthly
                Recurring Liability.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            description:
              description: |
                The description of the invoice item.
              type: string
            discountItems:
              description: >
                Container for discount items. The maximum number of discount
                items is 10.
              items:
                $ref: '#/components/schemas/PostDiscountItemType'
              type: array
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the invoice item from revenue accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: boolean
            itemType:
              description: |
                The type of the invoice item.
              type: string
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the invoice item is
                created from.


                You must have the **Create Standalone Invoice With Product
                Catalog** permission to create an invoice item from an existing
                charge.


                If you specify a value for the `productRatePlanChargeId` field
                in the request, Zuora directly copies the values of the
                following fields from the corresponding product rate plan
                charge, regardless of the values specified in the request body:

                - `chargeName`

                - `sku`

                - `uom`

                - `taxCode`

                - `taxMode`

                - `accountingCode`

                - `deferredRevenueAccountingCode` 

                - `recognizedRevenueAccountingCode`
              type: string
            purchaseOrderNumber:
              description: |
                The purchase order number associated with the invoice item.
              type: string
            quantity:
              default: 1
              description: |
                The number of units for the invoice item.
              type: number
            recognizedRevenueAccountingCode:
              description: >
                The accounting code for the recognized revenue, such as Monthly
                Recurring Charges or Overage Charges.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            revRecCode:
              description: |
                The revenue recognition code.
              type: string
            revRecTriggerCondition:
              description: |
                The date when revenue recognition is triggered.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
              type: string
            revenueRecognitionRuleName:
              description: >
                The name of the revenue recognition rule governing the revenue
                schedule.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            serviceEndDate:
              description: |
                The service end date of the invoice item.
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the invoice item.
              format: date
              type: string
            sku:
              description: >
                The SKU of the invoice item. The SKU of the invoice item must be
                different from the SKU of any existing product.
              type: string
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to the invoice item.


                **Note**: This field is only available only if you have Taxation
                enabled.
              type: string
            taxItems:
              description: >
                Container for taxation items. The maximum number of taxation
                items is 5.


                **Note**: This field is only available only if you have Taxation
                enabled.
              items:
                $ref: '#/components/schemas/PostTaxationItemType'
              type: array
            taxMode:
              description: >
                The tax mode of the invoice item, indicating whether the amount
                of the invoice item includes tax.


                **Note**: This field is only available only if you have Taxation
                enabled.
              enum:
                - TaxInclusive
                - TaxExclusive
              type: string
            unbilledReceivablesAccountingCode:
              description: >
                The accounting code for unbilled receivables. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            unitPrice:
              description: >
                The per-unit price of the invoice item. To pass Level 3 data to
                the gateway, this field is required and must be greater than
                zero.
              type: number
            uom:
              description: |
                The unit of measure.
              type: string
          required:
            - amount
            - serviceStartDate
          title: invoiceItems
          type: object
        - $ref: '#/components/schemas/InvoiceItemObjectNSFields'
        - $ref: '#/components/schemas/InvoiceItemObjectCustomFields'
    PostInvoiceType:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with the invoice. 


                You must specify either `accountNumber` or `accountId` for a
                customer account. If both of them are specified, they must refer
                to the same customer account.
              type: string
            accountNumber:
              description: >
                The Number of the account associated with the invoice.

                You must specify either `accountNumber` or `accountId` for a
                customer account. If both of them are specified, they must refer
                to the same customer account.
              type: string
            autoPay:
              default: false
              description: >
                Whether invoices are automatically picked up for processing in
                the corresponding payment run.
              type: boolean
            billToContact:
              $ref: '#/components/schemas/PostCreateInvoiceContactType'
            billToContactId:
              description: >
                The ID of the bill-to contact associated with the invoice. This
                field is mutually exclusive with the `billToContact` field.


                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: string
            comments:
              description: |
                Comments about the invoice.
              type: string
            currency:
              description: >
                The code of a currency as defined in Billing Settings through
                the Zuora UI.


                If you do not specify a currency during standalone invoice
                creation, the default account currency is applied. The currency
                that you specify in the request must be configured and activated
                in Billing Settings.

                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currencies</a> feature enabled.
              type: string
            customRates:
              description: >
                It contains Home currency and Reporting currency custom rates
                currencies. The maximum number of items is 2 (you can pass the
                Home currency item or Reporting currency item or both).
                      
                **Note**:
                  
                - This field is available only if you are on the latest Zuora
                API minor version, or you set the `Zuora-Version` request header
                to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).

                - You cannot set the custom rates, if both the **Automatically
                include additional Currency Conversion information in data
                source exports** option and **Fx data** feature are enabled.

                - Invoice, InvoiceItem, and TaxationItem will utilize the
                provided custom Fx rate to convert amounts from the
                transactional currency to the home currency.
              items:
                $ref: '#/components/schemas/InvoiceWithCustomRatesType'
              maxItems: 2
              type: array
            dueDate:
              description: >
                The date by which the payment for this invoice is due, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            invoiceDate:
              description: >
                The date that appears on the invoice being created, in
                `yyyy-mm-dd` format. The value cannot fall in a closed
                accounting period.
              format: date
              type: string
            invoiceItems:
              description: >
                Container for invoice items. The maximum number of invoice items
                is 1,000.


                You must have corresponding billing permissions to create
                invoice items from existing product rate plan charges or new
                charges. For more information about billing permissions, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Platform/System_Management/Administrator_Settings/User_Roles/d_Billing_Roles"
                target="_blank">Billing Roles</a>.

                - To create an invoice item from an existing charge, you must
                have the **Create Standalone Invoice With Product Catalog**
                permission and specify the charge ID in the
                `productRatePlanChargeId` field.

                - To create an invoice item from a new charge, you must have the
                **Create Standalone Invoice Without Product Catalog** permission
                without specifying the `productRatePlanChargeId` field.


                **Note**: For the "Create a standalone invoice" and "Create
                standalone invoices" operations, note the following:
                  - If tax has been calculated by an external tax engine, you need to create a standalone invoice with both `invoiceItems` and `taxItems`. The `taxItems` corresponds to the tax information processed by this external tax engine. In this case, you should not specify the `taxMode` and `taxCode` nested fields of the `invoiceItems` field. Instead, you need to specify the `taxMode` and `taxCode` nested fields of the `taxItems` field. You need to specify the `taxMode` field as `TaxExclusive`.
                  - If tax has not been calculated by an external tax engine, you can create a standalone invoice only with `invoiceItems`, and decide whether Zuora includes the tax in the quoted charge price and invoice item by specifying the `taxMode` nested field of the `invoiceItems` field as either `TaxExclusive` or `TaxInclusive`. Meanwhile, you need to specify the `taxCode` field, indicating the charge price and invoice item are taxable.
              items:
                $ref: '#/components/schemas/PostInvoiceItemType'
              type: array
            invoiceNumber:
              description: >
                A customized invoice number with the following format
                requirements:

                - Max length: 32 characters

                - Acceptable characters: a-z,A-Z,0-9,-,_,


                Purely numerical prefixes or prefixes ending with a number are
                supported for standalone invoices. For example, you can use
                `202310000300`, `2003`, `INV202310000300`, or
                `2023-09-100009785` as invoice numbers.


                The value must be unique in the system, otherwise it may cause
                issues with bill runs and subscribe/amend. Check out [things to
                note and troubleshooting
                steps](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Unified_Invoicing/Import_external_invoices_as_standalone_invoices?#Customizing_invoice_number). 
              type: string
            paymentTerm:
              description: >
                The ID or name of the payment term associated with the invoice.
                For example, `Net 30`. The payment term determines the due dates
                of invoices.


                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: string
            sequenceSet:
              description: >
                The ID or name of the sequence set associated with the invoice.


                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: string
            shipToContact:
              $ref: '#/components/schemas/PostCreateInvoiceContactType'
            shipToContactId:
              description: >
                The ID of the ship-to contact associated with the invoice. This
                field is mutually exclusive with the `shipToContact` field.

                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: string
            shipToSameAsBillTo:
              default: false
              description: >
                Whether the ship-to contact and bill-to contact are the same
                entity. This field is mutually exclusive with the
                `shipToContact` and `shipToContactId` fields.


                The created invoice has the same bill-to contact and ship-to
                contact entity only when all the following conditions are met in
                the request body:


                - This field is set to `true`. 

                - A bill-to contact or bill-to contact ID is specified.

                - Neither ship-to contact nor ship-to contact ID is specified.


                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: boolean
            soldToContact:
              $ref: '#/components/schemas/PostCreateInvoiceContactType'
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the invoice. This
                field is mutually exclusive with the `soldToContact` field.


                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: string
            soldToSameAsBillTo:
              default: false
              description: >
                Whether the sold-to contact and bill-to contact are the same
                entity. This field is mutually exclusive with the
                `soldToContact` and `soldToContactId` fields.


                The created invoice has the same bill-to contact and sold-to
                contact entity only when all the following conditions are met in
                the request body:


                - This field is set to `true`. 

                - A bill-to contact or bill-to contact ID is specified.

                - Neither sold-to contact nor sold-to contact ID is specified.


                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: boolean
            status:
              default: Draft
              description: >
                The status of invoice. By default, the invoice status is Draft.


                When creating an invoice, if you set this field to `Posted`, the
                invoice is created and posted directly.
              enum:
                - Draft
                - Posted
              type: string
            templateId:
              description: >
                The ID of the invoice template associated with the invoice.


                **Note**: If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled, this field is unavailable in the request body.
              type: string
            transferredToAccounting:
              enum:
                - Processing
                - Error
                - Ignore
                - 'Yes'
                - 'No'
              type: string
          required:
            - invoiceDate
          title: invoices
          type: object
        - $ref: '#/components/schemas/InvoiceObjectNSFields'
        - $ref: '#/components/schemas/InvoiceObjectCustomFields'
      example:
        accountId: 8ad09be48db5aba7018db604776d4854
        invoiceDate: '2024-07-30'
        invoiceItems:
          - amount: 100
            serviceStartDate: '2024-07-11'
            productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
    PostInvoiceResponse:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account associated with the invoice.
              type: string
            adjustmentAmount:
              description: >
                The amount of the invoice adjustments associated with the
                invoice.
              type: number
            amount:
              description: |
                The total amount of the invoice.
              type: number
            amountWithoutTax:
              description: |
                The invoice amount excluding tax.
              type: number
            autoPay:
              description: >
                Whether invoices are automatically picked up for processing in
                the corresponding payment run.
              type: boolean
            balance:
              description: >
                The remaining balance of the invoice after all payments,
                adjustments, and refunds are applied.
              type: number
            billRunId:
              description: |
                The id of bill run if the invoice is generated by a bill run.
              type: string
            billToContactId:
              description: |
                The ID of the bill-to contact associated with the invoice.
              type: string
              nullable: true
            billToContactSnapshotId:
              description: >
                The ID of the bill-to contact snapshot associated with the
                invoice.
              type: string
            comments:
              description: |
                Comments about the invoice.
              type: string
            createdById:
              description: >
                The user ID of the person who created the invoice. If a bill run
                generated the invoice, then the value is the user ID of person
                who created the bill run.
              type: string
            createdDate:
              description: >
                The date and time when the invoice was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditBalanceAdjustmentAmount:
              description: >
                The currency amount of the adjustment applied to the customer's
                credit balance.

                 **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.
              type: number
            creditMemoAmount:
              description: >
                The currency amount of all credit memos applied to this invoice.


                **Note:** This field is only available if you have [Invoice
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
                enabled. The Invoice Settlement feature is generally available
                as of Zuora Billing Release 296 (March 2021). This feature
                includes Unapplied Payments, Credit and Debit Memo, and Invoice
                Item Settlement. If you want to enable Invoice Settlement, see
                [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.
              type: number
            currency:
              description: >
                The currency of the invoice.


                **Note:** By default, the currency on a billing document matches
                the default currency set on the associated account. 

                However, Zuora now offers a Multiple Currencies feature to
                support different currencies for billing documents, allowing
                flexibility beyond the account-level currency. 

                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currency</a>.
              nullable: true
              type: string
            discount:
              description: |
                the invoice discount amount.
              type: number
            dueDate:
              description: >
                The date by which the payment for this invoice is due, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            einvoiceErrorCode:
              description: >
                The error code when status is "Failed". This code can either be
                a Zuora-generated error code or one returned by a third-party
                e-invoice vendor.
              type: string
            einvoiceErrorMessage:
              description: >
                The error message when status is "Failed". This message can
                either be a Zuora-generated error code or one returned by a
                third-party e-invoice vendor.
              type: string
            einvoiceFileId:
              description: |
                The ID of the e-invoice file.
              type: string
            einvoiceStatus:
              description: >
                The status of the e-invoice file generation for the invoice.


                - If e-invoicing file generation succeeds, this field is either
                `Generated` or `Success`, and both the error code and message
                are empty, and the `eInvoiceField` fieldstores the ID of the
                generated e-inoice file.

                - If the responses from tax vendors such as Sovos or Avalara are
                taking too long, this field becomes `RetrieveTimeOut`. Once the
                vendor responds successfully, you can use the 'Resync E-Invoice
                Status' action to update the status automatically.  You can view
                these updates in System Health telemetry.

                - If a failure occurs during e-invoice file generation, this
                field is `Failed` and error code and an error message are
                returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields.

                - If e-invoice file generation conditionally succeeds, this
                field is `ConditionalSuccess` and an error code and an error
                message are returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields.

                - If the e-invoice file has been approved by the tax authority,
                this field is `ApprovedByAuthority`. The next status will be
                either `Success` or `Rejected`.

                - If the e-invoice file has been rejected by the government,
                this field is `Rejected`. You cannot resend this e-invoice; you
                must create a new invoice instead.

                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              enum:
                - Processing
                - RetrieveTimeOut
                - Generated
                - Success
                - Failed
                - ConditionalSuccess
                - ApprovedByAuthority
                - Rejected
              type: string
            id:
              description: |
                The unique ID of the invoice.
              type: string
            includesOneTime:
              description: |
                Specifies whether the invoice includes one-time charges.
              type: boolean
            includesRecurring:
              description: |
                Specifies whether the invoice includes recurring charges.
              type: boolean
            includesUsage:
              description: |
                Specifies whether the invoice includes usage charges.
              type: boolean
            invoiceDate:
              description: |
                The date that appears on the invoice being created.
              format: date
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the invoice. 


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            invoiceNumber:
              description: |
                The unique identification number of the invoice.
              type: string
            lastEmailSentDate:
              description: |
                The date when the invoice was last emailed.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentAmount:
              description: |
                The amount of payments applied to the invoice.
              type: number
            paymentTerm:
              description: |
                The name of payment term associated with the invoice.
              type: string
              nullable: true
            postedBy:
              description: >
                The user ID of the person who moved the invoice to Posted
                status.
              type: string
            postedDate:
              description: |
                The date when the invoice was posted.
              format: date
              type: string
            refundAmount:
              description: >
                Specifies the amount of a refund that was applied against an
                earlier payment on the invoice.
              type: number
            sequenceSetId:
              description: |
                The ID of the sequence set associated with the invoice.
              type: string
              nullable: true
            communicationProfileId:
              description: |
                The ID of the communication profile associated with the invoice.
              type: string
              nullable: true
            shipToContactId:
              description: |
                The ID of the ship-to contact associated with the invoice.
              type: string
              nullable: true
            shipToContactSnapshotId:
              description: >
                The ID of the ship-to contact snapshot associated with the
                invoice.
              type: string
            soldToContactId:
              description: |
                The ID of the sold-to contact associated with the invoice.
              type: string
              nullable: true
            soldToContactSnapshotId:
              description: >
                The ID of the sold-to contact snapshot associated with the
                invoice.
              type: string
            source:
              description: |
                The source of the invoice.
              enum:
                - BillRun
                - API
                - ApiSubscribe
                - ApiAmend
              type: string
            sourceId:
              description: >
                The ID of the invoice source.

                If an invoice is generated from a bill run, the value is the
                number of the corresponding bill run.Otherwise, the value is
                `null`.
              type: string
            sourceType:
              description: |
                The type of the invoice source.
              enum:
                - Subscription
                - Standalone
                - Order
                - Consolidation
              type: string
            status:
              description: |
                The status of the invoice.
              enum:
                - Draft
                - Posted
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            targetDate:
              description: >
                This date is used to determine which charges are to be billed.
                All charges that are to be billed on this date or prior will be
                included in this bill run.
              format: date
              type: string
            taxAmount:
              description: |
                The amount of taxation.
              type: number
            taxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              type: number
            taxMessage:
              description: >
                The message that the tax engine return if it calculates the
                taxes of this invoice fails.
              type: string
              nullable: true
            taxStatus:
              description: >
                The status that the tax engine return after it calculates the
                taxes of this invoice. 


                **Note:** This field is only applicable to tax calculation by
                third-party tax engines. The `Voided` status indicates that the
                tax transaction is successfully canceled on the tax vendor's
                side. If a tax transaction was successfully committed to the
                third-party tax engine but the invoice failed to post, Zuora
                automatically detects the issue and voids the tax transaction on
                the vendor's side.
              enum:
                - Complete
                - Error
                - UnknownError
                - DuplicateDoc
                - InvalidRequest
                - InvalidResponse
                - TaxEngineError
                - ConcurrentModify
                - InternalServerError
                - TaxCodeTemplateError
                - Voided
              type: string
            templateId:
              description: >
                The ID of the invoice template.


                - If you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> feature enabled,
                the value of this field depends on the configuration of the
                invoice template. 
                  - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.
                  - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.
                - If you have the Flexible Billing Attributes feature disabled,
                the value of this field is `null`.
              type: string
              nullable: true
            transferredToAccounting:
              description: >
                Whether the invoice was transferred to an external accounting
                system.
              enum:
                - Processing
                - Error
                - Ignore
                - 'Yes'
                - 'No'
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the invoice.
              type: string
            updatedDate:
              description: |
                The date when the invoice was last updated.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceObjectNSFields'
        - $ref: '#/components/schemas/InvoiceObjectCustomFields'
    PostBatchInvoicesType:
      example:
        invoices:
          - accountId: ff8080817cda56fa017cda87aaa2071e
            autoPay: false
            comments: comments
            currency: EUR
            invoiceDate: '2020-02-01'
            invoiceItems:
              - amount: 100
                bookingReference: bookingReference
                chargeDate: '2020-02-01 00:00:00'
                description: description
                discountItems:
                  - amount: -10
                    bookingReference: discountBookingReference
                    chargeDate: '2020-02-01 11:00:00'
                    chargeName: discount
                    description: description
                    sku: SKU-0002
                    taxItems:
                      - exemptAmount: 0
                        jurisdiction: jurisdiction
                        locationCode: locationCode
                        name: country tax
                        taxAmount: -1
                        taxCode: country tax code
                        taxCodeDescription: country tax code, tax rate 10%
                        taxDate: '2021-02-08'
                        taxMode: TaxExclusive
                        taxRate: 0.1
                        taxRateDescription: country tax
                        taxRateType: Percentage
                productRatePlanChargeId: ff8080817cda56fa017cda87999d071b
                purchaseOrderNumber: PO-000303
                quantity: 1
                serviceEndDate: '2020-02-10'
                serviceStartDate: '2020-02-01'
                taxItems:
                  - exemptAmount: 0
                    jurisdiction: juristiction
                    locationCode: locationCode
                    name: country tax
                    taxAmount: 10
                    taxCode: tax code
                    taxCodeDescription: tax code description
                    taxDate: '2020-02-01'
                    taxMode: TaxExclusive
                    taxRate: 0.01
                    taxRateDescription: tax rate description
                    taxRateType: Percentage
              - amount: 100
                bookingReference: bookingReference
                chargeDate: '2020-02-01 00:00:00'
                chargeName: charge name
                description: description
                purchaseOrderNumber: PO-000303
                quantity: 1
                serviceEndDate: '2020-02-10'
                serviceStartDate: '2020-02-01'
                sku: sku-001
                uom: each
          - accountId: ff8080817cda56fa017cda87aaa2071e
            autoPay: false
            comments: comments
            currency: EUR
            invoiceDate: '2020-02-01'
            invoiceItems:
              - amount: 100
                bookingReference: bookingReference
                chargeDate: '2020-02-01 00:00:00'
                description: description
                productRatePlanChargeId: ff8080817cda56fa017cda87999d071b
                purchaseOrderNumber: PO-000303
                quantity: 1
                serviceEndDate: '2020-02-10'
                serviceStartDate: '2020-02-01'
                taxItems:
                  - exemptAmount: 0
                    jurisdiction: juristiction
                    locationCode: locationCode
                    name: country tax
                    taxAmount: 10
                    taxCode: tax code
                    taxCodeDescription: tax code description
                    taxDate: '2020-02-01'
                    taxMode: TaxExclusive
                    taxRate: 0.01
                    taxRateDescription: tax rate description
                    taxRateType: Percentage
              - amount: 100
                bookingReference: bookingReference
                chargeDate: '2020-02-01 00:00:00'
                chargeName: charge name
                description: description
                purchaseOrderNumber: PO-000303
                quantity: 1
                serviceEndDate: '2020-02-10'
                serviceStartDate: '2020-02-01'
                sku: sku-001
                uom: each
        useSingleTransaction: false
      properties:
        invoices:
          description: |
            Container for standalone invoices.
          items:
            $ref: '#/components/schemas/PostInvoiceType'
          type: array
        useSingleTransaction:
          description: >
            Whether a batch request is handled with a single transaction.


            - `true` indicates that a batch request will be handled with a
            single transaction.

            - `false`  indicates that the standalone invoices to be created in a
            batch request will be handled with separated transactions.


            If the field is set to `false`, a failure in the batch request will
            not cause the whole request to fail, so you have to retry the whole
            batch request.
          type: boolean
      type: object
    PostBatchInvoiceItemResponse:
      allOf:
        - properties:
            success:
              description: |
                Indicates whether the invoice is created successfully.
              type: boolean
          type: object
        - $ref: '#/components/schemas/PostInvoiceResponse'
    PostBatchInvoiceResponse:
      properties:
        invoices:
          items:
            $ref: '#/components/schemas/PostBatchInvoiceItemResponse'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    InvoicePostType:
      allOf:
        - properties:
            id:
              description: |
                The ID of the invoice to be posted.
              type: string
            invoiceDate:
              description: >
                The date that appears on the invoice being created, in
                `yyyy-mm-dd` format. The value cannot fall in a closed
                accounting period.
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceObjectCustomFields'
    POSTInvoicesBatchPostType:
      allOf:
        - properties:
            invoices:
              description: >
                The container for invoices to be posted. The maximum number of
                invoices to be posted is 50 in one request.
              items:
                $ref: '#/components/schemas/InvoicePostType'
              title: invoices
              type: array
          type: object
      example:
        invoices:
          - complexity__c: Middle
            description__c: description
            id: 402890555a7e9791015a7f15fe440123
            invoiceDate: '2022-10-12'
          - complexity__c: Middle
            description__c: description
            id: 402890555a7e9791015a7f15fe44013a
            invoiceDate: '2022-10-12'
          - complexity__c: Middle
            description__c: description
            id: 402890555a7e9791015a7f15fe44012b
            invoiceDate: '2022-10-12'
    InvoicePostResponseType:
      allOf:
        - properties:
            id:
              description: |
                The ID of the invoice that was posted.
              type: string
            success:
              description: |
                Returns `true` if the invoice was posted successfully.
              type: boolean
          type: object
    InvoicesBatchPostResponseType:
      allOf:
        - properties:
            invoices:
              description: |
                The container for a list of posted invoices.
              items:
                $ref: '#/components/schemas/InvoicePostResponseType'
              title: invoices
              type: array
            success:
              description: >
                Returns `true` if the request has one of invoices was posted
                successfully.
              type: boolean
          type: object
    GetInvoicePdfStatusResponse:
      allOf:
        - properties:
            invoiceId:
              description: |
                The ID of the invoice whose pdf status is requested.
              type: string
            invoiceNumber:
              description: |
                The invoice number of the invoice whose pdf status is requested.
              type: string
            pdfGenerationStatus:
              description: >
                The generation status of the invoice PDF. 

                - **Obsolete**: The status changes to `Obsolete` when additional
                updates are applied to the document, for example, payment
                applied or custom fields updated.  

                - **Archived**: The status changes to `Archived` from
                `Generated` when the PDF file is archived. The file cannot be
                used directly until it is restored. For restoring, refer to the
                <a
                href="https://developer.zuora.com/v1-api-reference/api/operation/PUT_Files/"
                target="_blank">Restore a file</a> operation.  
              enum:
                - None
                - Pending
                - Processing
                - Generated
                - Error
                - Obsolete
                - Archived
              type: string
            createdOn:
              description: |
                The time at which the request to generate the PDF was created.
              type: string
            updatedOn:
              description: |
                The time at which the request to generate the PDF was updated.
              type: string
            pdfFileURL:
              description: >
                The file path or the URL of the PDF when the status is
                `Generated`.  
              type: string
            errorCategory:
              description: |
                The error category when the status is `Error`. 
              type: string
            errorMessage:
              description: |
                The error message when the status is `Error`. 
              type: string
          type: object
    GetInvoicePdfStatusBatchResponse:
      description: ''
      example:
        invoiceFiles:
          - invoiceId: 402824aa8cc894d5018cc8a120576881
            invoiceNumber: INV00000003
            pdfGenerationStatus: Generated
            createdOn: '2024-01-01 11:35:56'
            updatedOn: '2024-01-01 11:35:56'
            pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
          - invoiceId: 2c98908a904dfc2601904e6e14090241
            invoiceNumber: INV00000004
            pdfGenerationStatus: Error
            createdOn: '2024-01-02 10:14:13'
            updatedOn: '2024-01-02 10:14:13'
            errorCode: INVALID_TEMPLATE
            errorMessage: Unknown merge filed chargeNumber__c
          - invoiceId: 402824aa8cc894d5018cc8a120576881
            invoiceNumber: INV00000005
            pdfGenerationStatus: Pending
            createdOn: '2024-01-01 11:35:56'
            updatedOn: '2024-01-01 11:35:56'
        success: true
      properties:
        invoiceFiles:
          description: |
            Array of invoice PDF statuses requested.
          items:
            $ref: '#/components/schemas/GetInvoicePdfStatusResponse'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
      title: invoiceFiles
    PutInvoiceType:
      allOf:
        - properties:
            autoPay:
              description: >
                Whether invoices are automatically picked up for processing in
                the corresponding payment run.

                By default, invoices are automatically picked up for processing
                in the corresponding payment run.
              type: boolean
            comments:
              description: >
                Additional information related to the invoice that a Zuora user
                added to the invoice.
              maxLength: 255
              type: string
            dueDate:
              description: |
                The date by which the payment for this invoice is due.
              format: date
              type: string
            invoiceDate:
              description: >
                The new invoice date of the invoice. The new invoice date cannot
                fall in a closed accounting period.

                You can only specify `invoiceDate` or `dueDate` in one request.
                Otherwise, an error occurs.
              format: date
              type: string
            invoiceItems:
              description: >
                Container for invoice items, The maximum number of items is
                1,000.
              items:
                $ref: '#/components/schemas/PutInvoiceItemType'
              type: array
            transferredToAccounting:
              description: >
                Whether the invoice was transferred to an external accounting
                system.
              enum:
                - Processing
                - 'Yes'
                - Error
                - Ignore
              type: string
            templateId:
              description: >
                The ID of the invoice template associated with the invoice.


                **Note**: This field is only available if you have the <a

                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes"

                target="_blank">Flexible Billing Attributes</a> feature enabled.
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceObjectNSFields'
        - $ref: '#/components/schemas/InvoiceObjectCustomFields'
      example:
        invoiceItems:
          - id: 8ad084db909fae930190a121c87f5800
            amount: 105
    PutInvoiceResponseType:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account associated with the invoice.
              type: string
            amount:
              description: |
                The total amount of the invoice.
              format: BigDecimal
              type: number
            autoPay:
              description: >
                Whether invoices are automatically picked up for processing in
                the corresponding payment run. 
              type: boolean
            balance:
              description: |
                The balance of the invoice.
              format: BigDecimal
              type: number
            cancelledById:
              description: |
                The ID of the Zuora user who cancelled the invoice.
              type: string
              nullable: true
            cancelledOn:
              description: >
                The date and time when the invoice was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the invoice. 
              type: string
            createdById:
              description: |
                The ID of the Zuora user who created the invoice.
              type: string
            createdDate:
              description: >
                The date and time when the invoice was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditBalanceAdjustmentAmount:
              description: >
                **Note:** This filed is only available if you have the Credit
                Balance feature enabled and the Invoice Settlement feature
                disabled.

                The currency amount of the adjustment applied to the customer's
                credit balance.
              format: BigDecimal
              type: number
            currency:
              description: |
                A currency defined in the web-based UI administrative settings.
              type: string
            discount:
              description: |
                The discount of the invoice.
              format: BigDecimal
              type: number
            dueDate:
              description: |
                The date by which the payment for this invoice is due. 
              format: date
              type: string
            id:
              description: |
                The unique ID of the invoice.
              type: string
            invoiceDate:
              description: |
                The date on which to generate the invoice.
              format: date
              type: string
            number:
              description: |
                The unique identification number of the invoice.
              type: string
            postedById:
              description: |
                The ID of the Zuora user who posted the invoice.
              type: string
            postedOn:
              description: >
                The date and time when the invoice was posted, in `yyyy-mm-dd
                hh:mm:ss` format. 
              format: date-time
              type: string
            status:
              description: |
                The status of the invoice.
              enum:
                - Draft
                - Posted
                - Canceled
                - Error
              type: string
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
            targetDate:
              description: >
                The target date for the invoice, in `yyyy-mm-dd` format. For
                example, 2017-07-20. 
              format: date
              type: string
            taxAmount:
              description: |
                The amount of taxation.
              format: BigDecimal
              type: number
            templateId:
              description: |
                The ID of the invoice template associated with the invoice.
              type: string
            totalTaxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: BigDecimal
              type: number
            transferredToAccounting:
              description: >
                Whether the invoice was transferred to an external accounting
                system.
              enum:
                - Processing
                - 'Yes'
                - Error
                - Ignore
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the invoice.
              type: string
            updatedDate:
              description: >
                The date and time when the invoice was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceObjectNSFields'
        - $ref: '#/components/schemas/InvoiceObjectCustomFields'
    DeleteInvoiceResponseType:
      properties:
        id:
          description: |
            The ID of the deleted invoice.
          type: string
        jobId:
          description: >
            The ID of the job that handles the invoice deletion operation. 


            You can specify the value of this field as the value of the `jobId`
            path parameter in the [Retrieve an operation
            job](https://developer.zuora.com/api-references/api/operation/GET_OperationJob/)
            API operation to query job information.
          type: string
        jobStatus:
          description: |
            The status of the invoice deletion operation. 
          enum:
            - Pending
            - Completed
          type: string
        reasons:
          items:
            properties:
              code:
                description: |
                  The error code of the response.
                type: string
              message:
                description: |
                  The detail information of the error response.
                type: string
            type: object
          type: array
        success:
          description: |
            Whether the call succeeded.
          type: boolean
      type: object
    GetInvoiceApplicationPartType:
      properties:
        appliedAmount:
          description: |
            The amount that is applied to the invoice.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the payment or credit memo.
          format: uuid
          type: string
        createdDate:
          description: >
            The date and time when the payment or credit memo was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-12-01 15:31:10.
          format: date-time
          type: string
        creditMemoId:
          description: |
            The ID of credit memo that is applied to the specified invoice.
          format: uuid
          type: string
        paymentId:
          description: |
            The ID of the payment that is applied to the specified invoice.
          format: uuid
          type: string
        updatedById:
          description: >
            The ID of the Zuora user who last updated the payment or credit
            memo.
          format: uuid
          type: string
        updatedDate:
          description: >
            The date and time when the payment or credit memo was last updated,
            in `yyyy-mm-dd hh:mm:ss` format. For example, 2018-01-02 11:42:16.
          format: date-time
          type: string
      title: applicationParts
      type: object
    GetInvoiceApplicationPartCollectionType:
      properties:
        applicationParts:
          description: |
            Container for application parts.
          items:
            $ref: '#/components/schemas/GetInvoiceApplicationPartType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    PostInvoiceEmailRequestType:
      example:
        useEmailTemplateSetting: true
      properties:
        emailAddresses:
          description: >
            The valid email addresses you want to email an invoice to. Use
            commas to separate email addresses.

            **Note:** This field is only applicable if you set the
            `useEmailTemplateSetting` field to `false`.
          type: string
        includeAdditionalEmailAddresses:
          default: false
          description: >
            Whether to send an invoice to the additional email addresses of the
            invoice account. 

            You can set the additional email addresses in the **Additional Email
            Addresses** field on the account detail page from the Zuora UI. See
            [Create a Customer
            Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2)
            for more information.
          enum:
            - true
            - false
          type: boolean
        useEmailTemplateSetting:
          default: false
          description: >
            Indicates whether to email an invoice based on the email template
            setting. 

            If you set this field to `true`, the invoice is sent to the email
            addresses specified in the **To Email** field of the email template.
            The email template is the one you set in the **Delivery Options**
            panel of the **Edit notification** dialog from the Zuora UI. See
            [Edit Email
            Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)
            for more information about how to edit the **To Email** field in the
            email template.
          enum:
            - true
            - false
          type: boolean
      type: object
    InvoiceFile:
      properties:
        id:
          description: >
            The ID of the invoice PDF file. This is the ID for the file object
            and different from the file handle ID in the `pdfFileUrl` field. To
            open a file, you have to use the file handle ID.
          type: string
        pdfFileUrl:
          description: >
            The relative URL of the invoice PDF file.


            You can obtain the absolute URL for downloading the file by adding a
            prefix in the following format: `{environment_base_url}/apps`


            For example,
            `https://apisandbox.zuora.com/apps/v1/files/2c98901f62d7d83d0162d7facea6262d`.
          type: string
        versionNumber:
          description: |
            The version number of the invoice PDF file.
          format: int64
          type: integer
      title: invoiceFiles
      type: object
    GETInvoiceFilesResponse:
      properties:
        invoiceFiles:
          description: |
            Container for invoice PDF files.
          items:
            $ref: '#/components/schemas/InvoiceFile'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTUploadFileResponse:
      properties:
        fileId:
          description: |
            The unique ID of the uploaded PDF file.
          type: string
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    GETInvoiceTaxItemType:
      allOf:
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
        - properties:
            availableToCreditAmount:
              description: >
                The amount of the invoice taxation item that is available to
                credit.
              format: decimal
              type: number
            applicableTaxUnRounded:
              description: |
                The unrounded amount of the tax. 
              type: number
            country:
              description: |
                The field which contains country code.
              type: string
            balance:
              description: |
                The balance of the taxation item.
              format: double
              type: number
            creditAmount:
              description: |
                The amount of credit memos applied to the taxation item. 
              format: double
              type: number
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            id:
              description: |
                The ID of the taxation item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            name:
              description: |
                The name of the taxation item.
              type: string
            paymentAmount:
              description: |
                The amount of payments applied to the taxation item. 
              format: double
              type: number
            taxAmount:
              description: |
                The amount of taxation.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific invoice.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: >
                The date that the tax is applied to the invoice, in `yyyy-mm-dd`
                format.
              format: date
              type: string
            taxRate:
              description: |
                The tax rate applied to the invoice.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate.
              enum:
                - Percentage
                - FlatFee
              type: string
          title: data
          type: object
      title: data
    InvoiceItem:
      allOf:
        - properties:
            accountingCode:
              description: The accounting code associated with the invoice item.
              type: string
            adjustmentLiabilityAccountingCode:
              description: >
                The accounting code for adjustment liability. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            adjustmentRevenueAccountingCode:
              description: >
                The accounting code for adjustment revenue. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            appliedToItemId:
              description: >-
                The unique ID of the invoice item that the discount charge is
                applied to.
              type: string
            availableToCreditAmount:
              description: >
                The amount of the invoice item that is available to
                credit.        
              format: decimal
              type: number
            balance:
              description: >
                The balance of the invoice item.


                **Note**: This field is only available if you have the Invoice
                Settlement feature enabled.
              format: decimal
              type: string
            bookingReference:
              description: |
                The booking reference of the invoice item.
              type: string
            chargeAmount:
              description: >
                The amount of the charge. 


                **Note**: This amount does not include taxes regardless if the
                charge's tax mode is inclusive or exclusive. This is the
                discount amount actually applied when the invoice item is a
                discount charge.
              format: decimal
              type: string
            chargeDate:
              description: >
                The date when the invoice item is charged, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            chargeDescription:
              description: The description of the charge.
              type: string
            chargeId:
              description: The unique ID of the charge.
              type: string
            chargeName:
              description: The name of the charge.
              type: string
            chargeType:
              description: |
                The type of the charge. 
              enum:
                - OneTime
                - Recurring
                - Usage
              type: string
            commitmentId:
              description: |
                The ID of the commitment.
              type: string
            commitmentPeriodId:
              description: |
                The ID of the commitment period.
              type: string
            contractAssetAccountingCode:
              description: >
                The accounting code for contract asset. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            contractLiabilityAccountingCode:
              description: >
                The accounting code for contract liability. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            contractRecognizedRevenueAccountingCode:
              description: >
                The accounting code for contract recognized revenue. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            deferredRevenueAccountingCode:
              description: >
                The deferred revenue accounting code associated with the invoice
                item.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            description:
              description: The description of the invoice item.
              type: string
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the invoice item from revenue accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: boolean
            fulfillmentId:
              description: >
                The reference ID of the fulfillment associated with the invoice
                item.
              type: string
            id:
              description: Item ID.
              type: string
            invoiceScheduleId:
              description: >
                The ID of the invoice schedule item by which Invoice Schedule
                Item the invoice item is generated by when the Invoice Schedule
                Item is executed.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: string
            invoiceScheduleItemId:
              description: >
                The ID of the invoice schedule item associated with the invoice
                item.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: string
            itemType:
              description: |
                The type of the invoice item.
              type: string
            numberOfDeliveries:
              description: >
                The number of deliveries dedicated to the Delivery Pricing
                charges.

                **Note**: This field is available only if you have the Delivery
                Pricing feature enabled.
              type: number
            orderLineItemId:
              description: >
                The reference ID of the oder line item associated with the
                invoice item.
              type: string
            processingType:
              description: |
                The kind of the charge for the invoice item. 
              enum:
                - Charge
                - Discount
                - Prepayment
                - Tax
                - Rounding
              type: string
            productName:
              description: Name of the product associated with this item.
              type: string
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the invoice item is
                created from.
              type: string
            purchaseOrderNumber:
              description: |
                The purchase order number associated with the invoice item.
              type: string
            quantity:
              description: >-
                The quantity of this item, in the configured unit of measure for
                the charge.
              format: decimal
              type: string
            reflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `reflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `reflectDiscountInNetAmount` field to `true`, you must also set
                both the `excludeItemBookingFromRevenueAccounting` and
                `ExcludeItemBillingFromRevenueAccounting` fields to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `reflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration does not support discounts on the preceding charges.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `reflectDiscountInNetAmount` field to
                `true`.  
            recognizedRevenueAccountingCode:
              description: >
                The recognized revenue accounting code associated with the
                invoice item.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            revRecCode:
              description: |
                The revenue recognition code.
              type: string
            revRecTriggerCondition:
              description: |
                The date when revenue recognition is triggered.
              enum:
                - ContractEffectiveDate
                - ServiceActivationDate
                - CustomerAcceptanceDate
              type: string
            revenueRecognitionRuleName:
              description: >
                The revenue recognition rule of the invoice item.


                **Note:** This field is only available if you have Zuora Finance
                enabled.
              type: string
            serviceEndDate:
              description: >-
                The end date of the service period for this item, i.e., the last
                day of the service period, as _yyyy-mm-dd_.
              format: date
              type: string
            serviceStartDate:
              description: >-
                The start date of the service period for this item, as
                _yyyy-mm-dd_. For a one-time fee item, the date of the charge.
              format: date
              type: string
            sku:
              description: |
                The SKU of the invoice item.
              type: string
            shipToContactId:
              description: |
                The ID of the ship-to contact associated with the invoice item.
              type: string
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the invoice item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            soldToContactSnapshotId:
              description: >
                The ID of the sold-to contact snapshot associated with the
                invoice item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            sourceItemType:
              description: |
                The type of the source item.
              enum:
                - SubscriptionComponent
                - Rounding
                - ProductRatePlanCharge
                - None
                - OrderLineItem
              type: string
            subscriptionId:
              description: The ID of the subscription for this item.
              type: string
            subscriptionName:
              description: The name of the subscription for this item.
              type: string
            taxAmount:
              description: Tax applied to the charge.
              format: decimal
              type: string
            taxCode:
              description: >
                The tax code of the invoice item.

                **Note** Only when taxation feature is enabled, this field can
                be presented.
              type: string
            taxMode:
              description: >
                The tax mode of the invoice item.

                **Note** Only when taxation feature is enabled, this field can
                be presented.
              type: string
            taxationItems:
              description: |
                Container for the taxation items of the invoice item. 
              properties:
                data:
                  description: |
                    List of taxation items.
                  items:
                    $ref: '#/components/schemas/GETInvoiceTaxItemType'
                  type: array
                nextPage:
                  description: >
                    URL to retrieve the next page of the response if it exists;
                    otherwise absent.
                  format: URL
                  type: string
              type: object
            unbilledReceivablesAccountingCode:
              description: >
                The accounting code for unbilled receivables. 
                      
                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: string
            unitOfMeasure:
              description: Unit used to measure consumption.
              type: string
            unitPrice:
              description: >
                The per-unit price of the invoice item.


                **Note**: For discount charges, this represents the discount
                percentage (for percentage-based discounts)  or the discount
                amount (for fixed-amount discounts).
              format: double
              type: number
          type: object
        - $ref: '#/components/schemas/InvoiceItemObjectNSFields'
        - $ref: '#/components/schemas/InvoiceItemObjectCustomFields'
      title: invoiceItems
    GETInvoiceItemsResponse:
      properties:
        invoiceItems:
          description: |
            Container for invoice items.
          items:
            $ref: '#/components/schemas/InvoiceItem'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETInvoiceTaxationItemsResponse:
      properties:
        data:
          description: |
            Container for the taxation items of the invoice item.
          items:
            $ref: '#/components/schemas/GETInvoiceTaxItemType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    PutReverseInvoiceType:
      example:
        applyEffectiveDate: '2017-02-20'
        memoDate: '2017-02-20'
      properties:
        applyEffectiveDate:
          description: >
            The date when the credit memo is applied to the invoice that will be
            reversed, in `yyyy-mm-dd` format. The effective date must be later
            than or equal to the memo date.


            The default value is the date when you reverse the invoice and
            create the credit memo.
          format: date
          type: string
        comment:
          description: >
            Comments about the reversal. The comment is used as the comment of
            the credit memo generated by reversing the specified invoice.
          maxLength: 255
          minLength: 0
          type: string
        memoDate:
          description: >
            The date when the credit memo was created, in `yyyy-mm-dd` format.
            The memo date must be later than or equal to the invoice date.


            The default value is the date when you reverse the invoice and
            create the credit memo.
          format: date
          type: string
        reasonCode:
          description: >
            A code identifying the reason for the reversal. The value must be an
            existing reason code or empty. The code is used as the reason code
            of the credit memo generated by reversing the specified invoice.


            If you do not specify a value, Zuora uses the default reason code
            `Invoice reversal` for the credit memo.
          type: string
      type: object
    PutReverseInvoiceResponseType:
      properties:
        creditMemo:
          description: >
            Container for the credit memo that is automatically generated when
            during the invoice reversal.
          properties:
            id:
              description: The ID of the credit memo.
              type: string
          type: object
        debitMemo:
          description: >
            Container for the debit memo that is automatically generated during
            the reversal of the credit memo related to this invoice. If no
            related credit memo is reversed, this field is not retruned in the
            response body.
          properties:
            id:
              description: The ID of the debit memo.
              type: string
          type: object
        id:
          type: string
          nullable: true
          description: >
            The ID of the invoice to be reserved.


            This field is available only when the reversal operation is
            performed asynchronously.
        jobId:
          type: string
          nullable: true
          description: >
            The ID of the job that handles the invoice reversal operation.


            You can specify the value of this field as the value of the `jobId`
            path parameter in the [Retrieve an operation
            job](https://developer.zuora.com/v1-api-reference/api/operation/GET_OperationJob/)
            API operation to query job information.


            This field is available only when the reversal operation is
            performed asynchronously.
        jobStatus:
          type: string
          nullable: true
          enum:
            - Pending
            - Processing
            - Failed
            - Completed
          description: >
            The status of the invoice reversal operation.


            This field is available only when the reversal operation is
            performed asynchronously.
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTTaxationItemTypeForInvoice:
      allOf:
        - properties:
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: number
              type: string
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                accountsReceivableAccountingCode:
                  description: |
                    The accounting code for accounts receivable.
                  maxLength: 100
                  minLength: 0
                  type: string
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            invoiceItemId:
              description: |
                The ID of the invoice associated with the taxation item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            name:
              description: |
                The name of taxation.
              type: string
            taxAmount:
              description: |
                The amount of the taxation item in the invoice item.
              format: number
              type: string
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific invoice item.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: >
                The date that the tax is applied to the invoice item, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            taxMode:
              description: >
                The tax mode of the invoice item, indicating whether the amount
                of the invoice item includes tax.
              enum:
                - TaxInclusive
                - TaxExclusive
              type: string
            taxRate:
              description: |
                The tax rate applied to the invoice item.
              format: number
              type: string
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the invoice item.
              enum:
                - Percentage
                - FlatFee
              type: string
          required:
            - invoiceItemId
            - jurisdiction
            - name
            - taxAmount
            - taxDate
            - taxRate
            - taxRateType
          title: taxItems
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
    POSTTaxationItemList:
      example:
        taxationItems:
          - exemptAmount: 0
            financeInformation:
              accountsReceivableAccountingCode: Check
              salesTaxPayableAccountingCode: Check
            invoiceItemId: 402890555a7e9791015a879f064d0055
            jurisdiction: CALIFORNIA
            locationCode: '06'
            name: STATE TAX
            taxAmount: 0.1
            taxCode: ServiceTaxCode
            taxCodeDescription: This is tax code description!
            taxDate: '2016-09-30'
            taxMode: TaxExclusive
            taxRate: 0.0625
            taxRateDescription: This is tax rate description!
            taxRateType: Percentage
      properties:
        taxationItems:
          description: |
            Container for taxation items.
          items:
            $ref: '#/components/schemas/POSTTaxationItemTypeForInvoice'
          type: array
      type: object
    GETTaxationItemTypewithSuccess:
      allOf:
        - properties:
            createdById:
              description: |
                The ID of the Zuora user who created the taxation item.
              type: string
            createdDate:
              description: >
                The date and time when the taxation item was created in the
                Zuora system, in `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                accountsReceivableAccountingCode:
                  description: |
                    The accounting code for accounts receivable.
                  type: string
                accountsReceivableAccountingCodeType:
                  description: |
                    The type of the accounting code for accounts receivable.
                  type: string
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  type: string
                salesTaxPayableAccountingCodeType:
                  description: |
                    The type of the accounting code for the sales taxes payable.
                  type: string
              type: object
            id:
              description: |
                The ID of the taxation item.
              type: string
            invoiceItemId:
              description: |
                The ID of the invoice associated with the taxation item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
              nullable: true
            name:
              description: |
                The name of the taxation item.
              type: string
            taxAmount:
              description: |
                The amount of the tax applied to the invoice.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific invoice.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
              nullable: true
            taxDate:
              description: |
                The date when the tax is applied to the invoice.
              format: date
              type: string
            taxMode:
              description: >
                The tax mode of the invoice item, indicating whether the amount
                of the invoice item includes tax.
              enum:
                - TaxInclusive
                - TaxExclusive
              type: string
            taxRate:
              description: |
                The tax rate applied to the invoice.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
              nullable: true
            taxRateType:
              description: |
                The type of the tax rate applied to the invoice.
              enum:
                - Percentage
                - FlatFee
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the taxation item.
              type: string
            updatedDate:
              description: >
                The date and time when the taxation item was last updated, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
      title: taxationItems
    GETTaxationItemListType:
      properties:
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        taxationItems:
          description: |
            Container for taxation items.
          items:
            $ref: '#/components/schemas/GETTaxationItemTypewithSuccess'
          type: array
      type: object
    CreditMemoItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Credit Memo Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Credit Memo Item object.
      title: creditMemoItemFieldsCustom
      type: object
    CreditMemoItemFromWriteOffInvoice:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the credit memo item.
              type: string
            financeInformation:
              description: >
                Container for the finance information related to the credit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            invoiceItemId:
              description: |
                The ID of the invoice item.
              type: string
            serviceEndDate:
              description: |
                The service end date of the credit memo item. 
              format: date
              type: string
            amountWithoutTax:
              description: |
                The write off amount of the invoice item excluding tax.
              type: number
            serviceStartDate:
              description: |
                The service start date of the credit memo item. 
              format: date
              type: string
            skuName:
              description: |
                The name of the charge associated with the invoice.
              type: string
            unitOfMeasure:
              description: |
                The definable unit that you measure when determining charges.
              type: string
            taxationItems:
              description: >
                Container for the taxation items of the credit memo item.


                **Note**: 
                  
                * This field is available only if you are on the latest Zuora
                API version, or you set the `Zuora-Version` request header to
                `239.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              items:
                properties:
                  amount:
                    description: |
                      The credit memo taxation amount.
                    type: number
                  taxationItemId:
                    description: |
                      The Id of the debit memo item.
                    type: string
                type: object
              type: array
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
      title: items
    CreditMemoObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Credit Memo object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Credit Memo object.
      title: creditMemoFieldsCustom
      type: object
    CreditMemoObjectNSFields:
      description: >
        Container for Credit Memo fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the credit memo's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Origin__NS:
          description: >
            Origin of the corresponding object in NetSuite. Only available if
            you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the credit memo was synchronized with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Transaction__NS:
          description: >
            Related transaction in NetSuite. Only available if you have
            installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: creditMemoFieldsNS
      type: object
    PUTWriteOffInvoiceRequest:
      allOf:
        - properties:
            comment:
              description: >
                Comments about the write-off. The comment is used as the comment
                of the credit memo generated by writing off the specified
                invoice.
              maxLength: 255
              minLength: 0
              type: string
            items:
              description: >
                Container for items. This field is optional. 


                **Note:** 

                * If specified, you must specify ALL the items of the invoice.
                The entire balance of the invoice will be written off, you
                cannot just write off some items of the invoice.


                 * This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact <a
                href="https://support.zuora.com/hc/en-us" target="_blank">Zuora
                Global Support</a> to enable this permission.
              items:
                $ref: '#/components/schemas/CreditMemoItemFromWriteOffInvoice'
              type: array
            memoDate:
              description: >
                The date when the credit memo was created, in `yyyy-mm-dd`
                format. The memo date must be later than or equal to the invoice
                date.


                The default value is the date when you write off the invoice.
              format: date
              type: string
            revenueImpacting:
              description: >
                Indicates whether this write off operation impacts the revenue.
                If `revenueImpacting` = `Yes`, the deferred revenue accounting
                code will be automatically selected from the associated invoice


                The **Exclude Billing Item From Revenue** field will be
                automatically set to **Yes** by default for such non-revenue
                impacting write off credit memos, and this setting cannot be
                changed. This enhancement helps ensure that only
                revenue-impacting items are synchronized with Zuora Revenue,
                reducing unnecessary data processing.


                If `revenueImpacting` = `No`, users can select an accounting
                code such as bad-debt expense accounting code for the write off
                operation.



                **Note**: This field is available only if you have enabled the
                enhanced write-off permission for your tenant. Contact <a

                href="https://support.zuora.com/hc/en-us" target="_blank">Zuora
                Global Support</a> to enable this permission.
              enum:
                - 'Yes'
                - 'No'
              default: 'Yes'
              type: string
            amount:
              description: >
                The write off amount of the invoice.



                **Note**: This field is available only if you have enabled the
                enhanced write-off permission for your tenant. Contact <a

                href="https://support.zuora.com/hc/en-us" target="_blank">Zuora
                Global Support</a> to enable this permission.
              type: number
            taxAutoCalculation:
              description: >
                Specifies whether taxes are automatically recalculated for the
                credit memo generated during the write-off process.


                When set to `true`, the system fetches the latest tax rates from
                the tax vendor instead of copying the tax amounts from the
                original invoice.


                The default value is `false`.


                **Note**: This feature is in the **Early Availability** phase.
                Contact Zuora Global Support to enable this feature before using
                it.
              type: boolean
            nonRevenueWriteOffAccountingCode:
              description: >
                Specify the accounting code for the non revenue write off.
                Available only if `revenueImpacting` = `no`.



                **Note**: This field is available only if you have enabled the
                enhanced write-off permission for your tenant. Contact <a

                href="https://support.zuora.com/hc/en-us" target="_blank">Zuora
                Global Support</a> to enable this permission.
              type: string
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code `Write-off`.
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoObjectCustomFields'
        - $ref: '#/components/schemas/CreditMemoObjectNSFields'
      example:
        memoDate: '2019-01-02'
      type: object
    PUTWriteOffInvoiceResponse:
      properties:
        creditMemo:
          description: >
            Container for the credit memo that is automatically generated when
            writing off invoices.
          properties:
            id:
              description: >
                The ID of the credit memo that is created when the invoice is
                written off.
              type: string
          type: object
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETCreditMemoTypewithSuccess:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account associated with the credit memo.
              type: string
            accountNumber:
              description: |
                The number of the account associated with the credit memo.
              type: string
            amount:
              description: |
                The total amount of the credit memo.
              format: double
              type: number
            appliedAmount:
              description: |
                The applied amount of the credit memo.
              format: double
              type: number
            autoApplyUponPosting:
              description: >
                Whether the credit memo automatically applies to the invoice
                upon posting.
              type: boolean
            billToContactId:
              description: >
                The ID of the bill-to contact associated with the credit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            cancelledById:
              description: |
                The ID of the Zuora user who cancelled the credit memo.
              type: string
              nullable: true
            cancelledOn:
              description: >
                The date and time when the credit memo was cancelled, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the credit memo.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the credit memo.
              type: string
            createdDate:
              description: >
                The date and time when the credit memo was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditMemoDate:
              description: >
                The date when the credit memo takes effect, in `yyyy-mm-dd`
                format. For example, 2017-05-20.
              format: date
              type: string
            currency:
              description: >
                The currency of the credit memo.


                **Note:** By default, the currency on a billing document matches
                the default currency set on the associated account. 

                However, Zuora now offers a Multiple Currencies feature to
                support different currencies for billing documents, allowing
                flexibility beyond the account-level currency. 

                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currency</a>.
              type: string
              nullable: true
            einvoiceErrorCode:
              description: >
                The error code returned when the e-invoice file status is
                `Failed`. This code can either be a Zuora-generated error code
                or one returned by a third-party e-invoicing service provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceErrorMessage:
              description: >
                The error message returned when the e-invoice file status is
                `Failed`. This message can either be a Zuora-generated error
                message or one returned by a third-party e-invoicing service
                provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceFileId:
              description: >
                The ID of the e-invoice file generated for the credit memo.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceStatus:
              description: >
                The status of the e-invoice file generation for the credit
                memo. 


                - If e-invoice file generation succeeds, this field is either
                `Generated` or `Success`, and both the error code and message
                are empty, and the `eInvoiceFileId` field stores the ID of the
                generated e-invoice file.

                - If the responses from tax vendors such as Sovos or Avalara
                are 
                  taking too long, this field becomes `RetrieveTimeOut`. Once the 
                  vendor responds successfully, you can use the 'Resync E-Invoice Status' 
                  action to update the status automatically.  You can view these updates 
                  in System Health telemetry.

                - If a failure occurs during e-invoice file generation, this
                field is `Failed` and an error code and an error message are
                returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields. 

                - If e-invoice file generation conditionally succeeds, this
                field is `ConditionalSuccess` and an error code and an error
                message are returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields.

                - If the e-invoice file has been approved by the tax authority,
                this field is `ApprovedByAuthority`. The next status will be
                either `Success` or `Rejected`.

                - If the e-invoice file has been rejected by the government,
                this field is `Rejected`. You cannot resend this e-invoice; you
                must create a new invoice instead.

                  **Note**: This field is available only if you have the <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                  target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
                  enabled.
              enum:
                - Processing
                - RetrieveTimeOut
                - Generated
                - Success
                - Failed
                - ConditionalSuccess
                - ApprovedByAuthority
                - Rejected
              type: string
              nullable: true
            excludeFromAutoApplyRules:
              description: >
                Whether the credit memo is excluded from the rule of
                automatically applying unapplied credit memos to invoices and
                debit memos during payment runs.
              type: boolean
            id:
              description: |
                The unique ID of the credit memo.
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the credit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            latestPDFFileId:
              description: |
                The ID of the latest PDF file generated for the credit memo.
              type: string
            number:
              description: |
                The unique identification number of the credit memo.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            postedById:
              description: |
                The ID of the Zuora user who posted the credit memo.
              type: string
              nullable: true
            postedOn:
              description: >
                The date and time when the credit memo was posted, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty.
              type: string
            referredInvoiceId:
              description: |
                The ID of a referred invoice.
              type: string
              nullable: true
            refundAmount:
              description: |
                The amount of the refund on the credit memo.
              format: double
              type: number
            revenueImpacting:
              description: >
                Indicates whether this write off operation impacts the revenue.
                If `revenueImpacting` = `Yes`, the deferred revenue accounting
                code will be automatically selected from the associated invoice


                If `revenueImpacting` = `No`, users can select an accounting
                code such as bad-debt expense accounting code for the write off
                operation.
              enum:
                - 'Yes'
                - 'No'
              default: 'Yes'
              type: string
            reversed:
              description: |
                Whether the credit memo is reversed.
              type: boolean
            sequenceSetId:
              description: >
                The ID of the sequence set associated with the credit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            communicationProfileId:
              description: >
                The ID of the communication profile associated with the credit
                memo.


                **Note**: This field is available in the request body only if
                you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a>

                feature turned on. The value is `null` in the response body
                without this feature turned on.
              type: string
              nullable: true
            source:
              description: >
                The source of the credit memo.


                Possible values:

                - `BillRun`: The credit memo is generated by a bill run.

                - `API`: The credit memo is created by calling the [Invoice and
                collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment)
                operation, or by calling the Orders, Order Line Items, or
                Fulfillments API operations.

                - `ApiSubscribe`: The credit memo is created by calling the
                [Create
                subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription)
                and [Create
                account](https://developer.zuora.com/api-references/api/operation/POST_Account)
                operation.

                - `ApiAmend`: The credit memo is created by calling the [Update
                subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription)
                operation.

                - `AdhocFromPrpc`: The credit memo is created from a product
                rate plan charge through the Zuora UI or by calling the [Create
                a credit memo from a
                charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc)
                operation.

                - `AdhocFromInvoice`: The credit memo is created from an invoice
                or created by reversing an invoice. You can create a credit memo
                from an invoice through the Zuora UI or by calling the [Create
                credit memo from
                invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice)
                operation. You can create a credit memo by reversing an invoice
                through the Zuora UI or by calling the [Reverse
                invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice)
                operation.
              type: string
            sourceId:
              description: >
                The ID of the credit memo source. 


                If a credit memo is generated from a bill run, the value is the
                number of the corresponding bill run. Otherwise, the value is
                `null`.
              type: string
            sourceType:
              description: |
                The type of the credit memo source.
              enum:
                - Subscription
                - Standalone
                - Invoice
                - Order
                - CreditMemo
                - Consolidation
              type: string
            status:
              description: |
                The status of the credit memo. 
              enum:
                - Draft
                - Posted
                - Canceled
                - Error
                - PendingForTax
                - Generating
                - CancelInProgress
              type: string
            targetDate:
              description: >
                The target date for the credit memo, in `yyyy-mm-dd` format. For
                example, 2017-07-20.
              format: date
              type: string
              nullable: true
            taxAmount:
              description: |
                The amount of taxation.
              format: double
              type: number
            taxMessage:
              description: >
                The message about the status of tax calculation related to the
                credit memo. If tax calculation fails in one credit memo, this
                field displays the reason for the failure.
              type: string
              nullable: true
            taxStatus:
              description: >
                The status of tax calculation related to the credit memo.


                **Note**: This field is only applicable to tax calculation by
                third-party tax engines. Also, the `Voided` status indicates
                that the tax transaction is successfully canceled on the tax
                vendor's side. If a tax transaction was successfully committed
                to the third-party tax engine but the invoice failed to post, 
                Zuora automatically detects the issue and voids the tax
                transaction on the vendor's side.
              enum:
                - Complete
                - Error
                - UnknownError
                - DuplicateDoc
                - InvalidRequest
                - InvalidResponse
                - TaxEngineError
                - ConcurrentModify
                - InternalServerError
                - TaxCodeTemplateError
                - Voided
              type: string
              nullable: true
            totalTaxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            transferredToAccounting:
              description: >
                Whether the credit memo was transferred to an external
                accounting system. Use this field for integration with
                accounting systems, such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedAmount:
              description: |
                The unapplied amount of the credit memo.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the credit memo.
              type: string
            updatedDate:
              description: >
                The date and time when the credit memo was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoObjectNSFields'
        - $ref: '#/components/schemas/CreditMemoObjectCustomFields'
      title: creditmemos
    GETCreditMemoCollectionType:
      properties:
        creditmemos:
          description: |
            Container for credit memos.
          items:
            $ref: '#/components/schemas/GETCreditMemoTypewithSuccess'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    CreditMemoFromChargeDetailType:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the credit memo item.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: double
              type: number
            excludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the credit memo item from revenue
                accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.
              type: boolean
            description:
              description: >
                The description of the product rate plan charge.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              maxLength: 255
              minLength: 0
              type: string
            financeInformation:
              description: >
                Container for the finance information related to the product
                rate plan charge associated with the credit memo.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the credit memo is
                created from.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            quantity:
              description: |
                The number of units for the credit memo item.
              format: double
              type: number
            serviceEndDate:
              description: >
                The service end date of the credit memo item. If not specified,
                the effective end date of the corresponding product rate plan
                will be used.
              format: date
              type: string
            serviceStartDate:
              description: >
                The service start date of the credit memo item. If not
                specified, the effective start date of the corresponding product
                rate plan will be used.
              format: date
              type: string
          required:
            - productRatePlanChargeId
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
      title: charges
    CreditMemoFromChargeCustomRatesType:
      allOf:
        - properties:
            currency:
              description: >
                The currency code for either Reporting or Home currency.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            customFxRate:
              description: >
                The Custom FX conversion rate between Home/Reporting and
                Transactional currency items.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: decimal
              type: number
            rateDate:
              description: >
                The date on which a particular currency rate is fixed or
                obtained on.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: date
              type: string
          required:
            - currency
            - customFxRate
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
      title: customRates
    CreditMemoFromChargeRequest:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with the credit memo.


                **Note**: When creating credit memos from product rate plan
                charges, you must specify `accountNumber`, `accountId`, or both
                in the request body. If both fields are specified, they must
                correspond to the same account.
              type: string
            accountNumber:
              description: >
                The number of the customer account associated with the credit
                memo.


                **Note**: When creating credit memos from product rate plan
                charges, you must specify `accountNumber`, `accountId`, or both
                in the request body. If both fields are specified, they must
                correspond to the same account.
              type: string
            autoPost:
              default: false
              description: >
                Whether to automatically post the credit memo after it is
                created. 


                Setting this field to `true`, you do not need to separately call
                the [Post a credit
                memo](https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo)
                operation to post the credit memo.
              type: boolean
            charges:
              description: >
                Container for product rate plan charges. The maximum number of
                items is 1,000.
              items:
                $ref: '#/components/schemas/CreditMemoFromChargeDetailType'
              maxItems: 1000
              type: array
            comment:
              description: |
                Comments about the credit memo.
              type: string
            currency:
              description: >
                The code of a currency as defined in Billing Settings through
                the Zuora UI.


                If you do not specify a currency during credit memo creation,
                the default account currency is applied. The currency that you
                specify in the request must be configured and activated in
                Billing Settings.

                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currencies</a> feature enabled.
              type: string
            customRates:
              description: >
                It contains Home currency and Reporting currency custom rates
                currencies. The maximum number of items is 2 (you can pass the
                Home currency item or Reporting currency item or both).


                **Note**:


                - The API custom rate feature is permission controlled.


                - You cannot set the custom rates, if both the **Automatically
                include additional Currency Conversion information in data
                source exports** option and **Fx data** feature are enabled.


                - CreditMemo, CreditMemoItem, and CreditMemoItemTax will utilize
                the provided custom Fx rate to convert amounts from the
                transactional currency to the home currency.
              items:
                $ref: '#/components/schemas/CreditMemoFromChargeCustomRatesType'
              maxItems: 2
              type: array
            effectiveDate:
              description: |
                The date when the credit memo takes effect.
              format: date
              type: string
            excludeFromAutoApplyRules:
              default: false
              description: >
                Whether the credit memo is excluded from the rule of
                automatically applying unapplied credit memos to invoices and
                debit memos during payment runs. If you set this field to
                `true`, a payment run does not pick up this credit memo or apply
                it to other invoices or debit memos.
              type: boolean
            number:
              type: string
              maxLength: 32
              description: >
                A customized credit memo number with the following format
                requirements:


                - Max length: 32 characters

                - Acceptable characters: a-z,A-Z,0-9,-,_


                The value must be unique in the system, otherwise it may cause
                issues with bill runs and subscriptions.


                If not provided, Zuora will generate a unique number per the
                sequence set on the account level. If the account-level sequence
                set is not specified, the system default sequence set is used.
                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Configure_billing_settings/Billing_document_settings/Configure_prefix_and_numbering_for_billing_documents"
                target="_blank">Configure prefix and numbering for billing
                documents</a>.
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoObjectNSFields'
        - $ref: '#/components/schemas/CreditMemoObjectCustomFields'
      example:
        accountId: 8ad09be48db5aba7018db604776d4854
        charges:
          - amount: 10
            productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
      title: memos
    GETCreditMemoType:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account associated with the credit memo.
              type: string
            accountNumber:
              description: >
                The number of the customer account associated with the credit
                memo.
              type: string
            amount:
              description: |
                The total amount of the credit memo.
              format: double
              type: number
            appliedAmount:
              description: |
                The applied amount of the credit memo.
              format: double
              type: number
            autoApplyUponPosting:
              description: >
                Whether the credit memo automatically applies to the invoice
                upon posting.
              type: boolean
            billToContactId:
              description: >
                The ID of the bill-to contact associated with the credit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            billToContactSnapshotId:
              description: >
                The ID of the bill-to contact snapshot associated with the
                credit memo.


                The value of this field is `null` if the bill rule [Preserve
                snapshot of bill-to and sold-to contacts when billing documents
                are
                posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted)
                is disabled.
              type: string
              nullable: true
            cancelledById:
              description: |
                The ID of the Zuora user who cancelled the credit memo.
              type: string
              nullable: true
            cancelledOn:
              description: >
                The date and time when the credit memo was cancelled, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the credit memo.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the credit memo.
              type: string
            createdDate:
              description: >
                The date and time when the credit memo was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditMemoDate:
              description: >
                The date when the credit memo takes effect, in `yyyy-mm-dd`
                format. For example, 2017-05-20.
              format: date
              type: string
            currency:
              description: >
                The currency of the credit memo.


                **Note:** By default, the currency on a billing document matches
                the default currency set on the associated account. 

                However, Zuora now offers a Multiple Currencies feature to
                support different currencies for billing documents, allowing
                flexibility beyond the account-level currency. 

                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currency</a>.
              type: string
              nullable: true
            einvoiceErrorCode:
              description: >
                The error code returned when the e-invoice file status is
                `Failed`. This code can either be a Zuora-generated error code
                or one returned by a third-party e-invoicing service provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceErrorMessage:
              description: >
                The error message returned when the e-invoice file status is
                `Failed`. This message can either be a Zuora-generated error
                message or one returned by a third-party e-invoicing service
                provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceFileId:
              description: >
                The ID of the e-invoice file generated for the credit memo.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceStatus:
              description: >
                The status of the e-invoice file generation for the credit
                memo. 


                - If e-invoice file generation succeeds, this field is either
                `Generated` or `Success`, and both the error code and message
                are empty, and the `eInvoiceFileId` field stores the ID of the
                generated e-invoice file.

                - If the responses from tax vendors such as Sovos or Avalara
                are 
                  taking too long, this field becomes `RetrieveTimeOut`. Once the 
                  vendor responds successfully, you can use the 'Resync E-Invoice Status' 
                  action to update the status automatically.  You can view these updates 
                  in System Health telemetry.

                - If a failure occurs during e-invoice file generation, this
                field is `Failed` and an error code and an error message are
                returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields. 

                - If e-invoice file generation conditionally succeeds, this
                field is `ConditionalSuccess` and an error code and an error
                message are returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields.

                - If the e-invoice file has been approved by the tax authority,
                this field is `ApprovedByAuthority`. The next status will be
                either `Success` or `Rejected`.

                - If the e-invoice file has been rejected by the government,
                this field is `Rejected`. You cannot resend this e-invoice; you
                must create a new invoice instead.

                  **Note**: This field is available only if you have the <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                  target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
                  enabled.
              enum:
                - Processing
                - RetrieveTimeOut
                - Generated
                - Success
                - Failed
                - ConditionalSuccess
                - ApprovedByAuthority
                - Rejected
              type: string
              nullable: true
            excludeFromAutoApplyRules:
              description: >
                Whether the credit memo is excluded from the rule of
                automatically

                applying credit memos to invoices.
              type: boolean
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the credit memo item from revenue
                accounting.



                **Note**: This field is only available if you have the Billing -

                Revenue Integration feature enabled. 
              type: boolean
            id:
              description: |
                The unique ID of the credit memo.
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the credit memo.



                The value of this field is `null` if you have the [Flexible
                Billing

                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)

                feature disabled.
              type: string
              nullable: true
            latestPDFFileId:
              description: |
                The ID of the latest PDF file generated for the credit memo.
              type: string
              nullable: true
            number:
              description: |
                The unique identification number of the credit memo.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            postedById:
              description: |
                The ID of the Zuora user who posted the credit memo.
              type: string
              nullable: true
            postedOn:
              description: >
                The date and time when the credit memo was posted, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty.
              type: string
            referredInvoiceId:
              description: |
                The ID of a referred invoice.
              type: string
              nullable: true
            refundAmount:
              description: |
                The amount of the refund on the credit memo.
              format: double
              type: number
            revenueImpacting:
              description: >
                Indicates whether this write off operation impacts the revenue.
                If `revenueImpacting` = `Yes`, the deferred revenue accounting
                code will be automatically selected from the associated invoice


                If `revenueImpacting` = `No`, users can select an accounting
                code such as bad-debt expense accounting code for the write off
                operation.
              enum:
                - 'Yes'
                - 'No'
              default: 'Yes'
              type: string
            reversed:
              description: |
                Whether the credit memo is reversed.
              type: boolean
            sequenceSetId:
              description: >
                The ID of the sequence set associated with the credit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            communicationProfileId:
              description: >
                The ID of the communication profile associated with the credit
                memo.


                **Note**: This field is available in the request body only if
                you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a>

                feature turned on. The value is `null` in the response body
                without this feature turned on.
              type: string
              nullable: true
            source:
              description: >
                The source of the credit memo.


                Possible values:

                - `BillRun`: The credit memo is generated by a bill run.

                - `API`: The credit memo is created by calling the [Invoice and
                collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment)
                operation, or by calling the Orders, Order Line Items, or
                Fulfillments API operations.

                - `ApiSubscribe`: The credit memo is created by calling the
                [Create
                subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription)
                and [Create
                account](https://developer.zuora.com/api-references/api/operation/POST_Account)
                operation.

                - `ApiAmend`: The credit memo is created by calling the [Update
                subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription)
                operation.

                - `AdhocFromPrpc`: The credit memo is created from a product
                rate plan charge through the Zuora UI or by calling the [Create
                a credit memo from a
                charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc)
                operation.

                - `AdhocFromInvoice`: The credit memo is created from an invoice
                or created by reversing an invoice. You can create a credit memo
                from an invoice through the Zuora UI or by calling the [Create
                credit memo from
                invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice)
                operation. You can create a credit memo by reversing an invoice
                through the Zuora UI or by calling the [Reverse
                invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice)
                operation.
              type: string
            sourceId:
              description: >
                The ID of the credit memo source.


                If a credit memo is generated from a bill run, the value is the
                number of the corresponding bill run. Otherwise, the value is
                `null`.
              type: string
              nullable: true
            sourceType:
              description: |
                The type of the credit memo source.
              enum:
                - Subscription
                - Standalone
                - Invoice
                - Order
                - CreditMemo
                - Consolidation
              type: string
            status:
              description: |
                The status of the credit memo.
              enum:
                - Draft
                - Posted
                - Canceled
                - Error
                - PendingForTax
                - Generating
                - CancelInProgress
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            targetDate:
              description: >
                The target date for the credit memo, in `yyyy-mm-dd` format. For
                example, 2017-07-20.
              format: date
              type: string
              nullable: true
            taxAmount:
              description: |
                The amount of taxation.
              format: double
              type: number
            taxMessage:
              description: >
                The message about the status of tax calculation related to the
                credit memo. If tax calculation fails in one credit memo, this
                field displays the reason for the failure.
              type: string
              nullable: true
            taxStatus:
              description: >
                The status of tax calculation related to the credit memo.


                **Note**: This field is only applicable to tax calculation by
                third-party tax engines. Also, the `Voided` status indicates
                that the tax transaction is successfully canceled on the tax
                vendor's side.  If a tax transaction was successfully committed
                to the third-party tax engine but the invoice failed to post,
                Zuora automatically detects the issue and voids the tax
                transaction on the vendor's side.
              enum:
                - Complete
                - Error
                - UnknownError
                - DuplicateDoc
                - InvalidRequest
                - InvalidResponse
                - TaxEngineError
                - ConcurrentModify
                - InternalServerError
                - TaxCodeTemplateError
                - Voided
              type: string
              nullable: true
            totalTaxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            transferredToAccounting:
              description: >
                Whether the credit memo was transferred to an external
                accounting system. Use this field for integration with
                accounting systems, such as NetSuite.
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedAmount:
              description: |
                The unapplied amount of the credit memo.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the credit memo.
              type: string
            updatedDate:
              description: >
                The date and time when the credit memo was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoObjectNSFields'
        - $ref: '#/components/schemas/CreditMemoObjectCustomFields'
    CreditTaxationItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Credit Taxation Item object. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Credit Taxation Item object.
      title: creditTaxationItemFieldsCustom
      type: object
    PutCreditMemoTaxItemType:
      allOf:
        - properties:
            amount:
              description: |
                The amount of the taxation item in the credit memo item.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item in the credit memo item.
              properties:
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            id:
              description: |
                The ID of the taxation item in the credit memo item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific credit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: >
                The date that the tax is applied to the credit memo, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            taxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            taxName:
              description: |
                The name of taxation.
              type: string
            taxRate:
              description: |
                The tax rate applied to the credit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate. 
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the credit memo.
              enum:
                - Percentage
                - FlatFee
              type: string
          required:
            - id
          type: object
        - $ref: '#/components/schemas/CreditTaxationItemObjectCustomFields'
      title: taxItems
    PUTCreditMemoItemType:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the credit memo item. For tax-inclusive credit
                memo items, the amount indicates the credit memo item amount
                including tax. For tax-exclusive credit memo items, the amount
                indicates the credit memo item amount excluding tax
              format: double
              type: number
            comment:
              description: |
                Comments about the credit memo item.
              type: string
            delete:
              description: >
                Whether to delete the existing credit memo item.



                **Note**: To delete a credit memo item, set this field to `true`
                and specify a credit memo item ID in the `id` field.
              type: boolean
            excludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the credit memo item from revenue
                accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: boolean
            financeInformation:
              description: >
                Container for the finance information related to the credit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            id:
              description: >
                The ID of the credit memo item. 

                - Specify this field when updating or deleting an existing memo
                item. 

                - Do not specify this field when creating a memo item.
              maxLength: 32
              minLength: 32
              type: string
            quantity:
              description: |
                The number of units for the credit memo item.
              format: double
              type: number
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the credit memo is
                created from.



                **Note**: Do not specify the credit memo item `id` when
                specifying this field.
              type: string
            serviceEndDate:
              description: |
                The service end date of the credit memo item.
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the credit memo item.
              format: date
              type: string
            skuName:
              description: |
                The name of the SKU.
              type: string
            taxItems:
              description: |
                Container for credit memo taxation items.
              items:
                $ref: '#/components/schemas/PutCreditMemoTaxItemType'
              type: array
            unitOfMeasure:
              description: |
                The definable unit that you measure when determining charges.
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
      title: items
    PUTCreditMemoType:
      allOf:
        - properties:
            autoApplyUponPosting:
              description: >
                Whether the credit memo automatically applies to the invoice
                upon posting.
              type: boolean
            comment:
              description: |
                Comments about the credit memo.
              maxLength: 255
              minLength: 0
              type: string
            effectiveDate:
              description: |
                The date when the credit memo takes effect.
              format: date
              type: string
            excludeFromAutoApplyRules:
              description: >
                Whether the credit memo is excluded from the rule of
                automatically applying unapplied credit memos to invoices and
                debit memos during payment runs. If you set this field to
                `true`, a payment run does not pick up this credit memo or apply
                it to other invoices or debit memos.
              type: boolean
            items:
              description: |
                Container for credit memo items.
              items:
                $ref: '#/components/schemas/PUTCreditMemoItemType'
              type: array
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
            transferredToAccounting:
              description: >
                Whether the credit memo is transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoObjectNSFields'
        - $ref: '#/components/schemas/CreditMemoObjectCustomFields'
      example:
        comment: Details about this Credit Memo
    PUTCreditMemosWithIdType:
      allOf:
        - properties:
            id:
              description: |
                The ID of the credit memo.
              type: string
          type: object
        - $ref: '#/components/schemas/PUTCreditMemoType'
      title: memos
    PUTBulkCreditMemosRequestType:
      allOf:
        - properties:
            memos:
              description: >
                The container for a list of credit memos. The maximum number of
                credit memos is 50.
              items:
                $ref: '#/components/schemas/PUTCreditMemosWithIdType'
              maxItems: 50
              type: array
          type: object
      example:
        memos:
          - autoApplyUponPosting: false
            comment: new comment
            effectiveDate: '2017-04-17'
            excludeFromAutoApplyRules: false
            id: 402890555b797b57015b7986fc1a001f
            items:
              - amount: 1
                comment: This is comment!
                id: 402890555b797b57015b7986fc1a001c
                quantity: 1
                serviceEndDate: '2016-11-30'
                serviceStartDate: '2016-11-01'
                skuName: SKU-1
                taxItems:
                  - amount: 0.03
                    id: 402890555b797b57015b7986fc3c001d
                    jurisdiction: CALIFORNIA
                    locationCode: '06'
                    taxCode: null
                    taxCodeDescription: This is tax code description!
                    taxDate: '2016-11-30'
                    taxExemptAmount: 0
                    taxName: STATE TAX1
                    taxRate: 0.0625
                    taxRateDescription: This is tax rate description!
                    taxRateType: Percentage
                unitOfMeasure: Test_UOM
              - amount: 2
                comment: This is comment!
                id: 402890555b797b57015b7986fc41001e
                serviceEndDate: '2016-11-30'
                serviceStartDate: '2016-11-01'
                skuName: SKU-2
                taxItems: []
                unitOfMeasure: Test_UOM
            reasonCode: Correcting invoice error
    BulkCreditMemosResponseType:
      allOf:
        - properties:
            memos:
              description: |
                The container for a list of credit memos.
              items:
                $ref: '#/components/schemas/GETCreditMemoType'
              maxItems: 50
              title: memos
              type: array
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
          type: object
    CreditMemoTaxItemFromInvoiceTaxItemType:
      properties:
        amount:
          description: |
            The amount of the credit memo taxation item.
          format: double
          type: number
        financeInformation:
          description: >
            Container for the finance information related to the source taxation
            item.
          properties:
            onAccountAccountingCode:
              description: >
                The accounting code that maps to an on account in your
                accounting system.
              maxLength: 100
              minLength: 0
              type: string
            salesTaxPayableAccountingCode:
              description: |
                The accounting code for the sales taxes payable.
              maxLength: 100
              minLength: 0
              type: string
          type: object
        jurisdiction:
          description: >
            The jurisdiction that applies the tax or VAT. This value is
            typically a state, province, county, or city. 
          type: string
        locationCode:
          description: >
            The identifier for the location based on the value of the `taxCode`
            field.
          type: string
        sourceTaxItemId:
          description: |
            The ID of the source taxation item.
          type: string
        taxCode:
          description: >
            The tax code identifies which tax rules and tax rates to apply to a
            specific credit memo. 
          type: string
        taxCodeDescription:
          description: |
            The description of the tax code.
          type: string
        taxDate:
          description: >
            The date that the tax is applied to the credit memo, in `yyyy-mm-dd`
            format.
          format: date
          type: string
        taxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        taxName:
          description: |
            The name of taxation.
          type: string
        taxRate:
          description: |
            The tax rate applied to the credit memo.
          format: double
          type: number
        taxRateDescription:
          description: |
            The description of the tax rate. 
          type: string
        taxRateType:
          description: |
            The type of the tax rate applied to the credit memo. 
          enum:
            - Percentage
            - FlatFee
          type: string
      title: taxItems
      type: object
    CreditMemoItemFromInvoiceItemType:
      allOf:
        - properties:
            amount:
              description: |
                The amount of the credit memo item.
              format: double
              type: number
            description:
              description: >
                The description of the credit memo item.

                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            financeInformation:
              description: >
                Container for the finance information related to the credit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            invoiceItemId:
              description: |
                The ID of the invoice item.
              type: string
            quantity:
              description: |
                The number of units for the credit memo item.
              format: double
              type: number
            serviceEndDate:
              description: |
                The service end date of the credit memo item.
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the credit memo item.
              format: date
              type: string
            skuName:
              description: |
                The name of the charge associated with the invoice.
              type: string
            taxItems:
              description: |
                Container for taxation items.
              items:
                $ref: '#/components/schemas/CreditMemoTaxItemFromInvoiceTaxItemType'
              type: array
            taxMode:
              default: TaxExclusive
              description: >
                The tax mode of the credit memo item, indicating whether the
                amount of the credit memo item includes tax.

                **Note**: 
                  - Only includes the `taxMode` field if the credit memo needs to be processed with a different tax mode than what was processed during invoice generation or the product rate plan charge was defined with. Otherwise, do not specify a tax mode.
                  - You can set this field to `TaxInclusive` only if the `taxAutoCalculation` field is set to `true`.
                  - If you set `taxMode` to `TaxInclusive`, you cannot input tax amounts for credit memo items. The corresponding invoice item must use the same tax engine as the credit memo item to calculate tax amounts.
              enum:
                - TaxExclusive
                - TaxInclusive
              type: string
            unitOfMeasure:
              description: |
                The definable unit that you measure when determining charges.
              type: string
          required:
            - skuName
            - amount
            - invoiceItemId
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
      title: items
    CreditMemoFromInvoiceRequest:
      allOf:
        - properties:
            autoApplyToInvoiceUponPosting:
              description: >
                Whether the credit memo automatically applies to the invoice
                upon posting.
              type: boolean
            autoPost:
              default: false
              description: >
                Whether to automatically post the credit memo after it is
                created. 

                Setting this field to `true`, you do not need to separately call
                the [Post credit
                memo](https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo)
                operation to post the credit memo.
              type: boolean
            comment:
              description: |
                Comments about the credit memo.
              maxLength: 255
              minLength: 0
              type: string
            effectiveDate:
              description: |
                The date when the credit memo takes effect.
              format: date
              type: string
            excludeFromAutoApplyRules:
              description: >
                Whether the credit memo is excluded from the rule of
                automatically applying credit memos to invoices.
              type: boolean
            invoiceId:
              description: |
                The ID of the invoice that the credit memo is created from.
              type: string
            items:
              description: |
                Container for items. The maximum number of items is 1,000.
              items:
                $ref: '#/components/schemas/CreditMemoItemFromInvoiceItemType'
              maxItems: 1000
              type: array
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
            taxAutoCalculation:
              default: true
              description: |
                Whether to automatically calculate taxes in the credit memo.
              type: boolean
          type: object
          required:
            - invoiceId
        - $ref: '#/components/schemas/CreditMemoObjectNSFields'
        - $ref: '#/components/schemas/CreditMemoObjectCustomFields'
      example:
        invoiceId: 8a90d7a892d82d920192dbcb314501c7
        items:
          - amount: 10
            invoiceItemId: 8a90d7a892d82d920192dbcb31f401c8
            skuName: SKU-00000707
      title: memos
    BulkCreateCreditMemosFromInvoiceRequest:
      properties:
        sourceType:
          type: string
          enum:
            - Invoice
          description: >
            The type of the source where credit memos are created. 
                
            This enum field has the following values:
              - `Invoice`: By setting this field to `Invoice`, you can create multiple credit memos from invoices.
              - `Standalone`: By setting this field to `Standalone`, you can create multiple credit memos from product rate plan charges.
              
            The specific schema of the `memos` object field in the request body
            depends on the value of the `sourceType` field.
              - To view the `memos` schema applicable to credit memo creation from invoices, select `Invoice` from the following drop-down list.
              - To view the `memos` schema applicable to credit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.
              
        memos:
          description: >
            The container for a list of credit memos. The maximum number of
            credit memos is 50.
          items:
            $ref: '#/components/schemas/CreditMemoFromInvoiceRequest'
          maxItems: 50
          type: array
      required:
        - sourceType
      type: object
    BulkCreateCreditMemosFromChargeRequest:
      properties:
        sourceType:
          type: string
          enum:
            - Standalone
            - Invoice
          description: >
            The type of the source where credit memos are created. 
                
            This enum field has the following values:
              - `Invoice`: By setting this field to `Invoice`, you can create multiple credit memos from invoices.
              - `Standalone`: By setting this field to `Standalone`, you can create multiple credit memos from product rate plan charges.
              
            The specific schema of the `memos` object field in the request body
            depends on the value of the `sourceType` field.
              - To view the `memos` schema applicable to credit memo creation from invoices, select `Invoice` from the following drop-down list.
              - To view the `memos` schema applicable to credit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.
        memos:
          description: >
            The container for a list of credit memos. The maximum number of
            credit memos is 50.
          items:
            $ref: '#/components/schemas/CreditMemoFromChargeRequest'
          maxItems: 50
          type: array
      required:
        - sourceType
      type: object
    POSTBulkCreditMemosRequestType:
      discriminator:
        propertyName: sourceType
        mapping:
          Invoice: '#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest'
          Standalone: '#/components/schemas/BulkCreateCreditMemosFromChargeRequest'
      oneOf:
        - $ref: '#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest'
        - $ref: '#/components/schemas/BulkCreateCreditMemosFromChargeRequest'
    GetCreditMemoPdfStatusResponse:
      allOf:
        - properties:
            creditMemoId:
              description: |
                The ID of the credit memo whose pdf status is requested.
              type: string
            creditMemoNumber:
              description: >
                The credit memo number of the credit memo whose pdf status is
                requested.
              type: string
            pdfGenerationStatus:
              description: |
                The generation status of the credit memo PDF.
              type: string
              enum:
                - None
                - Pending
                - Processing
                - Generated
                - Error
                - Obsolete
            createdOn:
              description: |
                The time at which the request to generate the PDF was created.
              type: string
            updatedOn:
              description: |
                The time at which the request to generate the PDF was updated.
              type: string
            pdfFileURL:
              description: >
                The file path or the URL of the PDF when the status is
                `Generated`.  
              type: string
            errorCategory:
              description: |
                The error category when the status is `Error`. 
              type: string
            errorMessage:
              description: |
                The error message when the status is `Error`. 
              type: string
          type: object
    GetCreditMemoPdfStatusBatchResponse:
      description: ''
      example:
        creditMemoFiles:
          - creditMemoId: 402824aa8cc894d5018cc8a120576881
            creditMemoNumber: CM00000003
            pdfGenerationStatus: Generated
            createdOn: '2024-01-01 11:35:56'
            updatedOn: '2024-01-01 11:35:56'
            pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
          - creditMemoId: 2c98908a904dfc2601904e6e14090241
            creditMemoNumber: CM00000004
            pdfGenerationStatus: Error
            createdOn: '2024-01-02 10:14:13'
            updatedOn: '2024-01-02 10:14:13'
            errorCode: INVALID_TEMPLATE
            errorMessage: Unknown merge filed chargeNumber__c
          - creditMemoId: 402824aa8cc894d5018cc8a120576881
            creditMemoNumber: CM00000005
            pdfGenerationStatus: Pending
            createdOn: '2024-01-01 11:35:56'
            updatedOn: '2024-01-01 11:35:56'
        success: true
      properties:
        creditMemoFiles:
          description: |
            Array of credit memo PDF statuses requested.
          items:
            $ref: '#/components/schemas/GetCreditMemoPdfStatusResponse'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
      title: creditMemoFiles
    GETCMTaxItemTypeNew:
      allOf:
        - properties:
            appliedAmount:
              description: |
                The applied amount of the taxation item.
              format: double
              type: number
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  type: string
                  nullable: true
                onAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to an on account
                    in your accounting system.
                  type: string
                  nullable: true
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  type: string
                  nullable: true
                salesTaxPayableAccountingCodeType:
                  description: |
                    The type of the accounting code for the sales taxes payable.
                  type: string
                  nullable: true
              type: object
            id:
              description: |
                The ID of the taxation item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            name:
              description: |
                The name of the taxation item.
              type: string
            refundAmount:
              description: |
                The amount of the refund on the taxation item.
              format: double
              type: number
            sourceTaxItemId:
              description: |
                The ID of the source taxation item.
              type: string
              nullable: true
            taxAmount:
              description: |
                The amount of taxation.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific credit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: >
                The date that the tax is applied to the credit memo, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            taxRate:
              description: |
                The tax rate applied to the credit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate.
              enum:
                - Percentage
                - FlatFee
              type: string
            unappliedAmount:
              description: |
                The unapplied amount of the taxation item.
              format: double
              type: number
          type: object
        - $ref: '#/components/schemas/CreditTaxationItemObjectCustomFields'
      title: data
    GETTaxationItemsOfCreditMemoItemType:
      allOf:
        - properties:
            data:
              description: |
                Container for the taxation items of the credit memo item.
              items:
                $ref: '#/components/schemas/GETCMTaxItemTypeNew'
              type: array
            nextPage:
              description: >
                URL to retrieve the next page of the response if it exists;
                otherwise absent.
              format: URL
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
          type: object
    DebitMemoObjectCustomFieldsCMWriteOff:
      additionalProperties:
        description: >
          Custom fields of the Debit Memo object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Debit Memo object.
      title: debitMemoFieldsCustom
      type: object
    PUTCreditMemoWriteOff:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the debit memo.
              type: string
            memoDate:
              description: >
                The creation date of the debit memo and the effective date of
                the credit memo. Credit memos are applied to the corresponding
                debit memos on `memoDate`. By default, `memoDate` is set to the
                current date.
              format: date
              type: string
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. The default value is
                `Write-off`.
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoObjectCustomFieldsCMWriteOff'
      example:
        memoDate: '2022-05-05'
    PUTCreditMemoWriteOffResponseType:
      properties:
        debitMemo:
          description: |
            Container for the credit memo that is automatically created.
          properties:
            id:
              description: |
                The unique ID of the created debit memo.
              type: string
          type: object
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    CreditMemoApplyDebitMemoItemRequestType:
      properties:
        amount:
          description: |
            The amount that is applied to the specific item. 
          format: double
          type: number
        creditMemoItemId:
          description: |
            The ID of the credit memo item.
          type: string
        creditTaxItemId:
          description: |
            The ID of the credit memo taxation item.
          type: string
        debitMemoItemId:
          description: >
            The ID of the debit memo item that the credit memo item is applied
            to.
          type: string
        taxItemId:
          description: >
            The ID of the debit memo taxation item that the credit memo taxation
            item is applied to.
          type: string
      required:
        - amount
      title: items
      type: object
    CreditMemoApplyDebitMemoRequestType:
      properties:
        amount:
          description: |
            The credit memo amount to be applied to the debit memo.
          format: double
          type: number
        debitMemoId:
          description: |
            The unique ID of the debit memo that the credit memo is applied to.
          type: string
        items:
          description: >
            Container for items. The maximum number of items is 1,000.


            If `creditMemoItemId` is the source, then it should be accompanied
            by a target `debitMemoItemId`.


            If `creditTaxItemId` is the source, then it should be accompanied by
            a target `taxItemId`.
          items:
            $ref: '#/components/schemas/CreditMemoApplyDebitMemoItemRequestType'
          type: array
      required:
        - amount
        - debitMemoId
      title: debitMemos
      type: object
    CreditMemoApplyInvoiceItemRequestType:
      properties:
        amount:
          description: |
            The amount that is applied to the specific item. 
          format: double
          type: number
        creditMemoItemId:
          description: |
            The ID of the credit memo item.
          type: string
        creditTaxItemId:
          description: |
            The ID of the credit memo taxation item.
          type: string
        invoiceItemId:
          description: |
            The ID of the invoice item that the credit memo item is applied to.
          type: string
        taxItemId:
          description: >
            The ID of the invoice taxation item that the credit memo taxation
            item is applied to.
          type: string
      required:
        - amount
      title: items
      type: object
    CreditMemoApplyInvoiceRequestType:
      properties:
        amount:
          description: |
            The credit memo amount to be applied to the invoice.
          format: double
          type: number
        invoiceId:
          description: |
            The unique ID of the invoice that the credit memo is applied to.
          type: string
        items:
          description: >
            Container for items. The maximum number of items is 1,000.


            If `creditMemoItemId` is the source, then it should be accompanied
            by a target `invoiceItemId`.


            If `creditTaxItemId` is the source, then it should be accompanied by
            a target `taxItemId`.
          items:
            $ref: '#/components/schemas/CreditMemoApplyInvoiceItemRequestType'
          type: array
      required:
        - amount
        - invoiceId
      title: invoices
      type: object
    ApplyCreditMemoType:
      example:
        effectiveDate: '2024-08-19'
        invoices:
          - invoiceId: 8ad097b490a1ec740190a5aaece25734
            amount: 11
      properties:
        debitMemos:
          description: >
            Container for debit memos that the credit memo is applied to. The
            maximum number of debit memos is 1,000.
          items:
            $ref: '#/components/schemas/CreditMemoApplyDebitMemoRequestType'
          type: array
        effectiveDate:
          description: |
            The date when the credit memo is applied.
          format: date
          type: string
        invoices:
          description: >
            Container for invoices that the credit memo is applied to. The
            maximum number of invoices is 1,000.
          items:
            $ref: '#/components/schemas/CreditMemoApplyInvoiceRequestType'
          type: array
      type: object
    PostCreditMemoEmailRequestType:
      example:
        useEmailTemplateSetting: true
      properties:
        emailAddresses:
          description: >
            The valid email addresses you want to email a credit memo to. Use
            commas to separate email addresses.


            **Note:** This field is only applicable if you set the
            `useEmailTemplateSetting` field to `false`.
          type: string
        includeAdditionalEmailAddresses:
          default: false
          description: >
            Indicates whether to send a credit memo to the additional email
            addresses of the memo account. 



            You can set the additional email addresses in the **Additional Email
            Addresses** field on the account detail page from the Zuora UI. See
            [Create a Customer
            Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2)
            for more information.
          enum:
            - true
            - false
          type: boolean
        pdfFileId:
          description: >
            The ID of the PDF file that you want to send in the email. 


            If you do not specify any PDF file ID, the latest PDF file generated
            for the credit memo is sent in the email.
          type: string
        useEmailTemplateSetting:
          default: false
          description: >
            Indicates whether to email a credit memo based on the email template
            setting. 


            If you set this field to `true`, the credit memo is sent to the
            email addresses specified in the **To Email** field of the email
            template. The email template is the one you set in the **Delivery
            Options** panel of the **Edit notification** dialog from the Zuora
            UI. See [Edit Email
            Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)
            for more information about how to edit the **To Email** field in the
            email template.
          enum:
            - true
            - false
          type: boolean
      type: object
    CreditMemoFile:
      properties:
        id:
          description: >
            The ID of the credit memo PDF file. This is the ID for the file
            object and different from the file handle ID in the `pdfFileUrl`
            field. To open a file, you have to use the file handle ID.
          type: string
        pdfFileUrl:
          description: >
            The relative URL of the credit memo PDF file.


            You can obtain the absolute URL for downloading the file by adding a
            prefix in the following format: `{environment_base_url}/apps`


            For example,
            `https://apisandbox.zuora.com/apps/v1/files/8a90a24f8e128020018e12cf610903f8`.
          type: string
        versionNumber:
          description: |
            The version number of the credit memo PDF file.
          format: int64
          type: integer
      title: creditMemoFile
      type: object
    GETCreditMemoFilesResponse:
      properties:
        creditMemoFiles:
          description: |
            Container for credit memo PDF files.
          items:
            $ref: '#/components/schemas/CreditMemoFile'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETCreditMemoItemTypewithSuccess:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the credit memo item. For tax-inclusive credit
                memo items, the amount indicates the credit memo item amount
                including tax. For tax-exclusive credit memo items, the amount
                indicates the credit memo item amount excluding tax.
              format: double
              type: number
            amountWithoutTax:
              description: |
                The credit memo item amount excluding tax.
              format: double
              type: number
            appliedAmount:
              description: |
                The applied amount of the credit memo item.
              format: double
              type: number
            appliedToItemId:
              description: >
                The unique ID of the credit memo item that the discount charge
                is applied to.
              type: string
            commitmentId:
              description: |
                The ID of the commitment.
              type: string
            commitmentPeriodId:
              description: |
                The ID of the commitment period.
              type: string
            createdById:
              description: |
                The ID of the Zuora user who created the credit memo item.
              type: string
            createdDate:
              description: >
                The date and time when the credit memo item was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditFromItemId:
              description: |
                The ID of the credit from item.
              type: string
            creditFromItemSource:
              description: |
                The type of the credit from item.
              enum:
                - InvoiceItem
                - CreditMemoItem
              type: string
            description:
              description: >
                The description of the credit memo item.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the credit memo item from revenue
                accounting.



                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            financeInformation:
              description: >
                Container for the finance information related to the credit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  type: string
                deferredRevenueAccountingCodeType:
                  description: >
                    The type of the deferred revenue accounting code, such as
                    Deferred Revenue. 
                  type: string
                nonRevenueWriteOffAccountingCode:
                  description: >
                    Specify the accounting code for the non revenue write off.
                    Available only if `revenueImpacting` = `no`.
                  type: string
                nonRevenueWriteOffAccountingCodeType:
                  description: >
                    Specify the accounting code type for the non revenue write
                    off.
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  type: string
                onAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to an on account
                    in your accounting system.
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  type: string
                recognizedRevenueAccountingCodeType:
                  description: >
                    The type of the recognized revenue accounting code, such as
                    Sales Revenue or Sales Discount. 
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  type: string
                revenueScheduleNumber:
                  description: >
                    Revenue schedule number. The revenue schedule number is
                    always prefixed with "RS", for example, RS-00000001.
                  type: string
              type: object
            id:
              description: |
                The ID of the credit memo item.
              type: string
            invoiceScheduleId:
              description: >
                The ID of the invoice schedule associated with the credit memo
                item. 


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: string
            invoiceScheduleItemId:
              description: >
                The ID of the invoice schedule item associated with the credit
                memo item. The credit memo item is generated during the
                processing of the invoice schedule item.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: string
            numberOfDeliveries:
              description: >
                The number of deliveries dedicated to the Delivery Pricing
                charges. The value might be different, as follows:

                - For the credit memo generated by a bill run, this field has a
                value. 

                - For the credit memo generated from an invoice, this field is
                blank.

                **Note**: This field is available only if you have the Delivery
                Pricing feature enabled.
              type: number
            processingType:
              description: >
                The kind of the charge for the credit memo item. Its possible
                values are `Charge` and `Discount`. 
              type: string
            quantity:
              description: |
                The number of units for the credit memo item.
              format: double
              type: number
            reflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `reflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `reflectDiscountInNetAmount` field to `true`, you must also set
                the `excludeItemBillingFromRevenueAccounting` field to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `reflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration does not support discounts on the preceding charges.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `reflectDiscountInNetAmount` field to
                `true`.
            refundAmount:
              description: |
                The amount of the refund on the credit memo item.
              format: double
              type: number
            revenueImpacting:
              description: >
                Indicates whether this write off operation impacts the revenue.
                If `revenueImpacting` = `Yes`, the deferred revenue accounting
                code will be automatically selected from the associated invoice


                If `revenueImpacting` = `No`, users can select an accounting
                code such as bad-debt expense accounting code for the write off
                operation.
              enum:
                - 'Yes'
                - 'No'
              default: 'Yes'
              type: string
            serviceEndDate:
              description: |
                The service end date of the credit memo item. 
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the credit memo item.
              format: date
              type: string
            sku:
              description: |
                The SKU for the product associated with the credit memo item.
              type: string
            skuName:
              description: |
                The name of the SKU.
              type: string
            shipToContactId:
              description: >
                The ID of the ship-to contact associated with the credit memo
                item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the credit memo
                item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            soldToContactSnapshotId:
              description: >
                The ID of the sold-to contact snapshot associated with the
                credit memo item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            sourceItemId:
              description: >
                The ID of the source item.


                - If the value of the `sourceItemType` field is
                `SubscriptionComponent` , the value of this field is the ID of
                the corresponding rate plan charge.

                - If the value of the `sourceItemType` field is `InvoiceDetail`,
                the value of this field is the ID of the corresponding invoice
                item.

                - If the value of the `sourceItemType` field is
                `ProductRatePlanCharge` , the value of this field is the ID of
                the corresponding product rate plan charge.

                - If the value of the `sourceItemType` field is `OrderLineItem`
                , the value of this field is the ID of the corresponding return
                order line item.
              type: string
            sourceItemType:
              description: >
                The type of the source item.


                - If a credit memo is not created from an invoice or a product
                rate plan charge or a return order line item, the value of this
                field is `SubscriptionComponent`. 

                - If a credit memo is created from an invoice, the value of this
                field is `InvoiceDetail`.

                - If a credit memo is created from a product rate plan charge,
                the value of this field is `ProductRatePlanCharge`.

                - If a credit memo is created from a return order line item, the
                value of this field is `OrderLineItem`.
                             
              enum:
                - SubscriptionComponent
                - InvoiceDetail
                - ProductRatePlanCharge
                - OrderLineItem
              type: string
            subscriptionId:
              description: |
                The ID of the subscription associated with the credit memo item.
              type: string
            taxMode:
              description: >
                The tax mode of the credit memo item, indicating whether the
                amount of the credit memo item includes tax.
              enum:
                - TaxExclusive
                - TaxInclusive
              type: string
            taxationItems:
              description: >
                Container for the taxation items of the credit memo item. 


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `239.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              properties:
                data:
                  description: |
                    List of taxation items.
                  items:
                    $ref: '#/components/schemas/GETCMTaxItemTypeNew'
                  type: array
                nextPage:
                  description: >
                    URL to retrieve the next page of the response if it exists;
                    otherwise absent.
                  format: URL
                  type: string
              type: object
            unappliedAmount:
              description: |
                The unapplied amount of the credit memo item.
              format: double
              type: number
            unitOfMeasure:
              description: |
                The units to measure usage.
              type: string
            unitPrice:
              description: |
                The per-unit price of the credit memo item.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the credit memo item.
              type: string
            updatedDate:
              description: >
                The date and time when the credit memo item was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
      title: items
    GETCreditMemoItemsListType:
      properties:
        items:
          description: |
            Container for credit memo items.
          items:
            $ref: '#/components/schemas/GETCreditMemoItemTypewithSuccess'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETCreditMemoItemType:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the credit memo item. For tax-inclusive credit
                memo items, the amount indicates the credit memo item amount
                including tax. For tax-exclusive credit memo items, the amount
                indicates the credit memo item amount excluding tax.
              format: double
              type: number
            amountWithoutTax:
              description: |
                The credit memo item amount excluding tax.
              format: double
              type: number
            appliedAmount:
              description: |
                The applied amount of the credit memo item.
              format: double
              type: number
            appliedToItemId:
              description: >
                The unique ID of the credit memo item that the discount charge
                is applied to.
              type: string
              nullable: true
            commitmentId:
              description: |
                The ID of the commitment.
              type: string
            commitmentPeriodId:
              description: |
                The ID of the commitment period.
              type: string
            createdById:
              description: |
                The ID of the Zuora user who created the credit memo item.
              type: string
            createdDate:
              description: >
                The date and time when the credit memo item was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditFromItemId:
              description: |
                The ID of the credit from item.
              type: string
            creditFromItemSource:
              description: |
                The type of the credit from item.
              enum:
                - InvoiceItem
                - CreditMemoItem
              type: string
            description:
              description: >
                The description of the credit memo item.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the credit memo item from revenue
                accounting.



                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            financeInformation:
              description: >
                Container for the finance information related to the credit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  type: string
                  nullable: true
                deferredRevenueAccountingCodeType:
                  description: >
                    The type of the deferred revenue accounting code, such as
                    Deferred Revenue.'
                  type: string
                  nullable: true
                nonRevenueWriteOffAccountingCode:
                  description: >
                    Specify the accounting code for the non revenue write off.
                    Available only if `revenueImpacting` = `no`.
                  type: string
                  nullable: true
                nonRevenueWriteOffAccountingCodeType:
                  description: >
                    Specify the accounting code type for the non revenue write
                    off.
                  type: string
                  nullable: true
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  type: string
                  nullable: true
                onAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to an on account
                    in your accounting system.
                  type: string
                  nullable: true
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  type: string
                  nullable: true
                recognizedRevenueAccountingCodeType:
                  description: >
                    The type of the recognized revenue accounting code, such as
                    Sales Revenue or Sales Discount.
                  type: string
                  nullable: true
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  type: string
                revenueScheduleNumber:
                  description: >
                    Revenue schedule number. The revenue schedule number is
                    always prefixed with "RS", for example, RS-00000001.
                  type: string
              type: object
            id:
              description: |
                The ID of the credit memo item.
              type: string
            invoiceScheduleId:
              description: >
                The ID of the invoice schedule associated with the credit memo
                item. 


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: string
            invoiceScheduleItemId:
              description: >
                The ID of the invoice schedule item associated with the credit
                memo item. The credit memo item is generated during the
                processing of the invoice schedule item.


                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
                target="_blank">Billing Schedule</a> feature enabled.
              type: string
            numberOfDeliveries:
              description: >
                The number of deliveries dedicated to the Delivery Pricing
                charges. The value might be different, as follows:

                - For the credit memo generated by a bill run, this field has a
                value. 

                - For the credit memo generated from an invoice, this field is
                blank.

                **Note**: This field is available only if you have the Delivery
                Pricing feature enabled. 
              type: number
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            processingType:
              description: >
                The kind of the charge for the credit memo item. Its possible
                values are `Charge` and `Discount`. 
              type: string
            quantity:
              description: |
                The number of units for the credit memo item.
              format: double
              type: number
            refundAmount:
              description: |
                The amount of the refund on the credit memo item.
              format: double
              type: number
            reflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `reflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `reflectDiscountInNetAmount` field to `true`, you must also set
                the `excludeItemBillingFromRevenueAccounting` field to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `reflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration does not support discounts on the preceding charges.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `reflectDiscountInNetAmount` field to
                `true`.
            revenueImpacting:
              description: >
                Indicates whether this write off operation impacts the revenue.
                If `revenueImpacting` = `Yes`, the deferred revenue accounting
                code will be automatically selected from the associated invoice


                If `revenueImpacting` = `No`, users can select an accounting
                code such as bad-debt expense accounting code for the write off
                operation.
              enum:
                - 'Yes'
                - 'No'
              default: 'Yes'
              type: string
            serviceEndDate:
              description: |
                The service end date of the credit memo item.
              format: date
              type: string
            serviceStartDate:
              description: >
                The service start date of the credit memo item. If the
                associated charge is a one-time fee, this date is the date of
                that charge.
              format: date
              type: string
            sku:
              description: |
                The SKU for the product associated with the credit memo item.
              type: string
            skuName:
              description: |
                The name of the SKU.
              type: string
            shipToContactId:
              description: >
                The ID of the ship-to contact associated with the credit memo
                item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the credit memo
                item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            soldToContactSnapshotId:
              description: >
                The ID of the sold-to contact snapshot associated with the
                credit memo item.


                **Note**: If you have the Flexible Billing Attributes feature
                disabled, the value of this field is `null`.
              type: string
            sourceItemId:
              description: >
                The ID of the source item.


                - If the value of the `sourceItemType` field is
                `SubscriptionComponent` , the value of this field is the ID of
                the corresponding rate plan charge.

                - If the value of the `sourceItemType` field is `InvoiceDetail`,
                the value of this field is the ID of the corresponding invoice
                item.

                - If the value of the `sourceItemType` field is
                `ProductRatePlanCharge` , the value of this field is the ID of
                the corresponding product rate plan charge.

                - If the value of the `sourceItemType` field is `OrderLineItem`
                , the value of this field is the ID of the corresponding return
                order line item.
              type: string
            sourceItemType:
              description: >
                The type of the source item.


                - If a credit memo is not created from an invoice or a product
                rate plan charge or a return order line item,, the value of this
                field is `SubscriptionComponent`.

                - If a credit memo is created from an invoice, the value of this
                field is `InvoiceDetail`.

                - If a credit memo is created from a product rate plan charge,
                the value of this field is `ProductRatePlanCharge`.

                - If a credit memo is created from a return order line item, the
                value of this field is `OrderLineItem`.
              enum:
                - SubscriptionComponent
                - InvoiceDetail
                - ProductRatePlanCharge
                - OrderLineItem
              type: string
            subscriptionId:
              description: |
                The ID of the subscription associated with the credit memo item.
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            taxMode:
              description: >
                The tax mode of the credit memo item, indicating whether the
                amount of the credit memo item includes tax.
              enum:
                - TaxExclusive
                - TaxInclusive
              type: string
            taxationItems:
              description: >
                Container for the taxation items of the credit memo item. 


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `239.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              properties:
                data:
                  description: |
                    List of taxation items.
                  items:
                    $ref: '#/components/schemas/GETCMTaxItemTypeNew'
                  type: array
                nextPage:
                  description: >
                    URL to retrieve the next page of the response if it exists;
                    otherwise absent.
                  format: URL
                  type: string
              type: object
            unappliedAmount:
              description: |
                The unapplied amount of the credit memo item.
              format: double
              type: number
            unitOfMeasure:
              description: |
                The units to measure usage.
              type: string
            unitPrice:
              description: |
                The per-unit price of the credit memo item.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the credit memo item.
              type: string
            updatedDate:
              description: >
                The date and time when the credit memo item was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
    GETCreditMemoPartTypewithSuccess:
      properties:
        amount:
          description: |
            The amount of the credit memo part.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the credit memo part.
          type: string
        createdDate:
          description: >
            The date and time when the credit memo part was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        debitMemoId:
          description: |
            The ID of the debit memo associated with the credit memo part.
          type: string
        id:
          description: |
            The ID of the credit memo part.
          type: string
        invoiceId:
          description: |
            The ID of the invoice associated with the credit memo part.
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the credit memo part.
          type: string
        updatedDate:
          description: >
            The date and time when the credit memo part was last upated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      title: parts
      type: object
    GETCreditMemoPartsCollectionType:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        parts:
          description: |
            Container for credit memo parts.
          items:
            $ref: '#/components/schemas/GETCreditMemoPartTypewithSuccess'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETCreditMemoPartType:
      properties:
        amount:
          description: |
            The amount of the credit memo part.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the credit memo part.
          type: string
        createdDate:
          description: >
            The date and time when the credit memo part was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        debitMemoId:
          description: |
            The ID of the debit memo associated with the credit memo part.
          type: string
        id:
          description: |
            The ID of the credit memo part.
          type: string
        invoiceId:
          description: |
            The ID of the invoice associated with the credit memo part.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        updatedById:
          description: |
            The ID of the Zuora user who last updated the credit memo part.
          type: string
        updatedDate:
          description: >
            The date and time when the credit memo part was last upated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    POSTMemoPdfResponse:
      properties:
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    RefundCreditMemoItemType:
      properties:
        amount:
          description: |
            The amount of the refund on the specific item.
          format: double
          type: number
        creditMemoItemId:
          description: |
            The ID of the credit memo item that is refunded.
          type: string
        creditTaxItemId:
          description: |
            The ID of the credit memo taxation item that is refunded.
          type: string
      required:
        - amount
      title: items
      type: object
    RefundObjectNSFields:
      description: >
        Container for Refund fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the refund's synchronization with NetSuite. Only available
            if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Origin__NS:
          description: >
            Origin of the corresponding object in NetSuite. Only available if
            you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the refund was synchronized with NetSuite. Only available
            if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SynctoNetSuite__NS:
          description: >
            Specifies whether the refund should be synchronized with NetSuite.
            Only available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: refundFieldsNS
      type: object
    RefundObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Refund object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Refund object.
      title: refundFieldsCustom
      type: object
    PostNonRefRefundType:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the refund.
              maxLength: 255
              minLength: 0
              type: string
            customRates:
              description: >
                It contains Home currency and Reporting currency custom rates
                currencies. The maximum number of items is 2 (you can pass the
                Home currency item, Reporting currency item, or both).


                **Note**:
                  
                - This field is available only if you are on the latest Zuora
                API version, or you set the `Zuora-Version` request header to
                `224.0` or a later version.

                - You cannot set the custom rates, if both the **Automatically
                include additional Currency Conversion information in data
                source exports** option and **Fx data** feature are enabled.
              items:
                $ref: '#/components/schemas/CreditMemoFromChargeCustomRatesType'
              maxItems: 2
              type: array
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            gatewayId:
              description: >
                The ID of the gateway instance that processes the refund. This
                field can be specified only for electronic refunds. The ID must
                be a valid gateway instance ID, and this gateway must support
                the specific payment method. 


                If no gateway ID is specified, the default gateway in the
                billing account configuration will be used. If no gateway is
                specified in the billing account, the default gateway of the
                corresponding tenant will be used.
              type: string
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values.
              properties:
                key:
                  description: |
                    The name of a gateway-specific parameter.
                  type: string
                value:
                  description: |
                    The value of the gateway-specific parameter.
                  type: string
              type: object
            items:
              description: >
                Container for credit memo items. The maximum number of items is
                1,000.


                **Note:** This field is only available if you have the [Invoice
                Item
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
                feature enabled. Invoice Item Settlement must be used together
                with other Invoice Settlement features (Unapplied Payments, and
                Credit and Debit memos).  If you wish to enable Invoice
                Settlement, see [Invoice Settlement Enablement and Checklist
                Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
                for more information.
              items:
                $ref: '#/components/schemas/RefundCreditMemoItemType'
              type: array
            methodType:
              description: >
                How an external refund was issued to a customer. This field is
                required for an external refund and must be left empty for an
                electronic refund. You can issue an external refund on a credit
                memo.
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            paymentMethodId:
              description: >
                The ID of the payment method used for the refund. This field is
                required for an electronic refund, and the value must be an
                electronic payment method ID. This field must be left empty for
                an external refund. 
              type: string
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              maxLength: 100
              minLength: 0
              type: string
            refundDate:
              description: >
                The date when the refund takes effect, in `yyyy-mm-dd` format.
                The date of the refund cannot be before the credit memo date.
                Specify this field only for external refunds. Zuora
                automatically generates this field for electronic refunds.
              format: date
              type: string
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              maxLength: 100
              minLength: 0
              type: string
            softDescriptor:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 35
              type: string
            softDescriptorPhone:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 20
              type: string
            totalAmount:
              description: >
                The total amount of the refund. The amount cannot exceed the
                unapplied amount of the associated credit memo. If the original
                credit memo was applied to one or more invoices or debit memos,
                you have to unapply a full or partial credit memo from the
                invoices or debit memos, and then refund the full or partial
                unapplied credit memo to your customers.
              format: double
              type: number
            type:
              description: |
                The type of the refund.
              enum:
                - External
                - Electronic
              type: string
          required:
            - totalAmount
            - type
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
      example:
        type: Electronic
        totalAmount: 10
        paymentMethodId: 8ad084db90a5e73b0190c02783f552fa
    GETRefundCreditMemoType:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with this refund. Zuora
                associates the refund automatically with the account from the
                associated payment.
              type: string
            amount:
              description: |
                The total amount of the refund.
              format: double
              type: number
            cancelledOn:
              description: >
                The date and time when the refund was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the refund.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the refund.
              type: string
            createdDate:
              description: >
                The date and time when the refund was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-06 15:31:10.
              format: date-time
              type: string
            creditMemoId:
              description: |
                The ID of the credit memo that is refunded.
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                  nullable: true
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                  nullable: true
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                  nullable: true
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                  nullable: true
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
                  nullable: true
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the refund.
              type: string
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the refund.
                This message is gateway-dependent.
              type: string
            gatewayResponseCode:
              description: >
                The response code returned from the payment gateway for the
                refund. This code is gateway-dependent.
              type: string
            gatewayState:
              description: |
                The status of the refund in the gateway.
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: |
                The ID of the created refund.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a refund was marked and waiting for batch
                submission to the payment process, in `yyyy-mm-dd hh:mm:ss`
                format.
              format: date-time
              type: string
              nullable: true
            methodType:
              description: |
                How an external refund was issued to a customer.
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            number:
              description: |
                The unique identification number of the refund.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentId:
              description: |
                The ID of the payment associated with the refund.
              type: string
              nullable: true
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the refund.
              type: string
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot, which is a copy of
                the particular payment method used in a transaction.
              type: string
            reasonCode:
              description: |
                A code identifying the reason for the transaction.
              type: string
              nullable: true
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              type: string
            refundDate:
              description: |
                The date when the refund takes effect, in yyyy-mm-dd format.
              format: date
              type: string
            refundTransactionTime:
              description: >
                The date and time when the refund was issued, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
              nullable: true
            settledOn:
              description: >
                The date and time when the refund was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
              nullable: true
            softDescriptor:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            status:
              description: |
                The status of the refund.
              enum:
                - Processed
                - Canceled
                - Error
                - Processing
              type: string
            submittedOn:
              description: >
                The date and time when the refund was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            type:
              description: |
                The type of the refund.
              enum:
                - External
                - Electronic
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the refund.
              type: string
            updatedDate:
              description: >
                The date and time when the refund was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-07 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
    PutReverseCreditMemoType:
      example:
        applyEffectiveDate: '2017-02-20'
        memoDate: '2017-02-20'
      properties:
        applyEffectiveDate:
          description: >
            The date when the to-be-reversed credit memo is applied to the newly
            generated debit memo, in `yyyy-mm-dd` format. The effective date
            must be later than or equal to the memo date.


            The default value is the date when you reverse the credit memo and
            create the debit memo.
          format: date
          type: string
        comment:
          description: >
            Comments about the reversal. The comment is used as the comment of
            the debit memo generated by reversing the specified credit memo.
          maxLength: 255
          minLength: 0
          type: string
        memoDate:
          description: >
            The date when the debit memo is created, in `yyyy-mm-dd` format. The
            memo date must be later than or equal to the credit memo's memo
            date.


            The default value is the date when you reverse the credit memo and
            create the debit memo.
          format: date
          type: string
        reasonCode:
          description: >
            A code identifying the reason for the reversal. The value must be an
            existing reason code or empty. The code is used as the reason code
            of the debit memo generated by reversing the specified credit memo.


            If you do not specify a value, Zuora uses the default reason code
            `Credit memo reversal` for the debit memo.
          type: string
      type: object
    PutReverseCreditMemoResponseType:
      properties:
        creditMemo:
          description: >
            Container for the credit memo that is automatically generated during
            the reversal of the invoice that is related to the credit memo. If
            no related invoice is reversed, the value is null.
          properties:
            id:
              description: The ID of the credit memo.
              type: string
          type: object
        debitMemo:
          description: >
            Container for the debit memo that is automatically generated during
            the credit memo reversal.
          properties:
            id:
              description: The ID of the debit memo.
              type: string
          type: object
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTTaxationItemForCMType:
      allOf:
        - properties:
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            memoItemId:
              description: |
                The ID of the credit memo that the taxation item is created for.
              type: string
            name:
              description: |
                The name of the taxation item.
              type: string
            sourceTaxItemId:
              description: >
                The ID of the taxation item of the invoice, which the credit
                memo is created from. 


                If you want to use this REST API to create taxation items for a
                credit memo created from an invoice, the taxation items of the
                invoice must be created or imported through the SOAP API call.


                **Note:** 
                  - This field is only used if the credit memo is created from an invoice. 
                  - If you do not contain this field in the request body, Zuora will automatically set a value for the `sourceTaxItemId` field based on the tax location code, tax jurisdiction, and tax rate.
              type: string
            taxAmount:
              description: |
                The amount of the tax applied to the credit memo.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific credit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: |
                The date when the tax is applied to the credit memo.
              format: date
              type: string
            taxRate:
              description: |
                The tax rate applied to the credit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the credit memo.
              enum:
                - Percentage
                - FlatFee
              type: string
          required:
            - taxRate
            - jurisdiction
            - name
            - taxRateType
            - taxAmount
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
      title: taxationItems
    POSTTaxationItemListForCMType:
      example:
        taxationItems:
          - name: STATE TAX
            memoItemId: 8ad086fa932a0b5401932e82ab1f1fb3
            jurisdiction: CALIFORNIA
            taxAmount: 0.5
            taxCode: ServiceTaxCode
            taxDate: '2024-11-15'
            taxRate: 0.05
            taxRateType: Percentage
      properties:
        taxationItems:
          description: |
            Container for taxation items.
          items:
            $ref: '#/components/schemas/POSTTaxationItemForCMType'
          type: array
      type: object
    CreditMemoUnapplyDebitMemoItemRequestType:
      properties:
        amount:
          description: |
            The amount that is unapplied from the specific item. 
          format: double
          type: number
        creditMemoItemId:
          description: |
            The ID of the credit memo item.
          type: string
        creditTaxItemId:
          description: |
            The ID of the credit memo taxation item.
          type: string
        debitMemoItemId:
          description: >
            The ID of the debit memo item that the credit memo item is unapplied
            from.
          type: string
        taxItemId:
          description: >
            The ID of the debit memo taxation item that the credit memo taxation
            item is unapplied from.
          type: string
      required:
        - amount
      title: items
      type: object
    CreditMemoUnapplyDebitMemoRequestType:
      properties:
        amount:
          description: |
            The credit memo amount to be unapplied from the debit memo.
          format: double
          type: number
        debitMemoId:
          description: >
            The unique ID of the debit memo that the credit memo is unapplied
            from.
          type: string
        items:
          description: |
            Container for items. The maximum number of items is 1,000.
          items:
            $ref: '#/components/schemas/CreditMemoUnapplyDebitMemoItemRequestType'
          type: array
      required:
        - amount
        - debitMemoId
      title: debitMemos
      type: object
    CreditMemoUnapplyInvoiceItemRequestType:
      properties:
        amount:
          description: |
            The amount that is unapplied from the specific item. 
          format: double
          type: number
        creditMemoItemId:
          description: |
            The ID of the credit memo item.
          type: string
        creditTaxItemId:
          description: |
            The ID of the credit memo taxation item.
          type: string
        invoiceItemId:
          description: >
            The ID of the invoice item that the credit memo item is unapplied
            from.
          type: string
        taxItemId:
          description: >
            The ID of the invoice taxation item that the credit memo taxation
            item is unapplied from.
          type: string
      required:
        - amount
      title: items
      type: object
    CreditMemoUnapplyInvoiceRequestType:
      properties:
        amount:
          description: |
            The credit memo amount to be unapplied from the invoice.
          format: double
          type: number
        invoiceId:
          description: |
            The unique ID of the invoice that the credit memo is unapplied from.
          type: string
        items:
          description: |
            Container for items. The maximum number of items is 1,000.
          items:
            $ref: '#/components/schemas/CreditMemoUnapplyInvoiceItemRequestType'
          type: array
      required:
        - amount
        - invoiceId
      title: invoices
      type: object
    UnapplyCreditMemoType:
      example:
        effectiveDate: '2024-10-30'
        invoices:
          - invoiceId: 8a90acec910816f601910bcf57a62363
            amount: 1
      properties:
        debitMemos:
          description: >
            Container for debit memos that the credit memo is unapplied from.
            The maximum number of debit memos is 1,000.
          items:
            $ref: '#/components/schemas/CreditMemoUnapplyDebitMemoRequestType'
          type: array
        effectiveDate:
          description: |
            The date when the credit memo is unapplied.
          format: date
          type: string
        invoices:
          description: >
            Container for invoices that the credit memo is unapplied from. The
            maximum number of invoices is 1,000.
          items:
            $ref: '#/components/schemas/CreditMemoUnapplyInvoiceRequestType'
          type: array
      type: object
    InvoiceSettlementAsyncJobStatus:
      enum:
        - Pending
        - Processing
        - Processed
        - Error
      type: string
      description: |
        Job status of the Invoice Settlement async job.
    InvoiceSettlementAsyncJobOperationType:
      enum:
        - AsyncCreditMemoApply
        - AsyncCreditMemoUnapply
      type: string
      description: |
        Operation type of the Invoice Settlement async job.
    InvoiceSettlementAsyncJobReferenceType:
      enum:
        - CreditMemo
      type: string
      description: |
        Reference type of the Invoice Settlement async job.
    InvoiceSettlementAsyncJobResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            id:
              description: The ID of the operation job.
              type: string
            status:
              $ref: '#/components/schemas/InvoiceSettlementAsyncJobStatus'
            operationType:
              $ref: '#/components/schemas/InvoiceSettlementAsyncJobOperationType'
            referenceId:
              description: The ID of the business object which is being operated.
              type: string
            referenceType:
              $ref: '#/components/schemas/InvoiceSettlementAsyncJobReferenceType'
            error:
              description: The error message if the operation error out.
              type: string
              nullable: true
          type: object
    AsyncApplyCreditMemoToInvoice:
      properties:
        amount:
          description: |
            The credit memo amount to be applied to the invoice.
          type: number
        invoiceId:
          description: |
            The unique ID of the invoice that the credit memo is applied to.
          type: string
      required:
        - amount
        - invoiceId
      title: AppliedInvoice
      type: object
    AsyncApplyCreditMemoRequest:
      example:
        effectiveDate: '2017-03-02'
        invoices:
          - amount: 1
            invoiceId: 4028905f5a87c0ff015a87d3f8f10043
      properties:
        effectiveDate:
          description: |
            The date when the credit memo is applied.
          format: date
          type: string
        invoices:
          description: >
            Container for invoices that the credit memo is applied to. The
            maximum number of invoices is 1,000.
          items:
            $ref: '#/components/schemas/AsyncApplyCreditMemoToInvoice'
          type: array
      type: object
    AsyncUnapplyCreditMemoToInvoice:
      properties:
        amount:
          description: |
            The credit memo amount to be unapplied from the invoice.
          type: number
        invoiceId:
          description: |
            The unique ID of the invoice that the credit memo is unapplied from.
          type: string
      required:
        - amount
        - invoiceId
      title: UnappliedInvoice
    AsyncUnapplyCreditMemoRequest:
      example:
        effectiveDate: '2017-03-02'
        invoices:
          - amount: 1
            invoiceId: 4028905f5a87c0ff015a87d3f8f10043
      properties:
        effectiveDate:
          description: |
            The date when the credit memo is unapplied.
          format: date
          type: string
        invoices:
          description: >
            Container for invoices that the credit memo is unapplied. The
            maximum number of invoices is 1,000.
          items:
            $ref: '#/components/schemas/AsyncUnapplyCreditMemoToInvoice'
          type: array
      type: object
    DebitMemoObjectNSFields:
      description: >
        Container for Debit Memo fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the debit memo's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the debit memo was synchronized with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: debitMemoFieldsNS
      type: object
    DebitMemoObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Debit Memo object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Debit Memo object.
      title: debitMemoFieldsCustom
      type: object
    GETDebitMemoTypewithSuccess:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account associated with the debit memo.
              type: string
            accountNumber:
              description: >
                The number of the customer account associated with the debit
                memo.
              type: string
            amount:
              description: |
                The total amount of the debit memo.
              format: double
              type: number
            autoPay:
              description: >
                Whether debit memos are automatically picked up for processing
                in the corresponding payment run. 


                By default, debit memos are automatically picked up for
                processing in the corresponding payment run.      
              type: boolean
            balance:
              description: |
                The balance of the debit memo.
              format: double
              type: number
            beAppliedAmount:
              description: |
                The applied amount of the debit memo.
              format: double
              type: number
            billToContactId:
              description: >
                The ID of the bill-to contact associated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
            cancelledById:
              description: |
                The ID of the Zuora user who cancelled the debit memo.
              type: string
              nullable: true
            cancelledOn:
              description: >
                The date and time when the debit memo was cancelled, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the debit memo.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the debit memo.
              type: string
            createdDate:
              description: >
                The date and time when the debit memo was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            currency:
              type: string
              description: >
                The currency of the debit memo.


                **Note:** By default, the currency on a billing document matches
                the default currency set on the associated account. 

                However, Zuora now offers a Multiple Currencies feature to
                support different currencies for billing documents, allowing
                flexibility beyond the account-level currency. 

                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currency</a>.
              nullable: true
            debitMemoDate:
              description: >
                The date when the debit memo takes effect, in `yyyy-mm-dd`
                format. For example, 2017-05-20.
              format: date
              type: string
            dueDate:
              description: >
                The date by which the payment for the debit memo is due, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            einvoiceErrorCode:
              description: >
                The error code returned when the e-invoice file status is
                `Failed`. This code can either be a Zuora-generated error code
                or one returned by a third-party e-invoicing service provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceErrorMessage:
              description: >
                The error message returned when the e-invoice file status is
                `Failed`. This message can either be a Zuora-generated error
                message or one returned by a third-party e-invoicing service
                provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceFileId:
              description: >
                The ID of the e-invoice file generated for the debit memo.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceStatus:
              description: >
                The status of the e-invoice file generation for the debit memo. 


                - If e-invoice file generation succeeds, this field is either
                `Generated` or `Success`, and both the error code and message
                are empty, and the `eInvoiceFileId` field stores the ID of the
                generated e-invoice file.

                - If the responses from tax vendors such as Sovos or Avalara
                are 
                  taking too long, this field becomes `RetrieveTimeOut`. Once the 
                  vendor responds successfully, you can use the 'Resync E-Invoice Status' 
                  action to update the status automatically.  You can view these updates 
                  in System Health telemetry.

                - If a failure occurs during e-invoice file generation, this
                field is `Failed` and an error code and an error message are
                returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields. 

                - If e-invoice file generation conditionally succeeds, this
                field is `ConditionalSuccess` and an error code and an error
                message are returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields.

                - If the e-invoice file has been approved by the tax authority,
                this field is `ApprovedByAuthority`. The next status will be
                either `Success` or `Rejected`.

                - If the e-invoice file has been rejected by the government,
                this field is `Rejected`. You cannot resend this e-invoice; you
                must create a new invoice instead.

                  **Note**: This field is available only if you have the <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                  target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
                  enabled.
              enum:
                - Processing
                - RetrieveTimeOut
                - Generated
                - Success
                - Failed
                - ConditionalSuccess
                - ApprovedByAuthority
                - Rejected
              type: string
              nullable: true
            id:
              description: |
                The unique ID of the debit memo.
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            latestPDFFileId:
              description: |
                The ID of the latest PDF file generated for the debit memo.
              type: string
            number:
              description: |
                The unique identification number of the debit memo.
              type: string
            paymentTerm:
              description: >
                The name of the payment term associated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            postedById:
              description: |
                The ID of the Zuora user who posted the debit memo.
              type: string
              nullable: true
            postedOn:
              description: >
                The date and time when the debit memo was posted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty.
              type: string
            referredCreditMemoId:
              description: |
                The ID of the credit memo from which the debit memo was created.
              type: string
              nullable: true
            referredInvoiceId:
              description: |
                The ID of a referred invoice.
              type: string
              nullable: true
            sequenceSetId:
              description: >
                The ID of the sequence set associated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            communicationProfileId:
              description: >
                The ID of the communication profile associated with the debit
                memo.


                **Note**: This field is available in the request body only if
                you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a>

                feature turned on. The value is `null` in the response body
                without this feature turned on.
              type: string
              nullable: true
            sourceType:
              description: |
                The type of the debit memo source.
              enum:
                - Subscription
                - Standalone
                - Order
                - Consolidation
                - Invoice
                - CreditMemo
              type: string
            status:
              description: |
                The status of the debit memo. 
              enum:
                - Draft
                - Posted
                - Canceled
                - Error
                - PendingForTax
                - Generating
                - CancelInProgress
              type: string
            targetDate:
              description: >
                The target date for the debit memo, in `yyyy-mm-dd` format. For
                example, 2017-07-20.
              format: date
              type: string
              nullable: true
            taxAmount:
              description: |
                The amount of taxation.
              format: double
              type: number
            taxMessage:
              description: >
                The message about the status of tax calculation related to the
                debit memo. If tax calculation fails in one debit memo, this
                field displays the reason for the failure.
              type: string
              nullable: true
            taxStatus:
              description: >
                The status of tax calculation related to the debit memo.


                **Note**: This field is only applicable to tax calculation by
                third-party tax engines. Also, the `Voided` status indicates
                that the tax transaction is successfully canceled on the tax
                vendor's side.  If a tax transaction was successfully committed
                to the third-party tax engine but the invoice failed to post,
                Zuora automatically detects the issue and voids the tax
                transaction on the vendor's side.
              enum:
                - Complete
                - Error
                - UnknownError
                - DuplicateDoc
                - InvalidRequest
                - InvalidResponse
                - TaxEngineError
                - ConcurrentModify
                - InternalServerError
                - TaxCodeTemplateError
                - Voided
              type: string
              nullable: true
            totalTaxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            transferredToAccounting:
              description: >
                Whether the debit memo was transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the debit memo.
              type: string
            updatedDate:
              description: >
                The date and time when the debit memo was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:31:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoObjectNSFields'
        - $ref: '#/components/schemas/DebitMemoObjectCustomFields'
      title: debitmemos
    GETDebitMemoCollectionType:
      properties:
        debitmemos:
          description: |
            Container for debit memos.
          items:
            $ref: '#/components/schemas/GETDebitMemoTypewithSuccess'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    BatchDebitMemoType:
      properties:
        dueDate:
          description: >
            The date by which the payment for the debit memo is due, in
            `yyyy-mm-dd` format.
          format: date
          type: string
        id:
          description: >
            The unique ID or number of the debit memo to be updated. For
            example, 402890555a87d7f5015a892f2ba10057 or or DM00000001.
          type: string
      title: debitMemos
      type: object
    PUTBatchDebitMemosRequest:
      example:
        debitMemos:
          - dueDate: '2017-12-28'
            id: 402890d25f9f083f015f9f28041d0008
          - dueDate: '2017-12-20'
            id: 402890555a87d7f5015a892f2ba10057
      properties:
        debitMemos:
          description: |
            Container for debit memo update details.
          items:
            $ref: '#/components/schemas/BatchDebitMemoType'
          type: array
      type: object
    DebitMemoItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Debit Memo Item object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Debit Memo Item object.
      title: debitMemoItemFieldsCustom
      type: object
    DebitMemoFromChargeDetailType:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the debit memo item.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: double
              type: number
            excludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the debit memo item from revenue accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.            
              type: boolean
            description:
              description: >
                The description of the product rate plan charge.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              maxLength: 255
              minLength: 0
              type: string
            financeInformation:
              description: >
                Container for the finance information related to the product
                rate plan charge associated with the debit memo.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                  nullable: true
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                  nullable: true
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
                  nullable: true
              type: object
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the debit memo is
                created from.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            quantity:
              description: |
                The number of units for the debit memo item.
              format: double
              type: number
            serviceEndDate:
              description: >
                The service end date of the debit memo item. If not specified,
                the effective end date of the corresponding product rate plan
                will be used.
              format: date
              type: string
            serviceStartDate:
              description: >
                The service start date of the debit memo item. If not specified,
                the effective start date of the corresponding product rate plan
                will be used.
              format: date
              type: string
          required:
            - productRatePlanChargeId
          type: object
        - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields'
      title: charges
    DebitMemoFromChargeCustomRatesType:
      allOf:
        - properties:
            currency:
              description: >
                The currency code for either Reporting or Home currency.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            customFxRate:
              description: >
                The Custom FX conversion rate between home currency and
                transactional currency items.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: decimal
              type: number
            rateDate:
              description: >
                The date on which a particular currency rate is fixed or
                obtained on.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: date
              type: string
          required:
            - currency
            - customFxRate
          type: object
        - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields'
      title: customRates
    DebitMemoFromChargeRequest:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with the debit memo.


                **Note**: When creating debit memos from product rate plan
                charges, you must specify `accountNumber`, `accountId`, or both
                in the request body. If both fields are specified, they must
                correspond to the same account.
              type: string
            accountNumber:
              description: >
                The number of the account associated with the debit memo.


                **Note**: When creating debit memos from product rate plan
                charges, you must specify `accountNumber`, `accountId`, or both
                in the request body. If both fields are specified, they must
                correspond to the same account.
              type: string
            autoPay:
              description: >
                Whether debit memos are automatically picked up for processing
                in the corresponding payment run. 


                By default, debit memos are automatically picked up for
                processing in the corresponding payment run.
              type: boolean
            autoPost:
              default: false
              description: >
                Whether to automatically post the debit memo after it is
                created. 


                Setting this field to `true`, you do not need to separately call
                the [Post a debit
                memo](https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo)
                operation to post the debit memo.
              type: boolean
            charges:
              description: >
                Container for product rate plan charges. The maximum number of
                items is 1,000.
              items:
                $ref: '#/components/schemas/DebitMemoFromChargeDetailType'
              maxItems: 1000
              type: array
            comment:
              description: |
                Comments about the debit memo.
              maxLength: 255
              minLength: 0
              type: string
            currency:
              description: >
                The code of a currency as defined in Billing Settings through
                the Zuora UI.


                If you do not specify a currency during debit memo creation, the
                default account currency is applied. The currency that you
                specify in the request must be configured and activated in
                Billing Settings.

                **Note**: This field is available only if you have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currencies</a> feature enabled.
              type: string
            customRates:
              description: >
                It contains Home currency and Reporting currency custom rates
                currencies. The maximum number of items is 2 (you can pass the
                Home currency item or Reporting currency item or both).


                **Note**:
                  
                - The API custom rate feature is permission controlled.

                - You cannot set the custom rates, if both the **Automatically
                include additional Currency Conversion information in data
                source exports** option and **Fx data** feature are enabled.

                - DebitMemo, DebitMemoItem, and DebitMemoItemTax will utilize
                the provided custom Fx rate to convert amounts from the
                transactional currency to the home currency.
              items:
                $ref: '#/components/schemas/DebitMemoFromChargeCustomRatesType'
              maxItems: 2
              type: array
            dueDate:
              description: >
                The date by which the payment for the debit memo is due, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            effectiveDate:
              description: |
                The date when the debit memo takes effect.
              format: date
              type: string
            number:
              type: string
              maxLength: 32
              description: >
                A customized debit memo number with the following format
                requirements:


                - Max length: 32 characters

                - Acceptable characters: a-z,A-Z,0-9,-,_


                The value must be unique in the system, otherwise it may cause
                issues with bill runs and subscriptions.


                If not provided, Zuora will generate a unique number per the
                sequence set on the account level. If the account-level sequence
                set is not specified, the system default sequence set is used.
                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Configure_billing_settings/Billing_document_settings/Configure_prefix_and_numbering_for_billing_documents"
                target="_blank">Configure prefix and numbering for billing
                documents</a>.
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoObjectNSFields'
        - $ref: '#/components/schemas/DebitMemoObjectCustomFields'
      example:
        accountId: 8ad09be48db5aba7018db604776d4854
        charges:
          - amount: 10
            productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38
      title: memos
    GETDebitMemoType:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account associated with the debit memo.
              type: string
            accountNumber:
              description: >
                The number of the customer account associated with the debit
                memo.       
              type: string
            amount:
              description: |
                The total amount of the debit memo.
              format: double
              type: number
            autoPay:
              description: >
                Whether debit memos are automatically picked up for processing
                in the corresponding payment run.


                By default, debit memos are automatically picked up for
                processing in the corresponding payment run.
              type: boolean
            balance:
              description: |
                The balance of the debit memo.
              format: double
              type: number
            beAppliedAmount:
              description: |
                The amount that is applied to the debit memo.
              format: double
              type: number
            billToContactId:
              description: >
                The ID of the bill-to contact associated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
            billToContactSnapshotId:
              description: >
                The ID of the bill-to contact snapshot associated with the debit
                memo.


                The value of this field is `null` if the bill rule [Preserve
                snapshot of bill-to and sold-to contacts when billing documents
                are
                posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted)
                is disabled.
              type: string
            cancelledById:
              description: |
                The ID of the Zuora user who cancelled the debit memo.
              type: string
              nullable: true
            cancelledOn:
              description: >
                The date and time when the debit memo was cancelled, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            currency:
              description: >
                The currency of the debit memo.


                **Note:** By default, the currency on a billing document matches
                the default currency set on the associated account. 

                However, Zuora now offers a Multiple Currencies feature to
                support different currencies for billing documents, allowing
                flexibility beyond the account-level currency. 

                For more information, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                target="_blank">Multiple Currency</a>.
              type: string
              nullable: true
            comment:
              description: |
                Comments about the debit memo.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the debit memo.
              type: string
            createdDate:
              description: >
                The date and time when the debit memo was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            debitMemoDate:
              description: >
                The date when the debit memo takes effect, in `yyyy-mm-dd`
                format. For example, 2017-05-20.
              format: date
              type: string
            dueDate:
              description: >
                The date by which the payment for the debit memo is due, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            einvoiceErrorCode:
              description: >
                The error code returned when the e-invoice file status is
                `Failed`. This code can either be a Zuora-generated error code
                or one returned by a third-party e-invoicing service provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceErrorMessage:
              description: >
                The error message returned when the e-invoice file status is
                `Failed`. This message can either be a Zuora-generated error
                message or one returned by a third-party e-invoicing service
                provider.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceFileId:
              description: >
                The ID of the e-invoice file generated for the debit memo.


                **Note**: This field is available only if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                target="_blank">E-Invoicing</a> feature in **Early Adopter**
                phase enabled.
              type: string
              nullable: true
            einvoiceStatus:
              description: >
                The status of the e-invoice file generation for the debit memo. 


                - If e-invoice file generation succeeds, this field is either
                `Generated` or `Success`, and both the error code and message
                are empty, and the `eInvoiceFileId` field stores the ID of the
                generated e-invoice file.

                - If the responses from tax vendors such as Sovos or Avalara
                are 
                  taking too long, this field becomes `RetrieveTimeOut`. Once the 
                  vendor responds successfully, you can use the 'Resync E-Invoice Status' 
                  action to update the status automatically.  You can view these updates 
                  in System Health telemetry.

                - If a failure occurs during e-invoice file generation, this
                field is `Failed` and an error code and an error message are
                returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields.

                - If e-invoice file generation conditionally succeeds, this
                field is `ConditionalSuccess` and an error code and an error
                message are returned respectively in the `einvoiceErrorCode` and
                `einvoiceErrorMessage` fields.

                - If the e-invoice file has been approved by the tax authority,
                this field is `ApprovedByAuthority`. The next status will be
                either `Success` or `Rejected`.

                - If the e-invoice file has been rejected by the government,
                this field is `Rejected`. You cannot resend this e-invoice; you
                must create a new invoice instead.

                  **Note**: This field is available only if you have the <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
                  target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
                  enabled.
              enum:
                - Processing
                - RetrieveTimeOut
                - Generated
                - Success
                - Failed
                - ConditionalSuccess
                - ApprovedByAuthority
                - Rejected
              type: string
              nullable: true
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the debit memo item from revenue accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: boolean
            id:
              description: |
                The unique ID of the debit memo.
              type: string
            invoiceGroupNumber:
              description: >
                The number of the invoice group associated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
              nullable: true
            latestPDFFileId:
              description: |
                The ID of the latest PDF file generated for the debit memo.
              type: string
            number:
              description: |
                The unique identification number of the debit memo.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentTerm:
              description: >
                The name of the payment term assoicated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
            postedById:
              description: |
                The ID of the Zuora user who posted the debit memo.
              type: string
              nullable: true
            postedOn:
              description: >
                The date and time when the debit memo was posted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty.
              type: string
            referredCreditMemoId:
              description: |
                The ID of the credit memo from which the debit memo was created.
              type: string
            referredInvoiceId:
              description: |
                The ID of a referred invoice.
              type: string
              nullable: true
            sequenceSetId:
              description: >
                The ID of the sequence set associated with the debit memo.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
                             
              type: string
              nullable: true
            communicationProfileId:
              description: >
                The ID of the communication profile associated with the debit
                memo.


                **Note**: This field is available in the request body only if
                you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a>

                feature turned on. The value is `null` in the response body
                without this feature turned on.
              type: string
              nullable: true
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the debit memo.

                The value of this field is `null` if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled.
              type: string
              nullable: true
            soldToContactSnapshotId:
              description: >
                The ID of the sold-to contact snapshot associated with the debit
                memo.

                The value of this field is `null` if you have the <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
                target="_blank">Flexible Billing Attributes</a> feature
                disabled.
              type: string
              nullable: true
            sourceType:
              description: |
                The type of the debit memo source.
              enum:
                - Subscription
                - Standalone
                - Order
                - Consolidation
                - Invoice
                - CreditMemo
              type: string
            status:
              description: |
                The status of the debit memo.
              enum:
                - Draft
                - Posted
                - Canceled
                - Error
                - PendingForTax
                - Generating
                - CancelInProgress
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            targetDate:
              description: >
                The target date for the debit memo, in `yyyy-mm-dd` format. For
                example, 2017-07-20.
              format: date
              type: string
              nullable: true
            taxAmount:
              description: |
                The amount of taxation.
              format: double
              type: number
            taxMessage:
              description: >
                The message about the status of tax calculation related to the
                debit memo. If tax calculation fails in one debit memo, this
                field displays the reason for the failure.
              type: string
              nullable: true
            taxStatus:
              description: >
                The status of tax calculation related to the debit memo.


                **Note**: This field is only applicable to tax calculation by
                third-party tax engines. Also, the `Voided` status indicates
                that the tax transaction is successfully canceled on the tax
                vendor's side.  If a tax transaction was successfully committed
                to the third-party tax engine but the invoice failed to post,
                Zuora automatically detects the issue and voids the tax
                transaction on the vendor's side.
              enum:
                - Complete
                - Error
                - UnknownError
                - DuplicateDoc
                - InvalidRequest
                - InvalidResponse
                - TaxEngineError
                - ConcurrentModify
                - InternalServerError
                - TaxCodeTemplateError
                - Voided
              type: string
              nullable: true
            totalTaxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            transferredToAccounting:
              description: >
                Whether the debit memo was transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite.
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the debit memo.
              type: string
            updatedDate:
              description: >
                The date and time when the debit memo was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoObjectNSFields'
        - $ref: '#/components/schemas/DebitMemoObjectCustomFields'
      title: memos
    DebitTaxationItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Debit Taxation Item object. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Debit Taxation Item object.
      title: debitTaxationItemFieldsCustom
      type: object
    PutDebitMemoTaxItemType:
      allOf:
        - properties:
            amount:
              description: |
                The amount of the taxation item in the debit memo item.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item in the debit memo item.
              properties:
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            id:
              description: |
                The ID of the taxation item in the debit memo item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific debit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: >
                The date that the tax is applied to the debit memo, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            taxExemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            taxName:
              description: |
                The name of taxation.
              type: string
            taxRate:
              description: |
                The tax rate applied to the debit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the debit memo.
              enum:
                - Percentage
                - FlatFee
              type: string
          required:
            - id
          type: object
        - $ref: '#/components/schemas/DebitTaxationItemObjectCustomFields'
      title: taxItems
    PUTDebitMemoItemType:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the debit memo item. For tax-inclusive debit memo
                items, the amount indicates the debit memo item amount including
                tax. For tax-exclusive debit memo items, the amount indicates
                the debit memo item amount excluding tax.
              format: double
              type: number
            comment:
              description: |
                Comments about the debit memo item.
              type: string
            delete:
              description: >
                Whether to delete the existing debit memo item.



                **Note**: To delete a debit memo item, set this field to `true`
                and specify a debit memo item ID in the `id` field.
              type: boolean
            excludeItemBillingFromRevenueAccounting:
              default: false
              description: >
                The flag to exclude the debit memo item from revenue accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled.            
              type: boolean
            financeInformation:
              description: >
                Container for the finance information related to the debit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            id:
              description: >
                The ID of the debit memo item.

                - Specify this field when updating or deleting an existing memo
                item. 

                - Do not specify this field when creating a memo item.
              maxLength: 32
              minLength: 32
              type: string
            productRatePlanChargeId:
              description: >
                The ID of the product rate plan charge that the debit memo is
                created from.



                **Note**: Do not specify the debit memo item `id` when
                specifying this field.
              type: string
            quantity:
              description: |
                The number of units for the debit memo item.
              format: double
              type: number
            serviceEndDate:
              description: |
                The service end date of the debit memo item.
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the debit memo item. 
              format: date
              type: string
            skuName:
              description: |
                The name of the SKU.
              type: string
            taxItems:
              description: |
                Container for debit memo taxation items.
              items:
                $ref: '#/components/schemas/PutDebitMemoTaxItemType'
              type: array
            unitOfMeasure:
              description: |
                The definable unit that you measure when determining charges.
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields'
      title: items
    PUTDebitMemoType:
      allOf:
        - properties:
            autoPay:
              description: >
                Whether debit memos are automatically picked up for processing
                in the corresponding payment run. 


                By default, debit memos are automatically picked up for
                processing in the corresponding payment run.
              type: boolean
            comment:
              description: |
                Comments about the debit memo.
              maxLength: 255
              minLength: 0
              type: string
            dueDate:
              description: >
                The date by which the payment for the debit memo is due, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            effectiveDate:
              description: |
                The date when the debit memo takes effect.
              format: date
              type: string
            items:
              description: |
                Container for debit memo items.
              items:
                $ref: '#/components/schemas/PUTDebitMemoItemType'
              type: array
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code
              type: string
            transferredToAccounting:
              description: >
                Whether the debit memo is transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoObjectNSFields'
        - $ref: '#/components/schemas/DebitMemoObjectCustomFields'
      example:
        comment: Details about this Debit Memo
    PUTDebitMemoWithIdType:
      allOf:
        - properties:
            id:
              description: |
                The ID of the debit memo.
              type: string
          type: object
        - $ref: '#/components/schemas/PUTDebitMemoType'
    PUTBulkDebitMemosRequestType:
      allOf:
        - properties:
            memos:
              description: >
                The container for a list of debit memos. The maximum number of
                debit memos is 50.
              items:
                $ref: '#/components/schemas/PUTDebitMemoWithIdType'
              maxItems: 50
              title: memos
              type: array
          type: object
      example:
        memos:
          - autoPay: true
            comment: new comment
            dueDate: '2017-05-20'
            effectiveDate: '2017-04-17'
            id: 4028905f5a890526015a8db30954007a
            items:
              - amount: 1
                comment: This is comment!
                id: 402890555b797b57015b7986fc1a001c
                quantity: 1
                serviceEndDate: '2016-11-30'
                serviceStartDate: '2016-11-01'
                skuName: SKU-1
                taxItems:
                  - amount: 0.03
                    id: 402890555b797b57015b7986fc3c001d
                    jurisdiction: CALIFORNIA
                    locationCode: '06'
                    taxCode: null
                    taxCodeDescription: This is tax code description!
                    taxDate: '2016-11-30'
                    taxExemptAmount: 0
                    taxName: STATE TAX1
                    taxRate: 0.0625
                    taxRateDescription: This is tax rate description!
                    taxRateType: Percentage
                unitOfMeasure: Test_UOM
              - amount: 2
                comment: This is comment!
                id: 402890555b797b57015b7986fc41001e
                serviceEndDate: '2016-11-30'
                serviceStartDate: '2016-11-01'
                skuName: SKU-2
                taxItems:
                  - amount: 0.06
                    id: 402890555b797b57015b7986fc4c001f
                    jurisdiction: CALIFORNIA
                    locationCode: '06'
                    taxCode: null
                    taxCodeDescription: This is tax code description!
                    taxDate: '2016-11-30'
                    taxExemptAmount: 0
                    taxName: STATE TAX2
                    taxRate: 0.0625
                    taxRateDescription: This is tax rate description!
                    taxRateType: Percentage
                unitOfMeasure: Test_UOM
            reasonCode: Correcting invoice error
    BulkDebitMemosResponseType:
      allOf:
        - properties:
            memos:
              description: |
                The container for a list of debit memos.
              items:
                $ref: '#/components/schemas/GETDebitMemoType'
              maxItems: 50
              type: array
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
          type: object
    DebitMemoTaxItemFromInvoiceTaxItemType:
      properties:
        amount:
          description: |
            The amount of the debit memo taxation item.
          format: double
          type: number
        financeInformation:
          description: >
            Container for the finance information related to the source taxation
            item.
          properties:
            salesTaxPayableAccountingCode:
              description: |
                The accounting code for the sales taxes payable.
              maxLength: 100
              minLength: 0
              type: string
          type: object
        jurisdiction:
          description: >
            The jurisdiction that applies the tax or VAT. This value is
            typically a state, province, county, or city.
          type: string
        locationCode:
          description: >
            The identifier for the location based on the value of the `taxCode`
            field.
          type: string
        sourceTaxItemId:
          description: |
            The ID of the source taxation item.
          type: string
        taxCode:
          description: >
            The tax code identifies which tax rules and tax rates to apply to a
            specific debit memo.
          type: string
        taxCodeDescription:
          description: |
            The description of the tax code.
          type: string
        taxDate:
          description: >
            The date that the tax is applied to the debit memo, in `yyyy-mm-dd`
            format.
          format: date
          type: string
        taxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        taxName:
          description: |
            The name of taxation.
          type: string
        taxRate:
          description: |
            The tax rate applied to the debit memo.
          format: double
          type: number
        taxRateDescription:
          description: |
            The description of the tax rate.
          type: string
        taxRateType:
          description: |
            The type of the tax rate applied to the debit memo.
          enum:
            - Percentage
            - FlatFee
          type: string
      required:
        - amount
      title: taxItems
      type: object
    DebitMemoItemFromInvoiceItemType:
      allOf:
        - properties:
            amount:
              description: |
                The amount of the debit memo item.
              format: double
              type: number
            description:
              description: >
                The description of the debit memo item.

                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `257.0` or a later available version.
              type: string
            financeInformation:
              description: >
                Container for the finance information related to the debit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  maxLength: 100
                  minLength: 0
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  maxLength: 100
                  minLength: 0
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            invoiceItemId:
              description: |
                The ID of the invoice item.
              type: string
            quantity:
              description: |
                The number of units for the debit memo item.
              format: double
              type: number
            serviceEndDate:
              description: |
                The service end date of the debit memo item.
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the debit memo item. 
              format: date
              type: string
            skuName:
              description: |
                The name of the charge associated with the invoice.
              type: string
            taxItems:
              description: |
                Container for taxation items.
              items:
                $ref: '#/components/schemas/DebitMemoTaxItemFromInvoiceTaxItemType'
              type: array
            taxMode:
              default: TaxExclusive
              description: >
                The tax mode of the debit memo item, indicating whether the
                amount of the debit memo item includes tax.


                **Note**: You can set this field to `TaxInclusive` only if the
                `taxAutoCalculation` field is set to `true`.


                If you set `taxMode` to `TaxInclusive`, you cannot input tax
                amounts for debit memo items. The corresponding invoice item
                must use the same tax engine as the debit memo item to calculate
                tax amounts.
              enum:
                - TaxExclusive
                - TaxInclusive
              type: string
            unitOfMeasure:
              description: |
                The definable unit that you measure when determining charges.
              type: string
          required:
            - skuName
            - amount
          type: object
        - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields'
      title: items
    DebitMemoFromInvoiceRequest:
      allOf:
        - properties:
            autoPay:
              description: >
                Whether debit memos are automatically picked up for processing
                in the corresponding payment run. 

                By default, debit memos are automatically picked up for
                processing in the corresponding payment run.
              type: boolean
            autoPost:
              default: false
              description: >
                Whether to automatically post the debit memo after it is
                created. 

                Setting this field to `true`, you do not need to separately call
                the [Post debit
                memo](https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo)
                operation to post the debit memo.
              type: boolean
            billToContactId:
              description: >
                The ID of the bill-to contact associated with the debit memo.



                **Note**: This field is available only if you have <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Flexible_Billing_Attributes/A_Overview_of_Flexible_Billing_Attributes"
                target="_blank">Flexible Billing Attributes</a> enabled for your
                tenant.
              type: string
            comment:
              description: |
                Comments about the debit memo. 
              maxLength: 255
              minLength: 0
              type: string
            effectiveDate:
              description: |
                The date when the debit memo takes effect.
              format: date
              type: string
            invoiceId:
              description: |
                The ID of the invoice that the debit memo is created from.
              type: string
            items:
              description: |
                Container for items. The maximum number of items is 1,000.
              items:
                $ref: '#/components/schemas/DebitMemoItemFromInvoiceItemType'
              maxItems: 1000
              type: array
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the debit memo.



                **Note**: This field is available only if you have <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Flexible_Billing_Attributes/A_Overview_of_Flexible_Billing_Attributes"
                target="_blank"> Flexible Billing Attributes</a> enabled for
                your tenant.
              type: string
            soldToSameAsBillTo:
              description: >
                Whether the sold-to contact and bill-to contact are the same
                entity.


                The created debit memo has the same bill-to contact and sold-to
                contact entity only when all the following conditions are met in
                the request body:


                - This field is set to `true`.

                - The `billToContactId` field is specified.

                - The `soldToContactId` field is not specified.
              type: boolean
            taxAutoCalculation:
              default: true
              description: |
                Whether to automatically calculate taxes in the debit memo.
              type: boolean
          type: object
          required:
            - invoiceId
        - $ref: '#/components/schemas/DebitMemoObjectNSFields'
        - $ref: '#/components/schemas/DebitMemoObjectCustomFields'
      example:
        invoiceId: 8a90cc5c9301541f01930186636b1400
        effectiveDate: '2024-11-11'
        items:
          - amount: 10
            invoiceItemId: 8a90cc5c9301541f0193018663aa1413
            skuName: SKU-00000591
        reasonCode: Correcting invoice error
      title: memos
    BulkCreateDebitMemosFromInvoiceRequest:
      properties:
        sourceType:
          type: string
          enum:
            - Invoice
          description: >
            The type of the source where debit memos are created. 
                
            This enum field has the following values:
              - `Invoice`: By setting this field to `Invoice`, you can create multiple debit memos from invoices.
              - `Standalone`: By setting this field to `Standalone`, you can create multiple debit memos from product rate plan charges.
              
            The specific schema of the `memos` object field in the request body
            depends on the value of the `sourceType` field.
              - To view the `memos` schema applicable to debit memo creation from invoices, select `Invoice` from the following drop-down list.
              - To view the `memos` schema applicable to debit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.
        memos:
          description: >
            The container for a list of debit memos. The maximum number of debit
            memos is 50.
          items:
            $ref: '#/components/schemas/DebitMemoFromInvoiceRequest'
          maxItems: 50
          type: array
      required:
        - sourceType
      type: object
    BulkCreateDebitMemosFromChargeRequest:
      properties:
        sourceType:
          type: string
          enum:
            - Standalone
          description: >
            The type of the source where debit memos are created. 
                
            This enum field has the following values:
              - `Invoice`: By setting this field to `Invoice`, you can create multiple debit memos from invoices.
              - `Standalone`: By setting this field to `Standalone`, you can create multiple debit memos from product rate plan charges.
              
            The specific schema of the `memos` object field in the request body
            depends on the value of the `sourceType` field.
              - To view the `memos` schema applicable to debit memo creation from invoices, select `Invoice` from the following drop-down list.
              - To view the `memos` schema applicable to debit memo creation from product rate plan charges, select `Standalone` from the following drop-down list.
              
        memos:
          description: >
            The container for a list of debit memos. The maximum number of debit
            memos is 50.
          items:
            $ref: '#/components/schemas/DebitMemoFromChargeRequest'
          maxItems: 50
          type: array
      required:
        - sourceType
      type: object
    POSTBulkDebitMemosRequestType:
      discriminator:
        propertyName: sourceType
        mapping:
          Invoice: '#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest'
          Standalone: '#/components/schemas/BulkCreateDebitMemosFromChargeRequest'
      oneOf:
        - $ref: '#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest'
        - $ref: '#/components/schemas/BulkCreateDebitMemosFromChargeRequest'
    GetDebitMemoPdfStatusResponse:
      allOf:
        - properties:
            debitMemoId:
              description: |
                The ID of the debit memo whose pdf status is requested.
              type: string
            debitMemoNumber:
              description: >
                The debit memo number of the debit memo whose pdf status is
                requested.
              type: string
            pdfGenerationStatus:
              description: |
                The generation status of the debit memo PDF.
              type: string
              enum:
                - None
                - Pending
                - Processing
                - Generated
                - Error
                - Obsolete
            createdOn:
              description: |
                The time at which the request to generate the PDF was created.
              type: string
            updatedOn:
              description: |
                The time at which the request to generate the PDF was updated.
              type: string
            pdfFileURL:
              description: >
                The file path or the URL of the PDF when the status is
                `Generated`.  
              type: string
            errorCategory:
              description: |
                The error category when the status is `Error`. 
              type: string
            errorMessage:
              description: |
                The error message when the status is `Error`. 
              type: string
          type: object
    GetDebitMemoPdfStatusBatchResponse:
      description: ''
      example:
        debitMemoFiles:
          - debitMemoId: 402824aa8cc894d5018cc8a120576881
            debitMemoNumber: DM00000003
            pdfGenerationStatus: Generated
            createdOn: '2024-01-01 11:32:19'
            updatedOn: '2024-01-01 11:32:19'
            pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
          - debitMemoId: 2c98908a904dfc2601904e6e14090241
            debitMemoNumber: DM00000004
            pdfGenerationStatus: Error
            createdOn: '2024-01-02 10:14:13'
            updatedOn: '2024-01-02 10:14:13'
            errorCode: INVALID_TEMPLATE
            errorMessage: Unknown merge filed chargeNumber__c
          - debitMemoId: 402824aa8cc894d5018cc8a120576881
            debitMemoNumber: DM00000005
            pdfGenerationStatus: Pending
            createdOn: '2024-01-01 11:35:56'
            updatedOn: '2024-01-01 11:35:56'
        success: true
      properties:
        debitMemoFiles:
          description: |
            Array of debit memo PDF statuses requested.
          items:
            $ref: '#/components/schemas/GetDebitMemoPdfStatusResponse'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
      title: debitMemoFiles
    GetDebitMemoApplicationPartType:
      properties:
        appliedAmount:
          description: |
            The amount that is applied to the debit memo.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the payment or credit memo.
          format: uuid
          type: string
        createdDate:
          description: >
            The date and time when the payment or credit memo was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-12-01 15:31:10.
          format: date-time
          type: string
        creditMemoId:
          description: |
            The ID of credit memo that is applied to the specified debit memo.
          format: uuid
          type: string
        paymentId:
          description: |
            The ID of the payment that is applied to the specified debit memo.
          format: uuid
          type: string
        updatedById:
          description: >
            The ID of the Zuora user who last updated the payment or credit
            memo.
          format: uuid
          type: string
        updatedDate:
          description: >
            The date and time when the payment or credit memo was last updated,
            in `yyyy-mm-dd hh:mm:ss` format. For example, 2018-01-02 11:42:16.
          format: date-time
          type: string
      title: applicationParts
      type: object
    GetDebitMemoApplicationPartCollectionType:
      properties:
        applicationParts:
          description: |
            Container for application parts.
          items:
            $ref: '#/components/schemas/GetDebitMemoApplicationPartType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETDMTaxItemTypeNew:
      allOf:
        - properties:
            balance:
              description: |
                The balance of the taxation item.
              format: double
              type: number
            creditAmount:
              description: |
                The amount of credit memos applied to the debit memo. 
              format: double
              type: number
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  type: string
                salesTaxPayableAccountingCodeType:
                  description: |
                    The type of the accounting code for the sales taxes payable.
                  type: string
              type: object
            id:
              description: |
                The ID of the taxation item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            name:
              description: |
                The name of the taxation item.
              type: string
            paymentAmount:
              description: |
                The amount of payments applied to the debit memo. 
              format: double
              type: number
            sourceTaxItemId:
              description: |
                The ID of the source taxation item.
              type: string
            taxAmount:
              description: |
                The amount of taxation.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific debit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: >
                The date that the tax is applied to the debit memo, in
                `yyyy-mm-dd` format.
              format: date
              type: string
            taxRate:
              description: |
                The tax rate applied to the debit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate.
              enum:
                - Percentage
                - FlatFee
              type: string
          type: object
        - $ref: '#/components/schemas/DebitTaxationItemObjectCustomFields'
      title: data
    GETTaxationItemsOfDebitMemoItemType:
      allOf:
        - properties:
            data:
              description: |
                Container for the taxation items of the debit memo item.
              items:
                $ref: '#/components/schemas/GETDMTaxItemTypeNew'
              type: array
            nextPage:
              description: >
                URL to retrieve the next page of the response if it exists;
                otherwise absent.
              format: URL
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
          type: object
    DebitMemoCollectRequest:
      example:
        collect: true
        applyCredit: true
      properties:
        applicationOrder:
          description: >
            The priority order to apply credit memos and/or unapplied payments
            to the debit memo. Possible item values are: `CreditMemo`,
            `UnappliedPayment`.


            **Note:**
              - This field is valid only if the `applyCredit` field is set to `true`.
              - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments.
              - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply the debit memo.
          items:
            type: string
          type: array
        applyCredit:
          default: false
          description: >
            Whether to automatically apply credit memos or unapplied payments,
            or both to the debit memo.

            If the value is `true`, the credit memo or unapplied payment, or
            both will be automatically applied to the debit memo. If no value is
            specified or the value is `false`, no action is taken.
          type: boolean
        collect:
          default: false
          description: |
            Indicates if the current request needs to collect payment or not.
          type: boolean
        payment:
          description: >
            Some detail info that would be used to processed an electronic
            payment.

            The info would only effect when `collect` set to `true`.
          properties:
            gatewayId:
              description: >
                The ID of the gateway instance that processes the payment. The
                ID must be a valid gateway instance ID and this gateway must
                support the specific payment method.

                If no gateway ID is specified in the request body, the default
                gateway for the customer account is used automatically, if this
                default one is not configured, the default gateway of the tenant
                would be used.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the payment.

                If no payment method ID is specified in the request body, the
                default payment method for the customer account is used
                automatically. If the default payment method is different from
                the type of payments that you want to create, an error occurs.
              type: string
          type: object
      type: object
    DebitMemoCollectResponseAppliedCreditMemos:
      allOf:
        - properties:
            appliedAmount:
              description: |
                The applied amount of the credit memo to the debit memo.
              format: double
              type: number
            id:
              description: |
                The unique ID of the credit memo.
              type: string
            number:
              description: |
                The unique identification number of the credit memo.
              type: string
            unappliedAmount:
              description: >
                The unapplied amount of the credit memo after applied to the
                debit memo.
              format: double
              type: number
          type: object
    DebitMemoCollectResponseAppliedPayments:
      allOf:
        - properties:
            appliedAmount:
              description: |
                The applied amount of the payment to the debit memo.
              format: double
              type: number
            id:
              description: |
                The unique ID of the payment.
              type: string
            number:
              description: |
                The unique identification number of the payment.
              type: string
            unappliedAmount:
              description: >
                The unapplied amount of the payment after applied to the debit
                memo.
              format: double
              type: number
          type: object
    DebitMemoCollectResponse:
      allOf:
        - properties:
            appliedCreditMemos:
              description: >
                The information about which credit memo applied to the specific
                debit memo.
              items:
                $ref: >-
                  #/components/schemas/DebitMemoCollectResponseAppliedCreditMemos
              type: array
            appliedPayments:
              description: >
                The information about which payment applied to the specific
                debit memo.
              items:
                $ref: '#/components/schemas/DebitMemoCollectResponseAppliedPayments'
              type: array
            debitMemo:
              description: |
                The information about the debit memo that just collected.
              properties:
                id:
                  description: |
                    The unique ID of the debit memo.
                  type: string
                number:
                  description: |
                    The unique identification number of the debit memo.
                  type: string
              type: object
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            processedPayment:
              description: >
                The information about the payment that newly processed to the
                debit memo.
              properties:
                amount:
                  description: |
                    The total amount of the payment.
                  format: double
                  type: number
                gatewayId:
                  description: |
                    The ID of the gateway instance that processes the payment.
                  type: string
                gatewayResponse:
                  description: >
                    The message returned from the payment gateway for the
                    payment. This message is gateway-dependent.
                  type: string
                gatewayResponseCode:
                  description: >
                    The code returned from the payment gateway for the payment.
                    This code is gateway-dependent.
                  type: string
                id:
                  description: >
                    The unique ID of the created payment. For example,
                    4028905f5a87c0ff015a87eb6b75007f.
                  type: string
                number:
                  description: >
                    The unique identification number of the payment. For
                    example, P-00000001.
                  type: string
                paymentMethodId:
                  description: >
                    The unique ID of the payment method that the customer used
                    to make the payment.
                  type: string
                status:
                  description: |
                    The status of the payment.
                  enum:
                    - Processing
                    - Processed
                    - Error
                    - Canceled
                  type: string
              type: object
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
          type: object
    PostDebitMemoEmailType:
      example:
        useEmailTemplateSetting: true
      properties:
        emailAddresses:
          description: >
            The valid email addresses you want to email a debit memo to. Use
            commas to separate email addresses.


            **Note:** This field is only applicable if you set the
            `useEmailTemplateSetting` field to `false`.
          type: string
        includeAdditionalEmailAddresses:
          default: false
          description: >
            Indicates whether to send a debit memo to the additional email
            addresses of the memo account. 



            You can set the additional email addresses in the **Additional Email
            Addresses** field on the account detail page from the Zuora UI. See
            [Create a Customer
            Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2)
            for more information.
          enum:
            - true
            - false
          type: boolean
        pdfFileId:
          description: >
            The ID of the PDF file that you want to send in the email. 


            If you do not specify any PDF file ID, the latest PDF file generated
            for the debit memo is sent in the email.
          type: string
        useEmailTemplateSetting:
          default: false
          description: >
            Indicates whether to email a debit memo based on the email template
            setting. 


            If you set this field to `true`, the debit memo is sent to the email
            addresses specified in the **To Email** field of the email template.
            The email template is the one you set in the **Delivery Options**
            panel of the **Edit notification** dialog from the Zuora UI. See
            [Edit Email
            Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)
            for more information about how to edit the **To Email** field in the
            email template.
          enum:
            - true
            - false
          type: boolean
      type: object
    DebitMemoFile:
      properties:
        id:
          description: >
            The ID of the debit memo PDF file. This is the ID for the file
            object and different from the file handle ID in the `pdfFileUrl`
            field. To open a file, you have to use the file handle ID.
          type: string
        pdfFileUrl:
          description: >
            The relative URL of the debit memo PDF file.


            You can obtain the absolute URL for downloading the file by adding a
            prefix in the following format: `{environment_base_url}/apps`


            For example,
            `https://apisandbox.zuora.com/apps/v1/files/2c98901f62d7d83d0162d7facea6262d`.
          type: string
        versionNumber:
          description: |
            The version number of the debit memo PDF file.
          format: int64
          type: integer
      title: debitMemoFile
      type: object
    GETDebitMemoFilesResponse:
      properties:
        debitMemoFiles:
          description: |
            Container for debit memo PDF files.
          items:
            $ref: '#/components/schemas/DebitMemoFile'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETDebitMemoItemTypewithSuccess:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the debit memo item. For tax-inclusive debit memo
                items, the amount indicates the debit memo item amount including
                tax. For tax-exclusive debit memo items, the amount indicates
                the debit memo item amount excluding tax.
              format: double
              type: number
            amountWithoutTax:
              description: |
                The debit memo item amount excluding tax.
              format: double
              type: number
            appliedToItemId:
              description: >
                The parent debit memo item that this debit memo items is applied
                to if this item is discount.
              type: string
            balance:
              description: |
                The balance of the debit memo item.
              format: double
              type: number
            beAppliedAmount:
              description: |
                The applied amount of the debit memo item.
              format: double
              type: number
            createdById:
              description: |
                The ID of the Zuora user who created the debit memo item.
              type: string
            createdDate:
              description: >
                The date and time when the debit memo item was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            description:
              description: >
                The description of the debit memo item.


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the debit memo item from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            financeInformation:
              description: >
                Container for the finance information related to the debit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  type: string
                deferredRevenueAccountingCodeType:
                  description: >
                    The type of the deferred revenue accounting code, such as
                    Deferred Revenue.
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  type: string
                recognizedRevenueAccountingCodeType:
                  description: >
                    The type of the recognized revenue accounting code, such as
                    Sales Revenue or Sales Discount.
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  type: string
                revenueScheduleNumber:
                  description: >
                    The revenue schedule number. The revenue schedule number is
                    always prefixed with "RS", for example, RS-00000001.
                  type: string
              type: object
            id:
              description: |
                The ID of the debit memo item.
              type: string
            processingType:
              description: >
                The kind of the charge for the debit memo item. Its possible
                values are `Charge` and `Discount`. 
              type: string
            quantity:
              description: |
                The number of units for the debit memo item.
              format: double
              type: number
            reflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `reflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `reflectDiscountInNetAmount` field to `true`, you must also set
                the `excludeItemBillingFromRevenueAccounting` field to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `reflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration does not support discounts on the preceding charges.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `reflectDiscountInNetAmount` field to
                `true`.
            serviceEndDate:
              description: >
                The end date of the service period associated with this debit
                memo item. Service ends one second before the date specified in
                this field.
              format: date
              type: string
            serviceStartDate:
              description: >
                The start date of the service period associated with this debit
                memo item. If the associated charge is a one-time fee, this date
                is the date of that charge.
              format: date
              type: string
            sku:
              description: |
                The SKU for the product associated with the debit memo item.
              type: string
            skuName:
              description: |
                The name of the SKU.
              type: string
            shipToContactId:
              description: >
                The ID of the ship-to contact associated with the invoice item.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the invoice item.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
            soldToContactSnapshotId:
              description: >
                The ID of the sold-to contact snapshot associated with the
                invoice item.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.               
              type: string
            sourceItemId:
              description: |
                The ID of the source item.
              type: string
            sourceItemType:
              description: |
                The type of the source item.
              enum:
                - CreditMemoItem
                - SubscriptionComponent
                - InvoiceDetail
                - ProductRatePlanCharge
              type: string
            subscriptionId:
              description: |
                The ID of the subscription associated with the debit memo item.
              type: string
            taxMode:
              description: >
                The tax mode of the debit memo item, indicating whether the
                amount of the debit memo item includes tax.
              enum:
                - TaxExclusive
                - TaxInclusive
              type: string
            taxationItems:
              description: >
                Container for the taxation items of the debit memo item. 


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `239.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              properties:
                data:
                  description: |
                    List of taxation items.
                  items:
                    $ref: '#/components/schemas/GETDMTaxItemTypeNew'
                  type: array
                nextPage:
                  description: >
                    URL to retrieve the next page of the response if it exists;
                    otherwise absent.
                  format: URL
                  type: string
              type: object
            unitOfMeasure:
              description: |
                The units to measure usage.
              type: string
            unitPrice:
              description: |
                The per-unit price of the debit memo item.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the debit memo item.
              type: string
            updatedDate:
              description: >
                The date and time when the debit memo item was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields'
      title: items
    GETDebitMemoItemCollectionType:
      properties:
        items:
          description: |
            Container for debit memo items.
          items:
            $ref: '#/components/schemas/GETDebitMemoItemTypewithSuccess'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETDebitMemoItemType:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the debit memo item. For tax-inclusive debit memo
                items, the amount indicates the debit memo item amount including
                tax. For tax-exclusive debit memo items, the amount indicates
                the debit memo item amount excluding tax.
              format: double
              type: number
            amountWithoutTax:
              description: |
                The debit memo item amount excluding tax.
              format: double
              type: number
            appliedToItemId:
              description: >
                The parent debit memo item that this debit memo items is applied
                to if this item is discount.
              type: string
            balance:
              description: |
                The balance of the debit memo item.
              format: double
              type: number
            beAppliedAmount:
              description: |
                The applied amount of the debit memo item.
              format: double
              type: number
            createdById:
              description: |
                The ID of the Zuora user who created the debit memo item.
              type: string
            createdDate:
              description: >
                The date and time when the debit memo item was created, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            description:
              description: >
                Description about the debit memo item.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `257.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the debit memo item from revenue accounting.


                **Note**: This field is only available if you have the Order to
                Revenue or Billing - Revenue Integration feature enabled. 
              type: boolean
            financeInformation:
              description: >
                Container for the finance information related to the debit memo
                item.
              properties:
                deferredRevenueAccountingCode:
                  description: >
                    The accounting code for the deferred revenue, such as
                    Monthly Recurring Liability.
                  type: string
                deferredRevenueAccountingCodeType:
                  description: >
                    The type of the deferred revenue accounting code, such as
                    Deferred Revenue.
                  type: string
                recognizedRevenueAccountingCode:
                  description: >
                    The accounting code for the recognized revenue, such as
                    Monthly Recurring Charges or Overage Charges.
                  type: string
                recognizedRevenueAccountingCodeType:
                  description: >
                    The type of the recognized revenue accounting code, such as
                    Sales Revenue or Sales Discount.
                  type: string
                revenueRecognitionRuleName:
                  description: >
                    The name of the revenue recognition rule governing the
                    revenue schedule.
                  type: string
                revenueScheduleNumber:
                  description: >
                    The revenue schedule number. The revenue schedule number is
                    always prefixed with "RS", for example, RS-00000001.
                  type: string
              type: object
            id:
              description: |
                The ID of the debit memo item.
              type: string
            processingType:
              description: >
                The kind of the charge for the debit memo item. Its possible
                values are `Charge` and `Discount`. 
              type: string
            quantity:
              description: |
                The number of units for the debit memo item.
              format: double
              type: number
            reflectDiscountInNetAmount:
              type: boolean
              default: false
              description: >
                When you apply percentage discounts to either of the following
                charges, you need to set the `reflectDiscountInNetAmount` field
                on your discount charge to `true`, to enable calculating and
                displaying the net amount of the following charges in Zuora
                Revenue.

                * delivery pricing charge

                * prepayment charge

                * drawdown charge


                Note the following:

                * If you are an <a
                href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
                target="_blank">Order to Revenue</a> customer, when you set the
                `reflectDiscountInNetAmount` field to `true`, you must also set
                the `excludeItemBillingFromRevenueAccounting` field to `true`. 

                * If you are a <a
                href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
                target="_blank">Billing - Revenue Integration</a> customer, you
                must set the `reflectDiscountInNetAmount` field to `false`,
                otherwise an error will be returned. Billing - Revenue
                Integration does not support discounts on the preceding charges.

                * If you are a Zuora Billing customer who does not enable the
                Order to Revenue or Billing - Revenue Integration feature, when
                you apply percentage discounts to the preceding charges, you
                also need to set the `reflectDiscountInNetAmount` field to
                `true`.
            serviceEndDate:
              description: >
                The end date of the service period associated with this debit
                memo item. Service ends one second before the date specified in
                this field.
              format: date
              type: string
            serviceStartDate:
              description: >
                The start date of the service period associated with this debit
                memo item. If the associated charge is a one-time fee, this date
                is the date of that charge.
              format: date
              type: string
            sku:
              description: |
                The SKU for the product associated with the debit memo item.
              type: string
            skuName:
              description: |
                The name of the SKU.
              type: string
            shipToContactId:
              description: >
                The ID of the ship-to contact associated with the invoice item.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
            soldToContactId:
              description: >
                The ID of the sold-to contact associated with the invoice item.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.
              type: string
            soldToContactSnapshotId:
              description: >
                The ID of the sold-to contact snapshot associated with the
                invoice item.


                The value of this field is `null` if you have the [Flexible
                Billing
                Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
                feature disabled.             
              type: string
            sourceItemId:
              description: |
                The ID of the source item.
              type: string
            sourceItemType:
              description: |
                The type of the source item.
              enum:
                - CreditMemoItem
                - SubscriptionComponent
                - InvoiceDetail
                - ProductRatePlanCharge
              type: string
            subscriptionId:
              description: |
                The ID of the subscription associated with the debit memo item.
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            taxMode:
              description: >
                The tax mode of the debit memo item, indicating whether the
                amount of the debit memo item includes tax.
              enum:
                - TaxExclusive
                - TaxInclusive
              type: string
            taxationItems:
              description: >
                Container for the taxation items of the debit memo item.


                **Note**: This field is available only if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `239.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              properties:
                data:
                  description: |
                    List of taxation items.
                  items:
                    $ref: '#/components/schemas/GETDMTaxItemTypeNew'
                  type: array
                nextPage:
                  description: >
                    URL to retrieve the next page of the response if it exists;
                    otherwise absent.
                  format: URL
                  type: string
              type: object
            unitOfMeasure:
              description: |
                The units to measure usage.
              type: string
            unitPrice:
              description: |
                The per-unit price of the debit memo item.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the debit memo item.
              type: string
            updatedDate:
              description: >
                The date and time when the debit memo item was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields'
    POSTTaxationItemForDMType:
      allOf:
        - properties:
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field.
              type: string
            memoItemId:
              description: |
                The ID of the debit memo that the taxation item is created for.
              type: string
            name:
              description: |
                The name of the taxation item.
              type: string
            sourceTaxItemId:
              description: >
                The ID of the taxation item of the invoice, which the debit memo
                is created from. 


                If you want to use this REST API to create taxation items for a
                debit memo created from an invoice, the taxation items of the
                invoice must be created or imported through the SOAP API call.


                **Note:** 
                  - This field is only used if the debit memo is created from an invoice. 
                  - If you do not contain this field in the request body, Zuora will automatically set a value for the `sourceTaxItemId` field based on the tax location code, tax jurisdiction, and tax rate.
              type: string
            taxAmount:
              description: |
                The amount of the tax applied to the debit memo.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific debit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: |
                The date when the tax is applied to the debit memo.
              format: date
              type: string
            taxRate:
              description: |
                The tax rate applied to the debit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the debit memo.
              enum:
                - Percentage
                - FlatFee
              type: string
          required:
            - taxRate
            - jurisdiction
            - name
            - taxRateType
            - taxAmount
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
      title: taxationItems
    POSTTaxationItemListForDMType:
      example:
        taxationItems:
          - name: STATE TAX
            memoItemId: 8ad093f793300daf01933d50a548781f
            jurisdiction: CALIFORNIA
            taxAmount: 0.5
            taxCode: ServiceTaxCode
            taxDate: '2024-11-18'
            taxRate: 0.05
            taxRateType: Percentage
      properties:
        taxationItems:
          description: |
            Container for taxation items.
          items:
            $ref: '#/components/schemas/POSTTaxationItemForDMType'
          type: array
      type: object
    DebitMemoItemFromWriteOffInvoice:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the credit memo item.
              type: string
            amountWithoutTax:
              description: |
                The credit memo item amount excluding tax.
              format: double
              type: number
            debitMemoItemId:
              description: |
                The ID of the debit memo item.
              type: string
            serviceEndDate:
              description: |
                The service end date of the credit memo item. 
              format: date
              type: string
            serviceStartDate:
              description: |
                The service start date of the credit memo item. 
              format: date
              type: string
            skuName:
              description: |
                The name of the charge associated with the invoice.
              type: string
            unitOfMeasure:
              description: |
                The definable unit that you measure when determining charges.
              type: string
            excludeItemBillingFromRevenueAccounting:
              description: >
                The flag to exclude the credit memo item from revenue
                accounting.


                **Note**: This field is only available if you have the Billing -
                Revenue Integration feature enabled. 
              type: boolean
            taxationItems:
              description: >
                Container for the taxation items of the credit memo item. 


                **Note**: This field is available only if you are on the latest
                Zuora API version, or you set the `Zuora-Version` request header
                to `239.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              items:
                properties:
                  amount:
                    description: |
                      The credit memo taxation amount.
                    type: number
                  taxationItemId:
                    description: |
                      The Id of the debit memo item.
                    type: string
                type: object
              type: array
          type: object
        - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields'
      title: items
    PUTWriteOffDebitMemoRequest:
      allOf:
        - properties:
            comment:
              description: >
                Comments about the write-off. The comment is used as the comment
                of the credit memo generated by writing off the specified
                invoice.
              maxLength: 255
              minLength: 0
              type: string
            amount:
              description: |
                The write off amount of the invoice.
              type: number
            taxAutoCalculation:
              description: >
                Indicates whether to automatically calculate taxes in the credit
                memo.
              type: boolean
            revenueImpacting:
              description: >
                Indicates whether this write off operation impacts the revenue.
                If `revenueImpacting` = `Yes`, the deferred revenue accounting
                code will be automatically selected from the associated invoice.


                The **Exclude Billing Item From Revenue** field will be
                automatically set to **Yes** by default for such non-revenue
                impacting write off credit memos, and this setting cannot be
                changed. This enhancement helps ensure that only
                revenue-impacting items are synchronized with Zuora Revenue,
                reducing unnecessary data processing.


                If `revenueImpacting` = `No`, users can select an accounting
                code such as bad-debt expense accounting code for the write off
                operation.
              enum:
                - 'Yes'
                - 'No'
              default: 'Yes'
              type: string
            nonRevenueWriteOffAccountingCode:
              description: >
                Specify the accounting code for the non revenue write off.
                Available only if `revenueImpacting` = `no`.



                **Note**: This field is available only if you have enabled the
                enhanced write-off permission for your tenant. Contact <a

                href="https://support.zuora.com/hc/en-us" target="_blank">Zuora
                Global Support</a> to enable this permission.
              type: string
            items:
              description: >
                Container for items. This field is optional. 

                **Note:** If specified, you must specify ALL the items of the
                invoice. The entire balance of the invoice will be written off,
                you cannot just write off some items of the invoice.
              items:
                $ref: '#/components/schemas/DebitMemoItemFromWriteOffInvoice'
              type: array
            memoDate:
              description: >
                The date when the credit memo was created, in `yyyy-mm-dd`
                format. The memo date must be later than or equal to the invoice
                date.


                The default value is the date when you write off the invoice.
              format: date
              type: string
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code `Write-off`.
              type: string
          type: object
        - $ref: '#/components/schemas/CreditMemoObjectCustomFields'
        - $ref: '#/components/schemas/CreditMemoObjectNSFields'
      example:
        memoDate: '2019-01-02'
      type: object
    PUTWriteOffDebitMemoResponse:
      properties:
        creditMemo:
          description: >
            Container for the credit memo that is automatically generated when
            writing off invoices.
          properties:
            id:
              description: >
                The ID of the credit memo that is created when the invoice is
                written off.
              type: string
          type: object
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GetEInvoicingServiceProviderResponse:
      allOf:
        - properties:
            companyIdentifier:
              description: >
                The identifier of the company used to create a sender system ID,
                which serves to identify the system where the transactions are
                sent.
              type: string
            id:
              description: |
                The ID of the e-invoicing service provider.
              type: string
            name:
              description: |
                The name of the e-invoicing service provider.
              maxLength: 100
              type: string
            provider:
              description: >
                The name of the e-invoicing service provider that can help you
                generate e-invoice files for billing documents.
              enum:
                - Sovos
                - PEPPOL
                - Avalara
              type: string
            serviceProviderNumber:
              description: |
                The unique number of the e-invoicing service provider.
              type: string
            test:
              description: >
                Whether the e-invoicing service provider's configuration is
                intended for testing. 


                - If you set this field to `true`, requests are directed to the
                testing integration endpoints.

                - If you set this field to `false`, requests are directed to the
                production integration endpoints.
              type: boolean
            apiKey:
              description: >
                The API key is used to authenticate the e-invoicing service
                provider's requests. This field only applies to the Sovos or
                Avalara service provider. 
              type: string
            use_certificate:
              description: >
                This field is used to indicate whether the `clientCertificate`,
                `clientCertificateType`, and `clientCertificatePassord` fields
                need to be supplied in the request.


                **Note:** If the flag is `true`, the TLS endpoint config is
                enabled. If the flag is `false`, the Non-TLS config endpoint is
                enabled. 
                  A TLS certificate and password are no longer required for integration with Sovos. Zuora now uses token-based authentication for all supported countries, including India.
              type: boolean
              default: true
            clientCertificate:
              description: >
                The client certificate is used to authenticate the e-invoicing
                service provider's requests, which should be in base64 encoded
                format. This field only applies to the Sovos service provider. 
              type: string
              format: byte
            clientCertificateType:
              description: >
                The client certificate type is used to authenticate the
                e-invoicing service provider's requests. This field only applies
                to the Sovos service provider. 
              type: string
              default: PKCS12
          title: serviceProviders
          type: object
    ListEInvoicingServiceProvidersResponse:
      properties:
        serviceProviders:
          description: |
            Container for e-invoicing service providers.
          items:
            $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    CreateEInvoicingServiceProviderRequest:
      allOf:
        - properties:
            companyIdentifier:
              description: >
                The identifier of the company used to create a sender system ID,
                which serves to identify the system where the transactions are
                sent.
              type: string
            name:
              description: |
                The name of the e-invoicing service provider.
              maxLength: 100
              type: string
            provider:
              description: >
                The name of the e-invoicing service provider that can help you
                generate e-invoice files for billing documents.
              enum:
                - Sovos
                - PEPPOL
                - Avalara
              type: string
            test:
              description: >
                Whether the e-invoicing service provider's configuration is
                intended for testing. 


                - If you set this field to `true`, requests are directed to the
                testing integration endpoints.

                - If you set this field to `false`, requests are directed to the
                production integration endpoints.
              type: boolean
            apiKey:
              description: >
                The API key is used to authenticate the e-invoicing service
                provider's requests. This field is required for configuring
                Sovos or Avalara as the service provider.
              type: string
            secretKey:
              description: >
                The secret key is used to authenticate the e-invoicing service
                provider's requests. This field is required for configuring
                Sovos or Avalara as the service provider.
              type: string
            use_certificate:
              description: >
                This field is used to indicate whether the `clientCertificate`,
                `clientCertificateType`, and `clientCertificatePassord` fields
                need to be supplied in the request.


                **Note:** If the flag is `true`, the TLS endpoint config is
                enabled. If the flag is `false`, the Non-TLS config endpoint is
                enabled. 

                A TLS certificate and password are no longer required for
                integration with Sovos. Zuora now uses token-based
                authentication for all supported countries, including India.
              type: boolean
              default: true
            clientCertificate:
              description: >
                The client certificate is used to authenticate the e-invoicing
                service provider's requests, which should be in base64 encoded
                format. This field is required for configuring Sovos as the
                service provider.
              type: string
              format: byte
            clientCertificateType:
              description: >
                The client certificate type is used to specify the type of the
                client certificate. This field is required for configuring Sovos
                as the service provider.
              type: string
              default: PKCS12
            clientCertificatePassword:
              description: >
                The client certificate password is the password to protect the
                client certificate. This field is required for configuring Sovos
                as the service provider.
              type: string
              format: password
          required:
            - name
            - provider
          type: object
      example:
        name: Sovos e-invoice service
        provider: Sovos
        test: false
        companyIdentifier: CompanySample1
        apiKey: ApiKeySample
        secretKey: SecretKey
        use_certificate: false
        clientCertificate: U3dhZ2dlciByb2Nrcw==
        clientCertificateType: PKCS12
        clientCertificatePassword: ClientCertificatePassword
    UpdateEInvoicingServiceProviderRequest:
      allOf:
        - properties:
            companyIdentifier:
              description: >
                The identifier of the company used to create a sender system ID,
                which serves to identify the system where the transactions are
                sent.
              type: string
            name:
              description: |
                The name of the e-invoicing service provider.
              maxLength: 100
              type: string
            test:
              description: >
                Whether the e-invoicing service provider's configuration is
                intended for testing. 


                - If you set this field to `true`, requests are directed to the
                testing integration endpoints.

                - If you set this field to `false`, requests are directed to the
                production integration endpoints.
              type: boolean
            apiKey:
              description: >
                The API key is used to authenticate the e-invoicing service
                provider's requests. This field only applies to the Sovos or
                Avalara service provider. 
              type: string
            secretKey:
              description: >
                The secret key is used to authenticate the e-invoicing service
                provider's requests. This field only applies to the Sovos or
                Avalara service provider. 
              type: string
            use_certificate:
              description: >
                This field is used to indicate whether the *clientCertificate*,
                `clientCertificateType`, and `clientCertificatePassord` fields
                need to be supplied in the request.


                **Note:** If the flag is `true`, the TLS endpoint config is
                enabled. If the flag is `false`, the Non-TLS config endpoint is
                enabled.

                A TLS certificate and password are no longer required for
                integration with Sovos. Zuora now uses token-based
                authentication for all supported countries, including India.
              type: boolean
              default: true
            clientCertificate:
              description: >
                The client certificate is used to authenticate the e-invoicing
                service provider's requests, which should be in base64 encoded
                format. This field only applies to the Sovos service provider. 
              type: string
              format: byte
            clientCertificateType:
              description: >
                The client certificate type is used to specify the type of the
                client certificate. This field only applies to the Sovos service
                provider. 
              type: string
              default: PKCS12
            clientCertificatePassword:
              description: >
                The client certificate password is the password to protect the
                client certificate. This field only applies to the Sovos service
                provider. 
              type: string
              format: password
          type: object
      example:
        name: Sovos e-invoice service
        test: false
        companyIdentifier: CompanySample1
        apiKey: ApiKeySample
        secretKey: SecretKey
        use_certificate: false
        clientCertificate: U3dhZ2dlciByb2Nrcw==
        clientCertificateType: PKCS12
        clientCertificatePassword: ClientCertificatePassword
    InvoiceFiltersCondition:
      allOf:
        - description: Container for condition information about the invoice filters.
          properties:
            conditions:
              description: >
                Multiple `conditions` fields are combined by the `relation`
                fields. These `conditions` fields form a custom filter.

                Each `conditions` field is a formula combined by the `field`,
                `operator`, and `value` fields.
              type: array
              items:
                $ref: '#/components/schemas/InvoiceFiltersCondition'
            field:
              description: >
                The field name of a single condition that is indicated by the
                `conditions` field.
              type: string
            operator:
              description: >
                The operator of a single condition that is indicated by the
                `conditions` field.  The operator is added between the `field`
                and `value` fields.

                - eq: equal (`field` = `value`)

                - neq: not equal (`field` != `value`) 

                - gt: greater than (`field` > `value`) 

                - lt: less than (`field` < `value`) 

                - gte: greater than or equal (`field` >= `value`)

                - lte: less than or equal (`field` <= `value`)

                - lk: like (`field` like `value`) 

                - in: in (`field` in `value`, the values are separated by comma)

                - nl: null (`field` is null)

                - nnl: not null (`field` is not null)
              type: string
              enum:
                - eq
                - neq
                - gt
                - lt
                - gte
                - lte
                - lk
                - in
                - nl
                - nnl
            relation:
              description: |
                The relation among the `conditions` fields.
              type: string
              enum:
                - and
                - or
            value:
              description: >
                The value of a single condition that is indicated by the
                `conditions` field.
              type: string
            objectType:
              description: >
                The target object type of the condition when the `filterType`
                field is specified as `FilterCondition`.
              type: string
              enum:
                - Invoice
                - InvoiceItem
          type: object
          title: Condition
    InvoiceFiltersResponseType:
      allOf:
        - properties:
            condition:
              $ref: '#/components/schemas/InvoiceFiltersCondition'
          type: object
      title: InvoiceFilters
    CreditMemoFiltersCondition:
      allOf:
        - description: Container for condition information about the credit memo filters.
          properties:
            conditions:
              description: >
                Multiple `conditions` fields are combined by the `relation`
                fields. These `conditions` fields form a custom filter.

                Each `conditions` field is a formula combined by the `field`,
                `operator`, and `value` fields.
              type: array
              items:
                $ref: '#/components/schemas/CreditMemoFiltersCondition'
            field:
              description: >
                The field name of a single condition that is indicated by the
                `conditions` field.
              type: string
            operator:
              description: >
                The operator of a single condition that is indicated by the
                `conditions` field.  The operator is added between the `field`
                and `value` fields.

                - eq: equal (`field` = `value`)

                - neq: not equal (`field` != `value`) 

                - gt: greater than (`field` > `value`) 

                - lt: less than (`field` < `value`) 

                - gte: greater than or equal (`field` >= `value`)

                - lte: less than or equal (`field` <= `value`)

                - lk: like (`field` like `value`) 

                - in: in (`field` in `value`, the values are separated by comma)

                - nl: null (`field` is null)

                - nnl: not null (`field` is not null)
              type: string
              enum:
                - eq
                - neq
                - gt
                - lt
                - gte
                - lte
                - lk
                - in
                - nl
                - nnl
            relation:
              description: |
                The relation among the `conditions` fields.
              type: string
              enum:
                - and
                - or
            value:
              description: >
                The value of a single condition that is indicated by the
                `conditions` field.
              type: string
            objectType:
              description: >
                The target object type of the condition when the `filterType`
                field is specified as `FilterCondition`.
              type: string
              enum:
                - CreditMemo
                - CreditMemoItem
          type: object
          title: Condition
    CreditMemoFiltersResponseType:
      allOf:
        - properties:
            condition:
              $ref: '#/components/schemas/CreditMemoFiltersCondition'
          type: object
      title: CreditMemoFilters
    DebitMemoFiltersCondition:
      allOf:
        - description: Container for condition information about the debit memo filters.
          properties:
            conditions:
              description: >
                Multiple `conditions` fields are combined by the `relation`
                fields. These `conditions` fields form a custom filter.

                Each `conditions` field is a formula combined by the `field`,
                `operator`, and `value` fields.
              type: array
              items:
                $ref: '#/components/schemas/DebitMemoFiltersCondition'
            field:
              description: >
                The field name of a single condition that is indicated by the
                `conditions` field.
              type: string
            operator:
              description: >
                The operator of a single condition that is indicated by the
                `conditions` field.  The operator is added between the `field`
                and `value` fields.

                - eq: equal (`field` = `value`)

                - neq: not equal (`field` != `value`) 

                - gt: greater than (`field` > `value`) 

                - lt: less than (`field` < `value`) 

                - gte: greater than or equal (`field` >= `value`)

                - lte: less than or equal (`field` <= `value`)

                - lk: like (`field` like `value`) 

                - in: in (`field` in `value`, the values are separated by comma)

                - nl: null (`field` is null)

                - nnl: not null (`field` is not null)
              type: string
              enum:
                - eq
                - neq
                - gt
                - lt
                - gte
                - lte
                - lk
                - in
                - nl
                - nnl
            relation:
              description: |
                The relation among the `conditions` fields.
              type: string
              enum:
                - and
                - or
            value:
              description: >
                The value of a single condition that is indicated by the
                `conditions` field.
              type: string
            objectType:
              description: >
                The target object type of the condition when the `filterType`
                field is specified as `FilterCondition`.
              type: string
              enum:
                - DebitMemo
                - DebitMemoItem
          type: object
          title: Condition
    DebitMemoFiltersResponseType:
      allOf:
        - properties:
            condition:
              $ref: '#/components/schemas/DebitMemoFiltersCondition'
          type: object
      title: DebitMemoFilters
    GetEInvoicingBusinessRegionResponse:
      allOf:
        - properties:
            id:
              description: |
                The unique ID of the e-invoicing business region.
              type: string
            country:
              description: >
                The short name of a country or region where you must comply with
                e-invoicing requirements. For example, `IN` for India. For the
                full list of country names and codes, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
                target="_blank">View countries or regions</a>.
              type: string
            businessName:
              description: >
                The full official name that the Seller is registered with the
                relevant legal authority.
              maxLength: 255
              type: string
            businessNumber:
              description: >
                The specify the unique identifier number of the legal entity or
                person that you do business with.


                For example, you must use a GSTIN for India and Tax
                Identification Number (TIN) for Saudi Arabia.
              type: string
            businessNumberSchemaId:
              description: >
                The identification scheme identifier that an official registrar
                issues to identify the Seller as a legal entity or person.
              type: string
            tradeName:
              description: >
                The name that the Seller is known as, other than the legal
                business name.
              maxLength: 100
              type: string
              nullable: true
            endpointId:
              description: >
                The Seller's electronic address, to which the application-level
                response to the e-invoice file might be delivered.
              type: string
            endpointSchemeId:
              description: >
                The identification scheme identifier of the Seller’s electronic
                address.
              type: string
            taxRegisterNumber:
              description: >
                The Seller's VAT identifier (also known as Seller VAT
                identification number) or the local identification (defined by
                the Seller’s address) of the Seller for tax purposes, or a
                reference that enables the Seller to state the registered tax
                status.
              type: string
              nullable: true
            state:
              description: |
                The name of the state or province where the business is located.
              type: string
              nullable: true
            city:
              description: |
                The the name of the city where the business is located.
              type: string
            postalCode:
              description: |
                The short code that can identify the business address.
              type: string
            addressLine1:
              description: >
                The first line of the Seller’s address, which is often a street
                address or business name.
              type: string
              nullable: true
            addressLine2:
              description: >
                The second line of the Seller’s address, which is often the name
                of a building.
              type: string
              nullable: true
            contactName:
              description: |
                The name of the Seller contact to receive e-invoicing data.
              maxLength: 255
              type: string
              nullable: true
            phoneNumber:
              description: >
                The business phone number of the Seller contact to receive
                e-invoicing data.
              type: string
              nullable: true
            email:
              description: >
                The email address of the Seller contact to receive e-invoicing
                data.
              type: string
              nullable: true
            serviceProviderId:
              description: >
                The unique ID of the e-invoicing service provider that is
                associated to the business region.
              type: string
            businessRegionNumber:
              description: |
                The unique number of the e-invoicing business region.
              type: string
            digitalSignatureEnable:
              description: >
                Whether the e-invoicing service provider signs PDF files for
                billing documents.
              default: false
              type: boolean
            digitalSignatureBoxEnable:
              description: >
                Whether the digital signature box is displayed on PDF files for
                billing documents.
              default: false
              type: boolean
            digitalSignatureBoxPosX:
              description: >
                The X-coordinate to determine where the digital signature box is
                displayed on PDF files for billing documents.
              type: number
              minimum: 0
            digitalSignatureBoxPosY:
              description: >
                The Y-coordinate to determine where the digital signature box is
                displayed on PDF files for billing documents. 
              type: number
              minimum: 0
            responseMapping:
              description: >
                Container for e-invoicing response field mappings that map
                values from the e-invoicing service provider’s response data to
                fields on the EInvoiceData object in Zuora. Each response field
                mapping consists of a field name and a field path.


                **Note**: This field is applicable only to the Sovos or Avalara
                service provider.


                For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings"
                target="_blank">Configure e-invoicing response field
                mappings</a>.
              type: object
              title: responseMapping
              additionalProperties:
                type: string
                description: >
                  The response field mapping consists of a key-value pair:


                  * Field name: the name of the field on the EInvoiceData object
                  (except for the `EInvoiceFile` field, which applies only to
                  Sovos). <br>Zuora supports the following field names. For more
                  information, see <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields"
                  target="_blank">Supported response fields</a>.
                      * `AuthorizationCode`
                      * `EInvoiceFile`
                      * `QrCode`
                      * `ReferenceNumber`
                      * `Field1` to `Field10`

                  * Field value: the path of an XML node in the e-invoicing
                  response data from Sovos. The value of this field must be
                  compliant with the <a
                  href="https://www.w3schools.com/xml/xpath_intro.asp"
                  target="_blank">XPath</a> syntax. For more information, see <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format"
                  target="_blank">Field path format</a>.
            processType:
              description: >
                The process type of the e-invoicing business region.

                - If the service provider is Sovos, the process type is
                `Clearance` or `ClearanceWithCancellation`.

                - If the service provider is Avalara, the process type is
                `Clearance` or `PEPPOLNetwork`.

                - If the service provider is PEPPOL, the process type is
                `Unknown`. 
              type: string
              enum:
                - Clearance
                - ClearanceWithCancellation
                - PEPPOLNetwork
                - Unknown
            invoiceEnabled:
              description: >
                It will control whether the invoice should be supported by the
                process type or not. This field is available when the service
                provider is Sovos or Avalara.
              type: boolean
              default: false
            creditMemoEnabled:
              description: >
                It will control whether the credit memo should be supported by
                the process type or not. This field is available when the
                service provider is Sovos or Avalara.
              type: boolean
              default: false
            debitMemoEnabled:
              description: >
                It will control whether the debit memo should be supported by
                the process type or not. This field is available when the
                service provider is Sovos or Avalara.
              type: boolean
              default: false
            invoiceFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/InvoiceFiltersResponseType'
              type: array
            creditMemoFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/CreditMemoFiltersResponseType'
              type: array
            debitMemoFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/DebitMemoFiltersResponseType'
              type: array
            fileFormat:
              description: >
                The file format for each business category. An example response
                is "[ "application/xml", "application/vnd.oasis.ubl+xml" ]"  
              type: array
              items:
                type: string
            success:
              description: |
                Indicats if the request succeeds.
              type: boolean
          title: regions
          type: object
    ListEInvoicingBusinessRegionsResponse:
      properties:
        regions:
          description: |
            Container for e-invoicing business regions.
          items:
            $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    InvoiceFiltersRequestType:
      allOf:
        - properties:
            condition:
              $ref: '#/components/schemas/InvoiceFiltersCondition'
          required:
            - filterType
          type: object
      title: InvoiceFilters
    CreditMemoFiltersRequestType:
      allOf:
        - properties:
            condition:
              $ref: '#/components/schemas/CreditMemoFiltersCondition'
          required:
            - filterType
          type: object
      title: CreditMemoFilters
    DebitMemoFiltersRequestType:
      allOf:
        - properties:
            condition:
              $ref: '#/components/schemas/DebitMemoFiltersCondition'
          required:
            - filterType
          type: object
      title: DebitMemoFilters
    CreateEInvoicingBusinessRegionRequest:
      allOf:
        - properties:
            addressLine1:
              description: >
                The first line of the Seller's address, which is often a street
                address or business name.
              type: string
            addressLine2:
              description: >
                The second line of the Seller's address, which is often the name
                of a building.
              type: string
            businessName:
              description: >
                The full official name that the Seller is registered with the
                relevant legal authority.
              maxLength: 255
              type: string
            businessNumber:
              description: >
                The specify the unique identifier number of the legal entity or
                person that you do business with.


                For example, you must use a GSTIN for India and Tax
                Identification Number (TIN) for Saudi Arabia.
              type: string
            businessNumberSchemaId:
              description: >
                The identification scheme identifier that an official registrar
                issues to identify the Seller as a legal entity or person.
              type: string
            city:
              description: |
                The the name of the city where the business is located.
              type: string
            contactName:
              description: |
                The name of the Seller contact to receive e-invoicing data.
              maxLength: 255
              type: string
            country:
              description: >
                The short name of a country or region where you must comply with
                e-invoicing requirements. For example, `IN` for India. For the
                full list of country names and codes, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
                target="_blank">View countries or regions</a>.
              type: string
            digitalSignatureEnable:
              description: >
                Whether the e-invoicing service provider signs PDF files for
                billing documents.
              default: false
              type: boolean
            digitalSignatureBoxEnable:
              description: >
                Whether the digital signature box is displayed on PDF files for
                billing documents.
              default: false
              type: boolean
            digitalSignatureBoxPosX:
              description: >
                The X-coordinate to determine where the digital signature box is
                displayed on PDF files for billing documents.
              type: number
              minimum: 0
            digitalSignatureBoxPosY:
              description: >
                The Y-coordinate to determine where the digital signature box is
                displayed on PDF files for billing documents. 
              type: number
              minimum: 0
            email:
              description: >
                The email address of the Seller contact to receive e-invoicing
                data.
              type: string
            endpointId:
              description: >
                The Seller's electronic address, to which the application-level
                response to the e-invoice file might be delivered.
              type: string
            endpointSchemeId:
              description: >
                The identification scheme identifier of the Seller's electronic
                address.
              type: string
            phoneNumber:
              description: >
                The business phone number of the Seller contact to receive
                e-invoicing data.
              type: string
            postalCode:
              description: |
                The short code that can identify the business address.
              type: string
            responseMapping:
              description: >
                Container for e-invoicing response field mappings that map
                values from the e-invoicing service provider's response data to
                fields on the EInvoiceData object in Zuora. Each response field
                mapping consists of a field name and a field path.


                **Note**: This field is applicable only to the Sovos or Avalara
                service provider.


                For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings"
                target="_blank">Configure e-invoicing response field
                mappings</a>.
              type: object
              title: responseMapping
              additionalProperties:
                type: string
                description: >
                  The response field mapping consists of a key-value pair:


                  * Field name: the name of the field on the EInvoiceData object
                  (except for the `EInvoiceFile` field, which applies only to
                  Sovos). <br>Zuora supports the following field names. For more
                  information, see <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields"
                  target="_blank">Supported response fields</a>.
                      * `AuthorizationCode`
                      * `EInvoiceFile`
                      * `QrCode`
                      * `ReferenceNumber`
                      * `Field1` to `Field10`

                  * Field value: the path of an XML node in the e-invoicing
                  response data from Sovos. The value of this field must be
                  compliant with the <a
                  href="https://www.w3schools.com/xml/xpath_intro.asp"
                  target="_blank">XPath</a> syntax. For more information, see <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format"
                  target="_blank">Field path format</a>.
            processType:
              description: >
                The process type of the e-invoicing business region.

                - If the service provider is Sovos, specify the process type as
                `Clearance` or `ClearanceWithCancellation`.

                - If the service provider is Avalara, specify the process type
                as `Clearance` or `PEPPOLNetwork`.

                - If the service provider is PEPPOL, leave this field empty. 
              type: string
              enum:
                - Clearance
                - ClearanceWithCancellation
                - PEPPOLNetwork
            invoiceEnabled:
              description: >
                This field controls whether the invoice should be supported by
                the process type or not. For some countries, this field is
                required to be set to `true`. For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations"
                target="_blank">Manage country-specific configurations</a>.
              type: boolean
              default: false
            creditMemoEnabled:
              description: >
                This field controls whether the credit memo should be supported
                by the process type or not. For some countries, this field is
                required to be set to `true`. For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations"
                target="_blank">Manage country-specific configurations</a>.
              type: boolean
              default: false
            debitMemoEnabled:
              description: >
                This field controls whether the debit memo should be supported
                by the process type or not. For some countries, this field is
                required to be set to `true`. For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations"
                target="_blank">Manage country-specific configurations</a>.
              type: boolean
              default: false
            invoiceFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/InvoiceFiltersRequestType'
              type: array
            creditMemoFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/CreditMemoFiltersRequestType'
              type: array
            debitMemoFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/DebitMemoFiltersRequestType'
              type: array
            serviceProviderId:
              description: >
                The unique ID of the e-invoicing service provider that is
                associated to the business region.
              type: string
            state:
              description: |
                The name of the state or province where the business is located.
              type: string
            taxRegisterNumber:
              description: >
                The Seller's VAT identifier (also known as Seller VAT
                identification number) or the local identification (defined by
                the Seller's address) of the Seller for tax purposes, or a
                reference that enables the Seller to state the registered tax
                status.
              type: string
            tradeName:
              description: >
                The name that the Seller is known as, other than the legal
                business name.
              maxLength: 100
              type: string
            fileFormat:
              description: >

                You can define the file format for each business category as
                shown in the following example:   
                  
                fileFormat" : {
                  
                  "B2B" : [ "XML" ],
                  
                  "B2C" : [ ],
                  
                  "B2G" : [ "XML" ]

                }

                 **Note:** This field is optional; however, if you use Avalara integration, it becomes a mandatory field.
              type: array
              items:
                type: string
          required:
            - country
            - businessName
          type: object
      example:
        addressLine1: null
        addressLine2: null
        businessName: legal business name
        businessNumber: '20002039'
        businessNumberSchemaId: '88'
        city: Tokyo
        contactName: null
        country: JP
        email: null
        endpointId: '8992'
        endpointSchemeId: '88'
        invoiceFilters:
          - objectType: Invoice
            condition:
              field: SoldToContact.Country
              operator: eq
              value: India
        phoneNumber: null
        postalCode: '368779'
        serviceProviderId: 4028948972a2bf990172bc9b27724ddc
        state: null
        taxRegisterNumber: TAX393999
        tradeName: Zuora
        fileFormat:
          B2B:
            - XML
          B2C:
            - ''
          B2G:
            - XML
    UpdateEInvoicingBusinessRegionRequest:
      allOf:
        - properties:
            addressLine1:
              description: >
                The first line of the Seller's address, which is often a street
                address or business name.
              type: string
            addressLine2:
              description: >
                The second line of the Seller's address, which is often the name
                of a building.
              type: string
            businessName:
              description: >
                The full official name that the Seller is registered with the
                relevant legal authority.
              maxLength: 255
              type: string
            businessNumber:
              description: >
                The specify the unique identifier number of the legal entity or
                person that you do business with.


                For example, you must use a GSTIN for India and Tax
                Identification Number (TIN) for Saudi Arabia.
              type: string
            businessNumberSchemaId:
              description: >
                The identification scheme identifier that an official registrar
                issues to identify the Seller as a legal entity or person.
              type: string
            city:
              description: |
                The the name of the city where the business is located.
              type: string
            contactName:
              description: |
                The name of the Seller contact to receive e-invoicing data.
              maxLength: 255
              type: string
            country:
              description: >
                The short name of a country or region where you must comply with
                e-invoicing requirements. For example, `IN` for India. For the
                full list of country names and codes, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
                target="_blank">View countries or regions</a>.
              type: string
            digitalSignatureEnable:
              description: >
                Whether the e-invoicing service provider signs PDF files for
                billing documents.
              default: false
              type: boolean
            digitalSignatureBoxEnable:
              description: >
                Whether the digital signature box is displayed on PDF files for
                billing documents.
              default: false
              type: boolean
            digitalSignatureBoxPosX:
              description: >
                The X-coordinate to determine where the digital signature box is
                displayed on PDF files for billing documents.
              type: number
              minimum: 0
            digitalSignatureBoxPosY:
              description: >
                The Y-coordinate to determine where the digital signature box is
                displayed on PDF files for billing documents. 
              type: number
              minimum: 0
            email:
              description: >
                The email address of the Seller contact to receive e-invoicing
                data.
              type: string
            endpointId:
              description: >
                The Seller's electronic address, to which the application-level
                response to the e-invoice file might be delivered.
              type: string
            endpointSchemeId:
              description: >
                The identification scheme identifier of the Seller's electronic
                address.
              type: string
            phoneNumber:
              description: >
                The business phone number of the Seller contact to receive
                e-invoicing data.
              type: string
            postalCode:
              description: |
                The short code that can identify the business address.
              type: string
            responseMapping:
              description: >
                Container for e-invoicing response field mappings that map
                values from Sovos response data to fields on the EInvoiceData
                object in Zuora. Each response field mapping consists of a field
                name and a field path.


                Note that this field is applicable only to the Sovos service
                provider.


                For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings"
                target="_blank">Configure e-invoicing response field
                mappings</a>.
              type: object
              title: responseMapping
              additionalProperties:
                type: string
                description: >
                  The response field mapping consists of a key-value pair:


                  * Field name: the name of the field on the EInvoiceData object
                  (except for the `EInvoiceFile` field). <br>Zuora supports the
                  following field names. For more information, see <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Supported_response_fields"
                  target="_blank">Supported response fields</a>.
                      * `AuthorizationCode`
                      * `EInvoiceFile`
                      * `QrCode`
                      * `ReferenceNumber`
                      * `Field1` to `Field10`

                  * Field value: the path of an XML node in the e-invoicing
                  response data from Sovos. The value of this field must be
                  compliant with the <a
                  href="https://www.w3schools.com/xml/xpath_intro.asp"
                  target="_blank">XPath</a> syntax. For more information, see <a
                  href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Configure_e-invoicing_response_field_mappings#Field_path_format"
                  target="_blank">Field path format</a>.
            invoiceEnabled:
              description: >
                This field controls whether the invoice should be supported by
                the process type or not. For some countries, this field is
                required to be set to `true`. For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations"
                target="_blank">Manage country-specific configurations</a>.
              type: boolean
              default: false
            creditMemoEnabled:
              description: >
                This field controls whether the credit memo should be supported
                by the process type or not. For some countries, this field is
                required to be set to `true`. For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations"
                target="_blank">Manage country-specific configurations</a>.
              type: boolean
              default: false
            debitMemoEnabled:
              description: >
                This field controls whether the debit memo should be supported
                by the process type or not. For some countries, this field is
                required to be set to `true`. For more information, see <a
                href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview/B_Configure_the_E-Invoicing_feature/Manage_country-specific_configurations"
                target="_blank">Manage country-specific configurations</a>.
              type: boolean
              default: false
            invoiceFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/InvoiceFiltersRequestType'
              type: array
            creditMemoFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/CreditMemoFiltersRequestType'
              type: array
            debitMemoFilters:
              description: |
                The documents belonging to the e-invoicing business region. 
              items:
                $ref: '#/components/schemas/DebitMemoFiltersRequestType'
              type: array
            serviceProviderId:
              description: >
                The unique ID of the e-invoicing service provider that is
                associated to the business region.
              type: string
            state:
              description: |
                The name of the state or province where the business is located.
              type: string
            taxRegisterNumber:
              description: >
                The Seller's VAT identifier (also known as Seller VAT
                identification number) or the local identification (defined by
                the Seller’s address) of the Seller for tax purposes, or a
                reference that enables the Seller to state the registered tax
                status.
              type: string
            tradeName:
              description: >
                The name that the Seller is known as, other than the legal
                business name.
              maxLength: 100
              type: string
            fileFormat:
              description: >

                You can define the file format for each business category as
                shwown in the following example:   
                  
                fileFormat" : {
                  
                  "B2B" : [ "XML" ],
                  
                  "B2C" : [ ],
                  
                  "B2G" : [ "XML" ]

                }

                 **Note:** This field is optional; however, if you use Avalara integration, it becomes a mandatory field.
              type: array
              items:
                type: string
          type: object
      example:
        addressLine1: null
        addressLine2: null
        businessName: legal business name
        businessNumber": '20002039'
        businessNumberSchemaId: '88'
        city: Tokyo
        contactName: null
        country: JP
        email: null
        endpointId: '8992'
        endpointSchemeId: '88'
        phoneNumber: null
        postalCode: '368779'
        serviceProviderId: 4028948972a2bf990172bc9b27724ddc
        state: null
        taxRegisterNumber: TAX393999
        tradeName: Zuora
        fileFormat:
          B2B:
            - XML
          B2C:
            - ''
          B2G:
            - XML
    GETEinvoiceFetchMandates:
      allOf:
        - properties:
            countryCode:
              description: |
                2-digit country code. 
              type: string
              nullable: false
            fileFormats:
              description: >
                Following mapping will be used for user representation of file
                formats:

                  - XML: `application/xml`
                  - PDF: `application/pdf` 
                  - ZIP: `application/zip` 
                  - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml`   
              type: array
              items:
                type: string
              nullable: false
            category:
              description: >
                The business categories that Zuora supports for customer
                accounts. Supported values are B2B, B2C, or B2G.
              type: string
              enum:
                - B2B
                - B2C
                - B2G
            processType:
              description: |
                The process type of the e-invoicing business region.
                  - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`.
                  - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`.
                  - If the service provider is PEPPOL, the process type is `Unknown`.
              enum:
                - Clearance
                - ClearanceWithCancellation
                - PEPPOLNetwork
                - Unknown
              type: string
            defaultFileFormats:
              description: |
                The default file format.
              type: string
    GETEinvoiceFetchMandatesErrorsReasons:
      allOf:
        - properties:
            code:
              description: |
                Code for the validation error.
              type: string
            message:
              description: |
                Validation error message.
              type: string
    GETEinvoiceFetchMandatesErrors:
      allOf:
        - properties:
            success:
              description: |
                Returns `false` if the request was not processed successfully.
              type: boolean
            processId:
              description: |
                Process Id of the validation error.
              type: string
            reasons:
              description: |
                Container for error reasons.
              items:
                $ref: '#/components/schemas/GETEinvoiceFetchMandatesErrorsReasons'
            requestId:
              description: |
                Request Id for the validation error.
              type: string
    EinvoiceFetchMandates:
      properties:
        data:
          description: |
            Container for fetching mandates.
          items:
            $ref: '#/components/schemas/GETEinvoiceFetchMandates'
          type: array
        error:
          description: |
            Container for fetching validation errors.
          items:
            $ref: '#/components/schemas/GETEinvoiceFetchMandatesErrors'
          type: array
      type: object
    GETEinvoiceInvoiceFetchMandate:
      allOf:
        - properties:
            countryCode:
              description: |
                2-digit country code. 
              type: string
              nullable: false
            fileFormats:
              description: >
                Following mapping will be used for user representation of file
                formats:

                  - XML: `application/xml`
                  - PDF: `application/pdf` 
                  - ZIP: `application/zip` 
                  - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml`     
              type: array
              items:
                type: string
              nullable: false
            category:
              description: >
                The business categories that Zuora supports for customer
                accounts. Supported values are B2B, B2C, or B2G.
              type: string
              enum:
                - B2B
                - B2C
                - B2G
            processType:
              description: |
                The process type of the e-invoicing business region.
                  - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`.
                  - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`.
                  - If the service provider is PEPPOL, the process type is `Unknown`.
              enum:
                - Clearance
                - ClearanceWithCancellation
                - PEPPOLNetwork
                - Unknown
              type: string
            defaultFileFormats:
              description: |
                The default file format.
              type: string
    GETEinvoiceInvoiceFetchMandatesErrorsReasons:
      allOf:
        - properties:
            code:
              description: |
                Code for the validation error.
              type: string
            message:
              description: |
                Validation error message.
              type: string
    GETEinvoiceInvoiceFetchMandatesError:
      allOf:
        - properties:
            success:
              description: |
                Returns `false` if the request was not processed successfully.
              type: boolean
            processId:
              description: |
                Process Id of the validation error.
              type: string
            reasons:
              description: |
                Container for error reasons.
              items:
                $ref: >-
                  #/components/schemas/GETEinvoiceInvoiceFetchMandatesErrorsReasons
            requestId:
              description: |
                Request Id for the validation error.
              type: string
    EinvoiceInvoiceFetchMandate:
      properties:
        success:
          description: |
            Container for fetching mandates.
          items:
            $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandate'
          type: array
        error:
          description: |
            Container for fetching validation errors.
          items:
            $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandatesError'
          type: array
      type: object
    GETEinvoiceCreditMemosMandate:
      allOf:
        - properties:
            countryCode:
              description: |
                2-digit country code. 
              type: string
              nullable: false
            fileFormats:
              description: >
                Following mapping will be used for user representation of file
                formats:

                  - XML: `application/xml`
                  - PDF: `application/pdf` 
                  - ZIP: `application/zip` 
                  - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml`  
              type: array
              items:
                type: string
              nullable: false
            category:
              description: >
                Business categories that Zuora supports for customer accounts.
                Supported values are B2B, B2C, or B2G.
              type: string
              enum:
                - B2B
                - B2C
                - B2G
            processType:
              description: |
                The process type of the e-invoicing business region.
                  - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`.
                  - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`.
                  - If the service provider is PEPPOL, the process type is `Unknown`.
              enum:
                - Clearance
                - ClearanceWithCancellation
                - PEPPOLNetwork
                - Unknown
              type: string
            defaultFileFormats:
              description: |
                The default file format.
              type: string
    GETEinvoiceCreditMemosMandatesErrorsReasons:
      allOf:
        - properties:
            code:
              description: |
                Code for the validation error.
              type: string
            message:
              description: |
                Validation error message.
              type: string
    GETEinvoiceCreditMemosMandatesErrors:
      allOf:
        - properties:
            success:
              description: |
                Returns `false` if the request was not processed successfully.
              type: boolean
            processId:
              description: |
                Process Id of the validation error.
              type: string
            reasons:
              description: |
                Container for error reasons.
              items:
                $ref: >-
                  #/components/schemas/GETEinvoiceCreditMemosMandatesErrorsReasons
            requestId:
              description: |
                Request Id for the validation error.
              type: string
    CreditMemosEinvoiceMandate:
      properties:
        success:
          description: |
            Container for fetching mandates.
          items:
            $ref: '#/components/schemas/GETEinvoiceCreditMemosMandate'
          type: array
        error:
          description: |
            Container for fetching validation errors.
          items:
            $ref: '#/components/schemas/GETEinvoiceCreditMemosMandatesErrors'
          type: array
      type: object
    GETEinvoiceDebitMemosMandates:
      allOf:
        - properties:
            countryCode:
              description: |
                2-digit country code. 
              type: string
              nullable: false
            fileFormats:
              description: >
                Following mapping will be used for user representation of file
                formats:

                  - XML: `application/xml`
                  - PDF: `application/pdf` 
                  - ZIP: `application/zip` 
                  - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml`  
              type: array
              items:
                type: string
              nullable: false
            category:
              description: >
                Business categories that Zuora supports for customer accounts.
                Supported values are B2B, B2C, or B2G.
              type: string
              enum:
                - B2B
                - B2C
                - B2G
            processType:
              description: |
                The process type of the e-invoicing business region.
                  - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`.
                  - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`.
                  - If the service provider is PEPPOL, the process type is `Unknown`.
              enum:
                - Clearance
                - ClearanceWithCancellation
                - PEPPOLNetwork
                - Unknown
              type: string
            defaultFileFormats:
              description: |
                The default file format.
              type: string
    GETEinvoiceDebitMemosMandatesErrorsReasons:
      allOf:
        - properties:
            code:
              description: |
                Code for the validation error.
              type: string
            message:
              description: |
                Validation error message.
              type: string
    GETEinvoiceDebitMemosMandatesErrors:
      allOf:
        - properties:
            success:
              description: |
                Returns `false` if the request was not processed successfully.
              type: boolean
            processId:
              description: |
                Process Id of the validation error.
              type: string
            reasons:
              description: |
                Container for error reasons.
              items:
                $ref: >-
                  #/components/schemas/GETEinvoiceDebitMemosMandatesErrorsReasons
            requestId:
              description: |
                Request Id for the validation error.
              type: string
    DebitMemosEinvoiceMandate:
      properties:
        success:
          description: |
            Container for fetching mandates.
          items:
            $ref: '#/components/schemas/GETEinvoiceDebitMemosMandates'
          type: array
        errors:
          description: |
            Container for fetching validation errors.
          items:
            $ref: '#/components/schemas/GETEinvoiceDebitMemosMandatesErrors'
          type: array
      type: object
    GETEinvoiceDownloadErrors:
      allOf:
        - properties:
            code:
              description: |
                Code for the validation error.
              type: string
            message:
              description: |
                Validation error message.
              type: string
    GETEinvoiceDownload:
      allOf:
        - properties:
            success:
              description: |
                Returns `false` if the request was not processed successfully.
              type: boolean
            processId:
              description: |
                Process Id of the validation error.
              type: string
            reasons:
              description: |
                Container for error reasons.
              items:
                $ref: '#/components/schemas/GETEinvoiceDownloadErrors'
            requestId:
              description: |
                Request Id for the validation error.
              type: string
    EinvoiceDownload:
      properties:
        success:
          description: |
            Stream the file contents.
        error:
          description: |
            Container for downloading e-invoice.
          items:
            $ref: '#/components/schemas/GETEinvoiceDownload'
          type: array
      type: object
    GETCreditMemosEinvoiceDownloadErrors:
      allOf:
        - properties:
            code:
              description: |
                Code for the validation error.
              type: string
            message:
              description: |
                Validation error message.
              type: string
    GETCreditMemosEinvoiceDownload:
      allOf:
        - properties:
            processId:
              description: |
                Process Id of the validation error.
              type: string
            reasons:
              description: |
                Container for error reasons.
              items:
                $ref: '#/components/schemas/GETCreditMemosEinvoiceDownloadErrors'
            requestId:
              description: |
                Request Id for the validation error.
              type: string
    CreditMemosEinvoiceDownload:
      properties:
        success:
          description: |
            Stream the file contents.
        error:
          description: |
            Container for downloading Credit Memo.
          items:
            $ref: '#/components/schemas/GETCreditMemosEinvoiceDownload'
          type: array
      type: object
    GETDebitMemosEinvoiceDownload:
      allOf:
        - properties:
            processId:
              description: |
                Process Id of the validation error.
              type: string
            reasons:
              description: |
                Container for error reasons.
              items:
                $ref: '#/components/schemas/GETEinvoiceDownloadErrors'
            requestId:
              description: |
                Request Id for the validation error.
              type: string
    DebitMemosEinvoiceDownload:
      properties:
        success:
          description: |
            Stream the file contents.
        error:
          description: |
            Container for downloading Debit Memo.
          items:
            $ref: '#/components/schemas/GETDebitMemosEinvoiceDownload'
          type: array
      type: object
    PutCancelEInvoiceRequest:
      allOf:
        - properties:
            reason:
              description: |
                The reason code for cancelation.
              type: string
              enum:
                - '01'
                - '02'
                - '03'
                - '04'
            documentReferenceID:
              description: >
                The ID or number of the billing document that replaces the
                e-invoice being canceled. You can replace the canceled e-invoice
                with a new invoice or debit memo.


                **Note:** The documentReferenceID is applicable only for the
                reason 01 when you cancel E-Invoice for Mexico.
              type: string
      example:
        reason: '01'
        documentReferenceID: DM12345678
    GetEInvoiceFileTemplateResponse:
      allOf:
        - properties:
            content:
              description: >
                The content of the e-invoice file template, which must be
                encoded in Base64 format.
              type: string
            country:
              description: >
                The short name of a country or region where you must comply with
                e-invoicing requirements. For example, `IN` for India. For the
                full list of country names and codes, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
                target="_blank">View countries or regions</a>.
              type: boolean
            documentType:
              description: >
                The type of billing document for which the e-invoice file
                template is intended.
              enum:
                - Invoice
                - CreditMemo
                - DebitMemo
              type: string
            id:
              description: |
                The unique ID of the e-invoice file template.
              type: string
            name:
              description: |
                The name of the e-invoice file template.
              maxLength: 255
              type: string
            provider:
              description: >
                The name of the e-invoicing service provider that assists in
                generating e-invoice files for billing documents. 
              enum:
                - Sovos
              type: string
            templateNumber:
              description: |
                The unique number of the e-invoice file template.
              type: string
          title: templates
          type: object
    ListEInvoiceFileTemplatesResponse:
      properties:
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        templates:
          description: |
            Container for e-invoice file emplates.
          items:
            $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse'
          type: array
      type: object
    CreateEInvoiceFileTemplateRequest:
      allOf:
        - properties:
            content:
              description: >
                The content of the e-invoice file template, which must be
                encoded in Base64 format.
              type: string
            country:
              description: >
                The short name of a country or region where you must comply with
                e-invoicing requirements. For example, `IN` for India. For the
                full list of country names and codes, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
                target="_blank">View countries or regions</a>.
              type: string
            documentType:
              description: >
                The type of billing documents, which the e-invoice file template
                is intended for.
              enum:
                - Invoice
                - CreditMemo
                - DebitMemo
              type: string
            name:
              description: |
                The name of the e-invoice file template.
              maxLength: 255
              type: string
            provider:
              description: >
                The name of an e-invoicing service provider that assists in
                generating e-invoice files.
              enum:
                - Sovos
              type: string
          required:
            - country
            - documentType
            - provider
            - content
            - name
          type: object
      example:
        content: base64 encoded content
        country: IN
        documentType: Invoice
        name: Sovos e-invoice service
        provider: Sovos
    UpdateEInvoiceFileTemplateRequest:
      allOf:
        - properties:
            content:
              description: >
                The content of the e-invoice file template, which must be
                encoded in Base64 format.
              type: string
            country:
              description: >
                The short name of a country or region where you must comply with
                e-invoicing requirements. For example, `IN` for India. For the
                full list of country names and codes, see <a
                href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
                target="_blank">View countries or regions</a>.
              type: string
            documentType:
              description: >
                The type of billing documents, which the e-invoice file template
                is intended for.
              enum:
                - Invoice
                - CreditMemo
                - DebitMemo
              type: string
            name:
              description: |
                The name of the e-invoice file template.
              maxLength: 255
              type: string
            provider:
              description: >
                The name of an e-invoicing service provider that assists in
                generating e-invoice files.
              enum:
                - Sovos
              type: string
          type: object
      example:
        content: base64 encoded content
        country: IN
        documentType: Invoice
        name: Sovos e-invoice service
        provider: Sovos
    InvoiceScheduleItemCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Invoice Schedule Item object. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Invoice Schedule Item object.
      title: invoiceScheduleItemCustomFields
      type: object
    POSTScheduleItemType:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the invoice to be generated during the processing
                of the invoice schedule item. 


                You can only specify either the `amount` field or `percentage`
                field in one request. 
                  - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. 
                  - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount.            
              type: number
            name:
              description: |
                The name of the invoice schedule item.
              maxLength: 100
              type: string
            percentage:
              description: >
                The percentage of the total amount to be billed during the
                processing of the invoice schedule item. 


                You can only specify either the `amount` field or `percentage`
                field in one request. 
                  - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. 
                  - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount.
              type: number
              maximum: 100
            runDate:
              description: >
                The date in the tenant’s time zone when the invoice schedule
                item is planned to be processed to generate an invoice.



                When specifying run dates for invoice schedule items, consider
                that:

                - An invoice schedule item with a blank run date will not be
                executed.

                - You can only update the run date for an invoice schedule item
                in Pending status.

                - If the run date of an invoice schedule item is left empty, the
                dates of all subsequent invoice schedule items must also be
                blank.

                - You must specify run dates in chronological order for invoice
                schedule items.                  
              format: date
              type: string
            targetDateForAdditionalSubscriptions:
              description: >
                The date in the tenant's time zone used by the invoice schedule
                to determine which fixed-period regular charges to be billed
                together with the invoice schedule item. 


                The regular charges must come from the subscriptions specified
                in the `additionalSubscriptionsToBill` field.
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields'
        - {}
      title: scheduleItems
    InvoiceScheduleSpecificSubscriptions:
      properties:
        chargeNumbers:
          description: >
            A list of charges in the subscription that are chosen to be included
            in the invoice schedule.
          type: string
        orderKey:
          description: >
            The unique ID or number of the order associated with the invoice
            schedule.
          type: string
        subscriptionKey:
          description: >
            The unique number of the subscription contained in the order
            associated with the invoice schedule.
          type: string
      title: specificSubscriptions
      type: object
    InvoiceScheduleCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Invoice Schedule object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Invoice Schedule object.
      title: invoiceScheduleCustomFields
      type: object
    POSTCreateInvoiceScheduleRequest:
      allOf:
        - properties:
            accountKey:
              description: >
                The ID or number of the account associated with the invoice
                schedule.
              type: string
            additionalSubscriptionsToBill:
              description: >
                A list of the numbers of the subscriptions that need to be
                billed together with the invoice schedule. 


                One invoice schedule can have at most 600 additional
                subscriptions.
              items:
                type: string
              type: array
            invoiceSeparately:
              description: >
                Whether the invoice items created from the invoice schedule
                appears on a separate invoice when Zuora generates invoices.
              type: boolean
            notes:
              description: |
                Comments on the invoice schedule.
              maxLength: 255
              type: string
            orders:
              description: >
                A list of the IDs or numbers of the orders associated with the
                invoice schedule. One invoice schedule can be associated with at
                most 10 orders.
              items:
                type: string
              type: array
            scheduleItems:
              description: >
                Container for invoice schedule items. One invoice schedule can
                have at most 50 invoice schedule items.
              items:
                $ref: '#/components/schemas/POSTScheduleItemType'
              type: array
            specificSubscriptions:
              description: >
                A list of the numbers of specific subscriptions associated with
                the invoice schedule.


                - If the subscriptions specified in this field belong to the
                orders specified in the `orders` field, only the specific
                subscriptions instead of the orders are associated with the
                invoice schedule. 

                - If only the `orders` field is specified, all the subscriptions
                from the order are associated with the invoice schedule.


                Example:

                ```

                {
                  "orders": [
                    "O-00000001", "O-00000002"
                  ],
                  "specificSubscriptions": [
                    {
                      "orderKey": "O-00000001",
                      "subscriptionKey": "S-00000001"
                    }
                  ]
                }

                ```

                - For the order with number O-00000001, only subscription
                S-00000001 contained in the order is associated with the invoice
                schedule.

                - For the order with number O-00000002, all subscriptions
                contained in the order are associated with the invoice schedule.
              items:
                $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions'
              type: array
          type: object
        - $ref: '#/components/schemas/InvoiceScheduleCustomFields'
        - {}
      example:
        accountKey: A00000007
        additionalSubscriptionsToBill:
          - S-00000001
          - S-00000002
        invoiceSeparately: false
        notes: 2022 Billing Schedule
        orders:
          - O-00000007
          - O-00000008
        scheduleItems:
          - amount: 50000
            runDate: '2022-02-24'
            targetDateForAdditionalSubscriptions: '2022-02-24'
          - amount: 14000
            runDate: '2022-10-17'
            targetDateForAdditionalSubscriptions: '2022-10-17'
          - amount: 6200
            runDate: '2022-11-14'
            targetDateForAdditionalSubscriptions: '2022-11-14'
        specificSubscriptions:
          - orderKey: O-00000008
            subscriptionKey: S-00000008
    ScheduleItemsResponse:
      allOf:
        - properties:
            actualAmount:
              description: >
                The actual amount that needs to be billed during the processing
                of the invoice schedule item.


                By default, the actual amount is the same as the total amount.
                Even if order changes occur like Remove Product or Cancel
                Subscription, the value of the `amount` field keeps unchanged.
                The value of the `actualAmount` field reflects the actual amount
                to be billed.
              format: number
              type: string
            amount:
              description: >
                The amount of the invoice generated during the processing of the
                invoice schedule item.


                You can only specify either the `amount` field or `percentage`
                field in one request. 

                - If you choose to specify the `amount` field in the request,
                `null` is returned as the value of the `percentage` field in the
                corresponding response. 

                - If you choose to specify the `percentage` field in the
                request, the value of the `amount` field returned in the
                corresponding response is calculated based on the percentage of
                the total amount.


                The value of this field keeps unchanged once invoice schedule
                items are created. 
              format: number
              type: string
            creditMemoId:
              description: >
                The ID of the credit memo that is generated during the
                processing of the invoice schedule item.
              type: string
            id:
              description: |
                The unique ID of the invoice schedule item.
              type: string
            invoiceId:
              description: >
                The ID of the invoice that is generated during the processing of
                the invoice schedule item.
              type: string
            name:
              description: |
                The name of the invoice schedule item.
              maxLength: 100
              type: string
            percentage:
              description: >
                The percentage of the total amount to be billed during the
                processing of the invoice schedule item. 


                You can only specify either the `amount` field or `percentage`
                field in one request. 

                - If you choose to specify the `amount` field in the request,
                `null` is returned as the value of the `percentage` field in the
                corresponding response. 

                - If you choose to specify the `percentage` field in the
                request, the value of the `amount` field returned in the
                corresponding response is calculated based on the percentage of
                the total amount.
            runDate:
              description: >
                The date in the tenant’s time zone when the invoice schedule
                item is processed to generate an invoice.
              format: date
              type: string
            status:
              description: |
                The status of the invoice schedule item.
              enum:
                - Pending
                - Executing
                - Processed
              type: string
            targetDateForAdditionalSubscriptions:
              description: >
                The date in the tenant's time zone used by the invoice schedule
                to determine which fixed-period regular charges to be billed
                together with the invoice schedule item. 


                The regular charges must come from the subscriptions specified
                in the `additionalSubscriptionsToBill` field.
              format: date
              type: string
            organizationLabel:
              description: >
                Indicates the organization assigned to the Invoice Schedule Item
                for multi-org.
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields'
        - {}
      title: scheduleItems
    InvoiceScheduleResponses:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the customer account that the invoice schedule belongs
                to.
              type: string
            actualAmount:
              description: >
                The actual amount that needs to be billed during the processing
                of the invoice schedule.


                By default, the actual amount is the same as the total amount.
                Even if order changes occur like Remove Product or Cancel
                Subscription, the value of the `totalAmount` field keeps
                unchanged. The value of the `actualAmount` field reflects the
                actual amount to be billed.
              type: number
            additionalSubscriptionsToBill:
              description: >
                A list of the numbers of the subscriptions that need to be
                billed together with the invoice schedule. 


                One invoice schedule can have at most 600 additional
                subscriptions.
              items:
                type: string
              type: array
            billedAmount:
              description: >
                The amount that has been billed during the processing of the
                invoice schedule.
              type: number
            currency:
              description: >
                The currency of the billing documents generated during the
                processing of the invoice schedule.

                **Note**:  - This field is available only if you have the <a
                  href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
                  target="_blank">Multiple Currencies</a> feature enabled.

                - If you have the Multiple Currencies feature disabled, the
                corresponding account's default currency is always used.
              type: string
            id:
              description: |
                The unique ID of the invoice schedule.
              type: string
            invoiceSeparately:
              description: >
                Whether the invoice items created from the invoice schedule
                appears on a separate invoice when Zuora generates invoices.
              type: boolean
            nextRunDate:
              description: >
                The run date of the next execution of invoice schedule. By
                default, the next run date is the same as run date of next
                pending invoice schedule item. It can be overwritten with a
                different date other than the default value. When the invoice
                schedule has completed the execution, the next run date is null.
              format: date
              type: string
            notes:
              description: |
                Comments on the invoice schedule.
              maxLength: 255
              type: string
            number:
              description: |
                The sequence number of the invoice schedule.
              type: string
            orders:
              description: >
                A list of the IDs or numbers of the orders associated with the
                invoice schedule. One invoice schedule can be associated with at
                most 10 orders.
              items:
                type: string
              type: array
            scheduleItems:
              description: >
                Container for schedule items. One invoice schedule can have at
                most 50 invoice schedule items.
              items:
                $ref: '#/components/schemas/ScheduleItemsResponse'
              type: array
            specificSubscriptions:
              description: >
                A list of the numbers of specific subscriptions associated with
                the invoice schedule.
              items:
                $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions'
              type: array
            status:
              description: |
                The status of the invoice schedule.
              enum:
                - Pending
                - PartiallyProcessed
                - Paused
                - FullyProcessed
              type: string
            totalAmount:
              description: >
                The total amount that needs to be billed during the processing
                of the invoice schedule. 


                The value of this field keeps unchanged once invoice schedule
                items are created.
              type: number
            unbilledAmount:
              description: >
                The amount that is waiting to be billed during the processing of
                the invoice schedule.
              type: number
            organizationLabel:
              description: >
                Indicates the organization assigned to the Invoice Schedule for
                multi-org.
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceScheduleCustomFields'
        - {}
    UpdateScheduleItems:
      allOf:
        - properties:
            amount:
              description: >
                The amount of the invoice to be generated during the processing
                of the invoice schedule item. 


                You can only specify either the `amount` field or `percentage`
                field in one request. 

                - If you choose to specify the `amount` field in the request,
                `null` is returned as the value of the `percentage` field in the
                corresponding response. 

                - If you choose to specify the `percentage` field in the
                request, the value of the `amount` field returned in the
                corresponding response is calculated based on the percentage of
                the total amount.
              format: number
              type: string
            id:
              description: >
                The unique ID of the invoice schedule item to be updated. 


                If this field is not provided, a new invoice schedule item is
                added to the invoice schedule.
              type: string
            name:
              description: |
                The name of the invoice schedule item.
              maxLength: 100
              type: string
            percentage:
              description: >
                The percentage of the total amount to be billed during the
                processing of the invoice schedule item. 


                You can only specify either the `amount` field or `percentage`
                field in one request. 

                - If you choose to specify the `amount` field in the request,
                `null` is returned as the value of the `percentage` field in the
                corresponding response. 

                - If you choose to specify the `percentage` field in the
                request, the value of the `amount` field returned in the
                corresponding response is calculated based on the percentage of
                the total amount.              
            runDate:
              description: >
                The date in the tenant’s time zone when the invoice schedule
                item is planned to be processed to generate an invoice.
              format: date
              type: string
            targetDateForAdditionalSubscriptions:
              description: >
                The date in the tenant's time zone used by the invoice schedule
                to determine which fixed-period regular charges to be billed
                together with the invoice schedule item. 


                The regular charges must come from the subscriptions specified
                in the `additionalSubscriptionsToBill` field.
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields'
        - {}
      title: scheduleItems
    PUTUpdateInvoiceScheduleRequest:
      allOf:
        - properties:
            additionalSubscriptionsToBill:
              description: >
                A list of the numbers of the subscriptions that need to be
                billed together with the invoice schedule. 


                One invoice schedule can have at most 600 additional
                subscriptions.
              items:
                type: string
              type: array
            invoiceSeparately:
              description: >
                Whether the invoice items created from the invoice schedule
                appears on a separate invoice when Zuora generates invoices.
              type: boolean
            nextRunDate:
              description: >
                The run date of the next execution of the invoice schedule. 


                By default, the next run date is the same as the run date of
                next pending invoice schedule item. The date can be overwritten
                by a different date other than the default value. If the invoice
                schedule has completed the execution, the next run date is
                `null`.
              format: date
              type: string
            notes:
              description: |
                Comments on the invoice schedule.
              maxLength: 255
              type: string
            orders:
              description: >
                A list of the IDs or numbers of the orders associated with the
                invoice schedule. One invoice schedule can be associated with at
                most 10 orders.


                The orders specified in this field override all the existing
                orders associated with the invoice schedule.
              items:
                type: string
              type: array
            scheduleItems:
              description: >
                Container for invoice schedule items. The maximum number of
                schedule items is 50.


                The invoice schedule items specified in this field override all
                the existing invoice schedule items.
              items:
                $ref: '#/components/schemas/UpdateScheduleItems'
              type: array
            specificSubscriptions:
              description: >
                A list of the numbers of specific subscriptions associated with
                the invoice schedule.


                - If the subscriptions specified in this field belong to the
                orders specified in the `orders` field, only the specific
                subscriptions instead of the orders are associated with the
                invoice schedule. 

                - If only the `orders` field is specified, all the subscriptions
                from the order are associated with the invoice schedule.
                  
                The specific subscriptions specified in this field override all
                the existing specific subscriptions associated with the invoice
                schedule.


                Example:

                ```

                {
                  "orders": [
                    "O-00000001", "O-00000002"
                  ],
                  "specificSubscriptions": [
                    {
                      "orderKey": "O-00000001",
                      "subscriptionKey": "S-00000001"
                    }
                  ]
                }

                ```

                - For the order with number O-00000001, only subscription
                S-00000001 contained in the order is associated with the invoice
                schedule.

                - For the order with number O-00000002, all subscriptions
                contained in the order are associated with the invoice schedule.
              items:
                $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions'
              type: array
          type: object
        - $ref: '#/components/schemas/InvoiceScheduleCustomFields'
        - {}
      example:
        additionalSubscriptionsToBill:
          - S-00000001
          - S-00000002
        invoiceSeparately: false
        nextRunDate: '2022-02-01'
        notes: 2022 Billing Schedule - V2
        orders:
          - O-00000007
          - O-00000008
        scheduleItems:
          - amount: 54000
            id: 8a8881aa82118bec018211daf9f01680
            runDate: '2022-02-24'
            targetDateForAdditionalSubscriptions: '2022-02-24'
          - amount: 10000
            id: 8a8881aa82118bec018211daf9f11681
            runDate: '2022-10-17'
            targetDateForAdditionalSubscriptions: '2022-10-17'
          - amount: 6200
            id: 8a8881aa82118bec018211daf9f11682
            runDate: '2022-11-14'
            targetDateForAdditionalSubscriptions: '2022-11-14'
        specificSubscriptions:
          - orderKey: O-00000008
            subscriptionKey: S-00000008
    POSTExecuteInvoiceScheduleRequest:
      allOf:
        - properties:
            scheduleItemId:
              description: >
                The ID of the invoice schedule item to be executed.


                The item must be the earliest pending schedule item. If all the
                invoice schedule items have been processed and credit is needed
                to be generated, do not specify this field in the request.
              type: string
          type: object
        - {}
      example:
        scheduleItemId: 8ad09b7d82b5c62f0182c5cd16944f73
    BillRunFilters:
      allOf:
        - properties:
            accountId:
              description: |
                The target account of the bill run.
              type: string
            filterType:
              description: >
                The type of the filter to determine whether to create a bill run
                at the account level or subscription level.
              enum:
                - Account
                - Subscription
                - InvoiceSchedule
              type: string
            subscriptionId:
              description: >
                The unique ID of the target subscription belonged to the target
                account. 


                This field is required if you set the `filterType` field to
                `Subscription`.
              type: string
          type: object
        - {}
      title: billRunFilters
    ExecuteInvoiceScheduleBillRunResponse:
      allOf:
        - properties:
            autoEmail:
              description: >
                Whether to automatically send an email after Auto-Post is
                complete.
              type: boolean
            autoPost:
              description: >
                Whether to automatically post the bill run after the bill run is
                created.
              type: boolean
            autoRenewal:
              description: >
                Whether to automatically renew auto-renew subscriptions that are
                up for renewal.
              type: boolean
            batches:
              description: >
                A list of the batches of accounts for this bill run. 


                This field cannot exist with the `billRunFilters` field.


                **Values:** `AllBatches` or Batch*n* where *n* is a number
                between 1 and 50, for example, `Batch7`.
              items:
                type: string
              type: array
            billCycleDay:
              description: >
                The day of the bill cycle, this field is only valid when
                `batches` is specified.


                **Values:** 

                - `AllBillCycleDays` or 1 - 31 for an ad-hoc bill run 

                - `AllBillCycleDays` or 1 - 31 or `AsRunDay` for a scheduled
                bill run
              type: string
            billRunFilters:
              description: |
                A list of the target account or subscriptions for this bill run.

                This field cannot exist with the `batches` field.
              items:
                $ref: '#/components/schemas/BillRunFilters'
              type: array
            billRunNumber:
              description: |
                The number of bill run.
              type: string
            chargeTypeToExclude:
              description: >
                The types of the charges to be excluded from the generation of
                billing documents.
              items:
                enum:
                  - OneTime
                  - Recurring
                  - Usage
                type: string
              type: array
            createdById:
              description: |
                The ID of the user who created the bill run.
              type: string
            createdDate:
              description: |
                The date and time when the bill run was created.
              format: date-time
              type: string
            id:
              description: |
                The unique ID of the bill run.
              type: string
            invoiceDate:
              description: >
                The invoice date for this bill run, only valid for ad-hoc bill
                runs.
              format: date
              type: string
            invoiceDateOffset:
              description: >
                The offset compared to bill run execution date, only valid for
                scheduled bill runs.
              type: integer
            noEmailForZeroAmountInvoice:
              description: >
                Whether to suppress emails for invoices with the total amount of
                zero or not for this bill run after the bill run is complete. 


                **Note**: Do not email invoices with the total amount of zero.
              type: boolean
            organizationLabels:
              description: >
                The organization(s) that the object belongs to. 


                Note: This field is available only when the Multi-Org feature is
                enabled.            
              items:
                properties:
                  organizationId:
                    description: |
                      The organization ID.
                    type: string
                  organizationName:
                    description: |
                      The organization name.
                    type: string
                type: object
              type: array
            scheduledExecutionTime:
              description: |
                The scheduled execution time for a bill run.
              format: date-time
              type: string
            status:
              description: |
                The status of the bill run.
              enum:
                - Pending
                - Processing
                - Completed
                - Error
                - Canceled
                - Posted
                - PostInProgress
                - CancelInProgress
                - RemoveInProgress
                - Paused
              type: string
            targetDate:
              description: >
                The target date for this bill run, only valid for ad-hoc bill
                run.
              format: date
              type: string
            targetDateOffset:
              description: >
                The offset compared to bill run execution date, only valid for
                scheduled bill run.
              type: integer
            updatedById:
              description: |
                The ID of the user who updated the bill run.
              type: string
            updatedDate:
              description: |
                The date and time when the bill run was updated.
              format: date-time
              type: string
          type: object
        - {}
      example:
        autoEmail: false
        autoPost: false
        autoRenewal: false
        billRunFilters:
          - accountId: 2c9081a03c63c94c013c66688a2c00bf
            filterType: Subscription
            subscriptionId: 402882297e387c51017e38a245c313db
        billRunNumber: BR-00000016
        chargeTypeToExclude:
          - OneTime
          - Usage
        createdById: ff808081298c6e5401298c7274a40005
        createdDate: '2022-01-24 19:58:27'
        id: 2c9890077e8a8490017e8bf3a5171a43
        invoiceDate: '2020-02-01'
        noEmailForZeroAmountInvoice: false
        status: Pending
        success: true
        targetDate: '2020-02-01'
        updatedById: ff808081298c6e5401298c7274a40005
        updatedDate: '2022-01-24 19:58:27'
    DetachInvoiceScheduleRequest:
      example:
        specificSubscriptions:
          - orderKey: O-00017019
            subscriptionKey: A-S00008953
            chargeNumbers:
              - C-00065317
      properties:
        specificSubscriptions:
          description: >
            A list of charge numbers to be detached from the invoice schedule.


            Each item in this array represents a specific subscription
            associated with the invoice schedule. Use the `chargeNumbers` field
            to specify all the charges you want to detach for each subscription.
          items:
            type: object
            properties:
              chargeNumbers:
                description: >
                  A list of charge numbers in the subscription to be detached
                  from the invoice schedule.


                  If you want to detach all charges, you must specify all of the
                  charge numbers in this field.
                type: string
              orderKey:
                description: >
                  The unique ID or number of the order associated with the
                  invoice schedule.
                type: string
              subscriptionKey:
                description: >
                  The unique number of the subscription contained in the order
                  associated with the invoice schedule.
                type: string
            title: specificSubscriptions
          type: array
      type: object
    AttachInvoiceScheduleRequest:
      example:
        specificSubscriptions:
          - orderKey: O-00017019
            subscriptionKey: A-S00008953
            chargeNumbers:
              - C-00065317
      properties:
        specificSubscriptions:
          description: >
            A list of charge numbers to be attached to the invoice schedule.


            Each item in this array represents a specific subscription
            associated with the invoice schedule. Use the `chargeNumbers` field
            to specify all the charges you want to attach for each subscription.
          items:
            type: object
            properties:
              chargeNumbers:
                description: >
                  A list of charge numbers in the subscription to be attached to
                  the invoice schedule.


                  If you want to attach all charges, you must specify all of the
                  charge numbers in this field.
                type: string
              orderKey:
                description: >
                  The unique ID or number of the order associated with the
                  invoice schedule.
                type: string
              subscriptionKey:
                description: >
                  The unique number of the subscription contained in the order
                  associated with the invoice schedule.
                type: string
            title: specificSubscriptions
          type: array
      type: object
    ProxyCreateTaxationItem:
      allOf:
        - properties:
            AccountingCode:
              description: ' The Chart of Accounts '
              type: string
            ExemptAmount:
              description: |2-
                 The calculated tax amount excluded due to the exemption.
                **Character limit**: 16 **Values**: a decimal value 
              format: double
              type: number
            InvoiceItemId:
              description: |2-
                 The ID of the specific invoice item that the taxation information applies to.
                **Character limit**: 32 **Values**: a valid invoice item ID 
              type: string
            Jurisdiction:
              description: >2-
                 The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.
                **Character limit**: 32 **Values**: a string of 32 characterrs
                or fewer 
              type: string
            LocationCode:
              description: |2-
                 The identifier for the location based on the value of the `TaxCode` field.
                **Character limit**: 32 **Values**: automatically generated 
              type: string
            Name:
              description: >2-
                 The name of the tax rate, such as sales tax or GST. This name is displayed on invoices.
                **Character limit**: 128 **Values**: a string of 128 characters
                or fewer 
              type: string
            TaxAmount:
              description: |2-
                 The amount of the tax applied to the charge.
                **Character limit**: 16 **Values**: a decimal value 
              format: double
              type: number
            TaxCode:
              description: >2-
                 The tax code identifies which tax rules and tax rates to apply to a specific charge.
                **Character limit**: 32 **Values**: a string of 32 characters or
                fewer 
              type: string
            TaxCodeDescription:
              description: >2-
                 The description for the tax code.
                **Character limit**: 255 **Values**: a string of 255 characters
                or fewer 
              type: string
            TaxDate:
              description: |2-
                 The date that the tax is applied to the charge, in `yyyy-mm-dd` format.
                **Character limit**: 29 
              format: date
              type: string
            TaxRate:
              description: |2-
                 The tax rate applied to the charge.
                **Character limit**: 16 **Values**: a valid decimal value 
              format: double
              type: number
            TaxRateDescription:
              description: >2-
                 The description of the tax rate.
                **Character limit**: 255 **Values**: a string of 255 characters
                or fewer 
              type: string
            TaxRateType:
              description: |2-
                 The type of the tax rate applied to the charge.
                **Character limit**: 10 **Values**: `Percentage`, `FlatFee` 
              type: string
          required:
            - InvoiceItemId
            - Jurisdiction
            - Name
            - TaxAmount
            - TaxRate
            - TaxDate
            - TaxRateType
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
      example:
        InvoiceItemId: 8ad086fa92d66ffe0192dc7e5dd65161
        Jurisdiction: CALIFORNIA
        Name: CA TAX
        TaxAmount: 3
        TaxDate: '2024-11-04'
        TaxRate: 3
        TaxRateType: FlatFee
    GETTaxationItemType:
      allOf:
        - properties:
            createdById:
              description: |
                The ID of the Zuora user who created the taxation item. 
              type: string
            createdDate:
              description: >
                The date and time when the taxation item was created in the
                Zuora system, in `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  type: string
                onAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to an on account
                    in your accounting system.
                  type: string
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  type: string
                salesTaxPayableAccountingCodeType:
                  description: |
                    The type of the accounting code for the sales taxes payable.
                  type: string
              type: object
            id:
              description: |
                The ID of the taxation item.
              type: string
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field. 
              type: string
            memoItemId:
              description: >
                The ID of the credit or debit memo associated with the taxation
                item.
              type: string
            name:
              description: |
                The name of the taxation item.
              type: string
            sourceTaxItemId:
              description: >
                The ID of the taxation item of the invoice, which the credit or
                debit memo is created from.
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            taxAmount:
              description: |
                The amount of the tax applied to the credit or debit memo.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific credit or debit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: |
                The date when the tax is applied to the credit or debit memo.
              format: date
              type: string
            taxRate:
              description: |
                The tax rate applied to the credit or debit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate.
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the credit or debit memo.
              enum:
                - Percentage
                - FlatFee
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the taxation item.
              type: string
            updatedDate:
              description: >
                The date and time when the taxation item was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. 
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
    PUTTaxationItemType:
      allOf:
        - properties:
            exemptAmount:
              description: |
                The calculated tax amount excluded due to the exemption.
              format: double
              type: number
            financeInformation:
              description: >
                Container for the finance information related to the taxation
                item.
              properties:
                onAccountAccountingCode:
                  description: >
                    The accounting code that maps to an on account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                salesTaxPayableAccountingCode:
                  description: |
                    The accounting code for the sales taxes payable.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            jurisdiction:
              description: >
                The jurisdiction that applies the tax or VAT. This value is
                typically a state, province, county, or city.
              type: string
            locationCode:
              description: >
                The identifier for the location based on the value of the
                `taxCode` field. 
              type: string
            name:
              description: |
                The name of the taxation item to be updated.
              type: string
            taxAmount:
              description: |
                The amount of the tax applied to the credit or debit memo.
              format: double
              type: number
            taxCode:
              description: >
                The tax code identifies which tax rules and tax rates to apply
                to a specific credit or debit memo.
              type: string
            taxCodeDescription:
              description: |
                The description of the tax code.
              type: string
            taxDate:
              description: |
                The date when the tax is applied to the credit or debit memo.
              format: date
              type: string
            taxRate:
              description: |
                The tax rate applied to the credit or debit memo.
              format: double
              type: number
            taxRateDescription:
              description: |
                The description of the tax rate. 
              type: string
            taxRateType:
              description: |
                The type of the tax rate applied to the credit or debit memo.
              enum:
                - Percentage
                - FlatFee
              type: string
          type: object
        - $ref: '#/components/schemas/TaxationItemObjectCustomFields'
      example:
        taxRateDescription: Details of the tax rate
    CreditMemoEntityPrefix:
      description: >
        Container for the prefix and starting document number of credit memos.


        **Note:** This field is only available if you have the Invoice
        Settlement feature enabled. The Invoice Settlement feature is generally
        available as of Zuora Billing Release 296 (March 2021). This feature
        includes Unapplied Payments, Credit and Debit Memo, and Invoice Item
        Settlement. If you want to enable Invoice Settlement, see [Invoice
        Settlement Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.
      properties:
        prefix:
          description: |
            The prefix of credit memos.
          example: CM
          type: string
        startNumber:
          description: |
            The starting document number of credit memos.
          example: 10
          type: integer
      title: creditMemo
      type: object
    DebitMemoEntityPrefix:
      description: >
        Container for the prefix and starting document number of debit memos.


        **Note:** This field is only available if you have the Invoice
        Settlement feature enabled. The Invoice Settlement feature is generally
        available as of Zuora Billing Release 296 (March 2021). This feature
        includes Unapplied Payments, Credit and Debit Memo, and Invoice Item
        Settlement. If you want to enable Invoice Settlement, see [Invoice
        Settlement Enablement and Checklist
        Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
        for more information.
      properties:
        prefix:
          description: |
            The prefix of debit memos.
          example: DM
          type: string
        startNumber:
          description: |
            The starting document number of debit memos.
          example: 10
          type: integer
      title: debitMemo
      type: object
    InvoiceEntityPrefix:
      description: |
        Container for the prefix and starting document number of invoices.
      properties:
        prefix:
          description: |
            The prefix of invoices.
          example: INV
          type: string
        startNumber:
          description: |
            The starting document number of invoices.
          example: 10
          type: integer
      title: Invoice
      type: object
    PaymentEntityPrefix:
      description: |
        Container for the prefix and starting number of payments.
      properties:
        prefix:
          description: |
            The prefix of payments.
          example: P-
          type: string
        startNumber:
          description: |
            The starting number of payments.
          example: 10
          type: integer
      title: payment
      type: object
    RefundEntityPrefix:
      description: |
        Container for the prefix and starting number of refunds.
      properties:
        prefix:
          description: |
            The prefix of refunds.
          example: R-
          type: string
        startNumber:
          description: |
            The starting number of refunds.
          example: 10
          type: integer
      title: refund
      type: object
    GETSequenceSetResponse:
      description: ''
      properties:
        creditMemo:
          $ref: '#/components/schemas/CreditMemoEntityPrefix'
        debitMemo:
          $ref: '#/components/schemas/DebitMemoEntityPrefix'
        id:
          description: >
            The unique ID of the sequence set. For example,
            402892c74c9193cd014c96bbe7c101f9.
          type: string
        invoice:
          $ref: '#/components/schemas/InvoiceEntityPrefix'
        name:
          description: |
            The name of the sequence set.
          type: string
        payment:
          $ref: '#/components/schemas/PaymentEntityPrefix'
        refund:
          $ref: '#/components/schemas/RefundEntityPrefix'
      title: sequenceSets
      type: object
    GETSequenceSetsResponse:
      description: ''
      properties:
        sequenceSets:
          description: >
            Array of sequence sets configured for billing documents, payments,
            and refunds.
          items:
            $ref: '#/components/schemas/GETSequenceSetResponse'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    POSTSequenceSetRequest:
      description: ''
      properties:
        creditMemo:
          $ref: '#/components/schemas/CreditMemoEntityPrefix'
        debitMemo:
          $ref: '#/components/schemas/DebitMemoEntityPrefix'
        invoice:
          $ref: '#/components/schemas/InvoiceEntityPrefix'
        name:
          description: >
            The name of the sequence set to configure for billing documents,
            payments, and refunds.
          example: FRANCE
          type: string
        payment:
          $ref: '#/components/schemas/PaymentEntityPrefix'
        refund:
          $ref: '#/components/schemas/RefundEntityPrefix'
      required:
        - name
        - invoice
        - creditMemo
        - debitMemo
      title: sequenceSets
      type: object
    POSTSequenceSetsRequest:
      description: ''
      example:
        sequenceSets:
          - name: FR
            creditMemo:
              prefix: FCM
              startNumber: 10
            debitMemo:
              prefix: FDM
              startNumber: 10
            invoice:
              prefix: FINV
              startNumber: 10
            payment:
              prefix: FP-
              startNumber: 10
            refund:
              prefix: FR-
              startNumber: 10
      properties:
        sequenceSets:
          description: >
            Array of sequence sets configured for billing documents, payments,
            and refunds.
          items:
            $ref: '#/components/schemas/POSTSequenceSetRequest'
          type: array
      type: object
    POSTSequenceSetsResponse:
      description: ''
      properties:
        sequenceSets:
          description: >
            Array of sequence sets configured for billing documents, payments,
            and refunds.
          items:
            $ref: '#/components/schemas/GETSequenceSetResponse'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          example: true
          type: boolean
      type: object
    PUTSequenceSetRequest:
      description: ''
      example:
        creditMemo:
          prefix: FR-CM
      properties:
        creditMemo:
          $ref: '#/components/schemas/CreditMemoEntityPrefix'
        debitMemo:
          $ref: '#/components/schemas/DebitMemoEntityPrefix'
        invoice:
          $ref: '#/components/schemas/InvoiceEntityPrefix'
        name:
          description: >
            The name of the sequence set configured for billing documents,
            payments, and refunds.
          type: string
        payment:
          $ref: '#/components/schemas/PaymentEntityPrefix'
        refund:
          $ref: '#/components/schemas/RefundEntityPrefix'
      type: object
    PUTSequenceSetResponse:
      description: ''
      properties:
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    PostBillingPreviewParam:
      example:
        accountId: 8ad09bce83f1da020183f97e245c1c47
        targetDate: '2024-09-30'
      properties:
        accountId:
          description: >
            The ID of the customer account to which the billing preview applies.


            **Note**: When posting billing preview, you must specify either
            `accountId` or `accountNumber` in the request body.
          maxLength: 255
          type: string
        accountNumber:
          description: >
            The number of the customer account to which the billing preview
            applies.


            **Note**: When posting billing preview, you must specify either
            `accountId` or `accountNumber` in the request body.
          type: string
        assumeRenewal:
          description: >
            Indicates whether to generate a preview of future invoice items and
            credit memo items with the assumption that the subscriptions are
            renewed.


            Set one of the following values in this field to decide how the
            assumption is applied in the billing preview.

              * **All:** The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.
              
              * **None:** (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date.
              
                * If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date.

                * If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.

              * **Autorenew:** The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.

            **Note:** 
              - This field can only be used if the subscription renewal term is not set to 0.  
              
              
              - The credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.
          type: string
        chargeTypeToExclude:
          description: >
            The charge types to exclude from the billing preview.


            **Possible values:** OneTime, Recurring, Usage, and any combination
            of these values.
          type: string
        includingDraftItems:
          description: >
            Whether draft document items are included in the billing preview
            run. By default, draft document items are not included.


            This field loads draft invoice items and credit memo items. The
            `chargeTypeToExclude`, `targetDate`,
            `includingEvergreenSubscription`, and `assumeRenewal` fields do not
            affect the behavior of the `includingDraftItems` field.          
          type: boolean
        includingEvergreenSubscription:
          description: >
            Indicates if evergreen subscriptions are included in the
            billingPreview call.
          type: boolean
        targetDate:
          description: >
            The target date for the billingPreview call. The billingPreview call
            generates preview invoice item data and credit memo item data from
            the first day of the customer's next billing period to the
            TargetDate. 


            If the TargetDate is later than the subscription current term end
            date, the preview invoice item data and credit memo item data is
            generated from the first day of the customer's next billing period
            to the current term end date. If you want to generate preview
            invoice item data and credit memo item data past the end of the
            subscription current term, specify the `AssumeRenewal` field in the
            request.



            **Note:** The credit memo item data is only available if you have
            Invoice Settlement feature enabled. The Invoice Settlement feature
            is generally available as of Zuora Billing Release 296 (March 2021).
            This feature includes Unapplied Payments, Credit and Debit Memo, and
            Invoice Item Settlement. If you want to enable Invoice Settlement,
            see [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          format: date
          type: string
      required:
        - targetDate
      type: object
    POSTBillingPreviewCreditMemoItem:
      properties:
        amount:
          description: >
            The amount of the credit memo item. For tax-inclusive credit memo
            items, the amount indicates the credit memo item amount including
            tax. For tax-exclusive credit memo items, the amount indicates the
            credit memo item amount excluding tax
          format: double
          type: number
        amountWithoutTax:
          description: |
            The credit memo item amount excluding tax.
          format: double
          type: number
        appliedToItemId:
          description: >
            The unique ID of the credit memo item that the discount charge is
            applied to.
          type: string
          nullable: true
        chargeDate:
          description: |
            The date when the credit memo item is created.
          format: date-time
          type: string
        chargeNumber:
          description: |
            Number of the charge.
          type: string
        chargeType:
          description: |
            The type of charge. 

            Possible values are `OneTime`, `Recurring`, and `Usage`.
          type: string
        comment:
          description: |
            Comment of the credit memo item.
          type: string
        id:
          description: |
            Credit memo item id.
          type: string
        numberOfDeliveries:
          description: >
            The number of deliveries dedicated to the Delivery Pricing charges. 

            **Note**: This field is available only if you have the Delivery
            Pricing feature enabled.  
          type: number
        processingType:
          description: |
            Identifies the kind of charge. 

            Possible values:
            * charge
            * discount
            * prepayment
            * tax
          type: string
        quantity:
          description: >
            Quantity of this item, in the configured unit of measure for the
            charge.
          format: decimal
          type: string
        ratePlanChargeId:
          description: |
            Id of the rate plan charge associated with this item.
          type: string
        serviceEndDate:
          description: >
            End date of the service period for this item, i.e., the last day of
            the service period, in yyyy-mm-dd format.
          format: date
          type: string
        serviceStartDate:
          description: >
            Start date of the service period for this item, in yyyy-mm-dd
            format. If the charge is a one-time fee, this is the date of that
            charge.
          format: date
          type: string
        sku:
          description: |
            Unique SKU for the product associated with this item.
          type: string
        skuName:
          description: |
            Name of the unique SKU for the product associated with this item.
          type: string
        subscriptionId:
          description: |
            ID of the subscription associated with this item.
          type: string
        subscriptionNumber:
          description: |
            Name of the subscription associated with this item.
          type: string
        unitOfMeasure:
          description: |
            Unit used to measure consumption.
          type: string
      title: creditMemoItems
      type: object
    POSTBillingPreviewInvoiceItem:
      properties:
        appliedToItemId:
          description: >
            The unique ID of the invoice item that the discount charge is
            applied to.
          type: string
          nullable: true
        chargeAmount:
          description: >
            The amount of the charge. This amount doesn't include taxes
            regardless if the charge's tax mode is inclusive or exclusive.
          format: decimal
          type: string
        chargeDate:
          description: |
            The date when the invoice item was created.
          format: date-time
          type: string
        chargeDescription:
          description: |
            Description of the charge.
          type: string
        chargeId:
          description: |
            Id of the charge.
          type: string
        chargeName:
          description: |
            Name of the charge.
          type: string
        chargeNumber:
          description: |
            Number of the charge.
          type: string
        chargeType:
          description: |
            The type of charge. 

            Possible values are `OneTime`, `Recurring`, and `Usage`.
          type: string
        id:
          description: |
            Invoice item ID.
          type: string
        numberOfDeliveries:
          description: >
            The number of deliveries dedicated to the Delivery Pricing charges. 

            **Note**: This field is available only if you have the Delivery
            Pricing feature enabled. 
          type: number
        processingType:
          description: |
            Identifies the kind of charge. 

            Possible values:
            * charge
            * discount
            * prepayment
            * tax
          type: string
        productName:
          description: |
            Name of the product associated with this item.
          type: string
        quantity:
          description: >
            Quantity of this item, in the configured unit of measure for the
            charge.
          format: decimal
          type: string
        serviceEndDate:
          description: >
            End date of the service period for this item, i.e., the last day of
            the service period, in `yyyy-mm-dd` format.
          format: date
          type: string
        serviceStartDate:
          description: >
            Start date of the service period for this item, in `yyyy-mm-dd`
            format. If the charge is a one-time fee, this is the date of that
            charge.
          format: date
          type: string
        subscriptionId:
          description: |
            ID of the subscription associated with this item.
          type: string
        subscriptionName:
          description: |
            Name of the subscription associated with this item.
          type: string
        subscriptionNumber:
          description: |
            Number of the subscription associated with this item.
          type: string
        taxAmount:
          description: >
            If you use [Zuora
            Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax)
            and the product rate plan charge associated with the invoice item is
            of [tax inclusive
            mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode),
            the value of this field is the amount of tax applied to the charge.
            Otherwise, the value of this field is `0`. 
          format: decimal
          type: string
        unitOfMeasure:
          description: |
            Unit used to measure consumption.
          type: string
      title: invoiceItems
      type: object
    BillingPreviewResult:
      properties:
        accountId:
          description: |
            ID of the customer account to which the billing preview applies.
          type: string
        creditMemoItems:
          description: >
            An array of credit memo items returned as the result of the billing
            preivew request.


            **Note:** The credit memo items are only available if you have
            Invoice Settlement feature enabled. The Invoice Settlement feature
            is generally available as of Zuora Billing Release 296 (March 2021).
            This feature includes Unapplied Payments, Credit and Debit Memo, and
            Invoice Item Settlement. If you want to enable Invoice Settlement,
            see [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: '#/components/schemas/POSTBillingPreviewCreditMemoItem'
          type: array
        invoiceItems:
          description: >
            An array of invoice items returned as the result of the billing
            preview request.
          items:
            $ref: '#/components/schemas/POSTBillingPreviewInvoiceItem'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTInvoiceCollectType:
      example:
        accountKey: 4028925a4cb74ec9014cb7520fc00005
        invoiceId: 4028925a4cb74ec9014cb7540988002e
      properties:
        accountKey:
          description: |
            Customer account ID or account number.
          type: string
        documentDate:
          description: >
            The date that should appear on the invoice and credit memo being
            generated,

            in `yyyy-mm-dd` format. If this field is omitted

            and `invoiceId` is not specified, the current date is used by
            default. 



            **Note:** The credit memo is only available if you have the Invoice
            Settlement feature enabled.



            **Note**: This field is available only if you are on the latest
            Zuora API version, or you set the `Zuora-Version` request header to
            `215.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          format: date
          type: string
        invoiceId:
          description: >
            The ID or number of an existing invoice for which to collect payment
            using

            the account's default payment method. If this value is specified, no
            new

            invoice is generated, and the following fields are ignored:
              - `invoiceDate` and `invoiceTargetDate` (if the Zuora minor API version is 214.0 or earlier)
              - `documentDate` and `targetDate` (if the Zuora minor API version is 215.0 or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version))
          type: string
        paymentGateway:
          description: >
            The name of the gateway that will be used for the payment. Must be a
            valid gateway name and the gateway must support the specific payment
            method. If a value is not specified, the default gateway on the
            Account will be used.
          type: string
        targetDate:
          description: >
            The date through which to calculate charges on this account if an
            invoice or a credit memo is generated, in `yyyy-mm-dd` format. If
            this field is omitted and `invoiceId` is not specified, the current
            date is used by default. 

            This field is available only if you are on the latest Zuora API
            version, or you set the `Zuora-Version` request header to `215.0` or
            [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).


            **Note:** The credit memo is only available if you have the Invoice
            Settlement feature enabled.
          format: date
          type: string
      required:
        - accountKey
      type: object
    POSTInvoiceCollectCreditMemosType:
      properties:
        id:
          description: |
            The ID of the credit memo.
          type: string
        totalAmount:
          description: |
            The amount of the credit memo.
          format: double
          type: number
        memoNumber:
          description: |
            The unique identification number of the credit memo.
          type: string
      title: creditMemos
      type: object
    POSTInvoiceCollectInvoicesType:
      properties:
        invoiceAmount:
          description: |
            The amount of the invoice.
          format: decimal
          type: string
        invoiceId:
          description: |
            The ID of the invoice.
          type: string
        invoiceNumber:
          description: |
            The unique identification number of the invoice.
          type: string
      title: invoices
      type: object
    POSTInvoiceCollectResponseType:
      properties:
        amountCollected:
          description: |
            Payment amount applied.
          format: double
          type: number
        creditMemos:
          description: >
            Information on one or more credit memos associated with this
            operation.
          items:
            $ref: '#/components/schemas/POSTInvoiceCollectCreditMemosType'
          type: array
        invoices:
          description: |
            Information on one or more invoices associated with this operation.
          items:
            $ref: '#/components/schemas/POSTInvoiceCollectInvoicesType'
          type: array
        paymentId:
          description: |
            Payment ID.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GetOperationJobResponseType:
      properties:
        id:
          description: |
            The ID of the operation job to retrieve information about.
          type: string
        objectId:
          description: |
            The ID of the business object which is being operated.
          type: string
        objectType:
          description: |
            The object type of the job. 
          enum:
            - Invoice
          type: string
        operationType:
          description: |
            The operation type of the job.
          enum:
            - Delete
            - Reverse
          type: string
        reasons:
          items:
            properties:
              code:
                description: |
                  The error code of the response.
                type: string
              message:
                description: |
                  The detail information of the error response.
                type: string
            type: object
          type: array
        status:
          description: |
            The status of the operation job. 
          enum:
            - Pending
            - Processing
            - Failed
            - Completed
          type: string
        success:
          description: |
            Whether the call succeeded.
          type: boolean
      type: object
    DocumentList:
      example:
        docType: Invoice
        objectIds:
          - 402880de8ce7edc3018ce7f18404315a
          - 402880de8ce7edc3018ce7f18e0b3804
      properties:
        docType:
          description: The type of billing document.
          enum:
            - Invoice
            - CreditMemo
            - DebitMemo
          type: string
        objectIds:
          description: The collection of billing document IDs.
          items:
            type: string
          type: array
      type: object
    POSTBulkPdfGenerationJobRequestType:
      allOf:
        - type: object
          required:
            - documents
            - fileName
            - indexFileFormat
          example:
            documents:
              - docType: Invoice
                objectIds:
                  - 402880de8ce7edc3018ce7f18404315a
                  - 402880de8ce7edc3018ce7f18e0b3804
            fileName: all-invoices-posted-jan-2024
            name: BulkPDFGenerationJobV1
            indexFileFormat: JSON
            generateMissingPDF: true
            ignoreArchivedFiles: true
          properties:
            documents:
              description: >
                An array that contains a collection of objects where each object
                contains billing document type and their IDs.
              items:
                $ref: '#/components/schemas/DocumentList'
              type: array
            fileName:
              description: >
                The prefix part of output file name(s). The response will
                include multiple file URLs. The number of zip files generated
                corresponds to the number of invoice IDs. Each zip file contains
                up to 1000 document IDs.

                Eg: 
                  if fileName is "all-invoices-posted-jan-2024" then fileURL(s) will start with the file name followed by an underscore and a number. For instance, all-invoices-posted-jan-2024_1.zip, all-invoices-posted-jan-2024_2.zip, and so on.
              type: string
              maxLength: 32
            name:
              description: |
                The name of the job.
              type: string
              maxLength: 32
            indexFileFormat:
              description: >
                The format of the index file. It contains the metadata about the
                files and their contents.
              enum:
                - JSON
                - CSV
              type: string
            generateMissingPDF:
              description: >
                This flag controls the behavior of whether to generate PDF(s)
                for billing documents that do not already have one.

                  - setting it to true indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF,
                  generate them all at once, and then proceed to the zipping process.

                  - setting it to false indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF,
                  mark them as Invalid, and skip them from the zipping process. IDs marked as invalid will be included in the response.

                The default value is false.
              type: boolean
            ignoreArchivedFiles:
              description: >
                Ignores archived PDF files during export without causing the
                entire job request to fail when enabled. 
              type: boolean
            persistIndexFile:
              description: >
                Controls the generation of the index file, allowing you to
                efficiently handle high volumes of requests. By default, this
                field is set to `true`.  
                  - When set to `true`, the index file is generated and included in the zip file.
                  - When set to `false`, the index file is not generated and consequently not included in the zip file. 
              type: boolean
    POSTBulkPdfGenerationJobResponseType:
      example:
        jobId: 402880de8ce7edc3018ce7f18404312a
        invalidIds: []
        success: true
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            jobId:
              description: |
                Unique Id for the Job Triggered.
              type: string
            invalidIds:
              description: |
                Collection of Ids that are not valid. 

                 Id is considered to be invalid if,
                  
                  * Billing Document Id doesn't exist in the database for the corresponding Billing Document Type
                  * generateMissingPDF property is false in the Job Request and Valid PDF doesn't exist for the Billing Document Id
            skippedDocuments:
              description: >
                The `skippedDocuments` array will be empty unless archived files
                are marked to skip during job creation.
              items:
                type: object
                properties:
                  docType:
                    description: |
                      The document type of the skipped document.
                    enum:
                      - Invoice
                      - CreditMemo
                      - DebitMemo
                    type: string
                  objectIds:
                    description: |
                      The IDs of the skipped document objects.
                    type: array
                    items:
                      type: string
              type: array
          type: object
    GETBulkpdfGenerationJobResponseType:
      example:
        jobId: 402880de8ce7edc3018ce7f18404312a
        jobName: BulkPDFGenerationJobV1
        status: Completed
        stepStatus: PostProcessing
        fileUrls:
          - >-
            https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99
          - >-
            https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99
        createdOn: '2024-01-08 12:52:05'
        createdBy: caf630704a6f4100818601625ecffe0b
        success: true
      properties:
        jobId:
          description: Unique Id for the Triggered Job
          type: string
        jobName:
          description: Name of the Job provided during the POST request of the Job
          type: string
        status:
          description: Status of the job
          enum:
            - Submitted
            - Executing
            - Completed
            - Error
            - Aborted
            - Cancelled
          type: string
        stepStatus:
          description: Status of the Current Step that the Job is undergoing
          enum:
            - JobCreated
            - TasksCreated
            - GenerateMissPDF
            - PdfToZip
            - PostProcessing
          type: string
        fileUrls:
          description: Collection of S3 Pre-Signed URL(s) that can be downloaded
          items:
            type: string
          type: array
        failedDocuments:
          description: >-
            Array of objects where each object contains billing document type
            and the IDs which failed to execute.
          items:
            $ref: '#/components/schemas/DocumentList'
          type: array
        createdOn:
          description: Job Created Time
          type: string
        createdBy:
          description: Id of the user who created the job
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    Condition:
      allOf:
        - description: >-
            Container for condition information about the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Automate_billing_document_generation/Bill_runs/Bill_Run_Advanced_Filter"
            target="_blank">Bill Run Advanced Filter</a>.
          properties:
            conditions:
              description: >
                Multiple `conditions` fields are combined by the `relation`
                fields. These `conditions` fields form a custom filter.

                Each `conditions` field is a formula combined by the `field`,
                `operator`, and `value` fields. See <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Automate_billing_document_generation/Bill_runs/Bill_Run_Advanced_Filter/B_Common_use_cases_of_Bill_Run_Advanced_Filter"
                target="_blank">Common use cases of Bill Run Advanced
                Filter</a>.
              type: array
              items:
                $ref: '#/components/schemas/Condition'
            field:
              description: >
                The field name of a single condition that is indicated by the
                `conditions` field.
              type: string
            operator:
              description: >
                The operator of a single condition that is indicated by the
                `conditions` field.  The operator is added between the `field`
                and `value` fields.

                - eq: equal (`field` = `value`)

                - neq: not equal (`field` != `value`) 

                - gt: greater than (`field` > `value`) 

                - lt: less than (`field` < `value`) 

                - gte: greater than or equal (`field` >= `value`)

                - lte: less than or equal (`field` <= `value`)

                - lk: like (`field` like `value`) 

                - in: in (`field` in `value`, the values are separated by comma)

                - nl: null (`field` is null)

                - nnl: not null (`field` is not null)
              type: string
              enum:
                - eq
                - neq
                - gt
                - lt
                - gte
                - lte
                - lk
                - in
                - nl
                - nnl
            relation:
              description: |
                The relation among the `conditions` fields.
              type: string
              enum:
                - and
                - or
            value:
              description: >
                The value of a single condition that is indicated by the
                `conditions` field.
              type: string
          type: object
          title: Condition
    BillRunFilterRequestType:
      allOf:
        - properties:
            accountId:
              description: >
                The target account of the bill run. 


                If multiple subscriptions are specified, the account ID must be
                the same.
              type: string
            filterType:
              description: |
                To create bill runs based on the selected filter type:
                  - `Account`: Create bill runs by account. 
                  - `Subscription`: Create bill runs by subscription, you must specify the `subscriptionId` field.
                  - `FilterCondition`: Create bill runs by custom filter combining the Account, Subscription, and Rate Plan objects, you must specify the `condition` and `objectType` fields. See <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Automate_billing_document_generation/Bill_runs/Bill_Run_Advanced_Filter" target="_blank">Bill Run Advanced Filter</a>.
              enum:
                - Account
                - Subscription
                - FilterCondition
              type: string
            condition:
              $ref: '#/components/schemas/Condition'
            objectType:
              description: >
                The target object type of the condition when the `filterType`
                field is specified as `FilterCondition`. See <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Automate_billing_document_generation/Bill_runs/Bill_Run_Advanced_Filter"
                target="_blank">Bill Run Advanced Filter</a>.
              type: string
              enum:
                - Account
                - Subscription
                - RatePlanCharge
            subscriptionId:
              description: >
                The target subscripiton ID of the account. 


                If you set the `filterType` field to `Subscription`, you must
                specify the `subscriptionId` field.
              type: string
          required:
            - accountId
            - filterType
          type: object
      title: billRunFilters
    BillRunScheduleRequestType:
      allOf:
        - description: |
            Container for information about the scheduled bill run.
          properties:
            repeatFrom:
              description: |
                The start date of the scheduled bill run.
              format: date
              type: string
            repeatTo:
              description: |
                The end date of of the scheduled bill run.
              format: date
              type: string
            repeatType:
              description: |
                The repeat type of the bill run.
              enum:
                - None
                - Daily
                - Weekly
                - Monthly
              type: string
            runTime:
              description: |
                The scheduled run time (hour) of day.

                **Values:** 0 - 23
              type: integer
            weeklyOnDay:
              description: >
                The repeat day in a week. 


                This field is required if you set `repeatType` field to
                `Weekly`.
              items:
                enum:
                  - Mon
                  - Tue
                  - Wed
                  - Thu
                  - Fri
                  - Sat
                  - Sun
                type: string
              type: array
            monthlyOnEndOfMonth:
              description: >
                Whether to schedule monthly bill run on the end of month or the
                specific day of month.



                **Note**: This field is available only when the `repeatType`
                field is set to `Monthly` and the `repeatFrom` field is set to
                the end of month.
                  
                For example:
                  - When repeatFrom = `2024-04-30` and `monthlyOnEndOfMonth` = `true`, next bill run will be scheduled on `2024-05-31`.
                  - When repeatFrom = `2024-04-30` and `monthlyOnEndOfMonth` = `false`, next bill run will be scheduled on `2024-05-30`.
              type: boolean
          required:
            - repeatFrom
            - repeatType
            - runTime
          type: object
      title: schedule
    POSTCreateBillRunRequestType:
      allOf:
        - properties:
            autoEmail:
              default: false
              description: >
                Whether to automatically send emails after Auto-Post is
                complete.


                **Note:** To use this field, you must first set the <a
                href="https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules"
                target="_blank">Support Bill Run Auto-Post?</a> billing rule to
                **Yes** through the Zuora UI.
              type: boolean
            autoPost:
              default: false
              description: >
                Whether to automatically post the bill run after the bill run is
                created.


                **Note:** To use this field, you must first set the <a
                href="https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Define_Billing_Rules"
                target="_blank">Support Bill Run Auto-Post?</a> billing rule to
                **Yes** through the Zuora UI.
              type: boolean
            autoRenewal:
              default: false
              description: >
                Whether to automatically renew auto-renew subscriptions that are
                up for renewal.
              type: boolean
            batches:
              description: >
                The batch of accounts for this bill run. 


                You can only specify either this field or the `billRunFilters`
                field.


                **Values:** `AllBatches` or an array of `Batch*n*` where *n* is
                one of numbers 1 - 50, for example, `Batch7`.


                **Note**: By default, you have 50 configurable account batches.
                To increase the limit to 200 batches, you must have the <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite"
                target="_blank">Performance Booster Elite</a> package.
              items:
                type: string
              type: array
            billCycleDay:
              description: >
                The day of the bill cycle. This field is only valid if the
                `batches` field is specified.


                **Values:** 

                - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill
                run

                - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a
                scheduled bill run
              type: string
            billRunFilters:
              description: >
                The target account, subscriptions, invoice schedule, or a
                combination of objects for this bill run. You can only specify
                either this field or the `batches` field. 
              items:
                $ref: '#/components/schemas/BillRunFilterRequestType'
              type: array
            billRunType:
              description: >
                The type of the bill run. If you do not specify any value for
                this field, the default value is `Regular`.


                - You can use this field only if the "Catch-Up Bill Run" feature
                is enabled. 

                - You must specify this field to create a catch up bill run.


                **Values:** 

                - `Regular`

                - `CatchUp`
              type: string
            chargeTypeToExclude:
              description: >
                The types of the charges to be excluded from the generation of
                billing documents. You can specify at most two charge types in
                the array.
              items:
                enum:
                  - OneTime
                  - Recurring
                  - Usage
                type: string
              type: array
            includeSubscriptions:
              default: true
              description: |
                Indicates whether to bill subscriptions in the bill run.
              type: boolean
            includeOrderLineItems:
              default: true
              description: |
                Indicates whether to bill order line items in the bill run.
              type: boolean
            invoiceDate:
              description: >
                The invoice date for the bill run.


                - When creating an ad-hoc bill run, if you do not specify any
                value for this field, the default value is the current date.

                - When creating a scheduled bill run, if you do not specify any
                value for this field, the invoice date is the value of the
                `repeatFrom` field.


                **Note**: You can use one of the following methods to specify
                the invoice date:


                - Specify `invoiceDate`

                - Specify `invoiceDateMonthOffset` and `InvoiceDateDayOfMonth`
              format: date
              type: string
            invoiceDateMonthOffset:
              description: >
                The month offset of invoice date for this bill run compared to
                bill run execution date.



                **Notes**: 

                - This field is only valid when the `repeatType` field is set to
                `Monthly`. 

                - You can use one of the following methods to specify the
                invoice date:
                  - Specify `invoiceDate`
                  - Specify `invoiceDateMonthOffset` and `InvoiceDateDayOfMonth`
              type: integer
            invoiceDateDayOfMonth:
              description: >
                The day of month of invoice date for this bill run. Specify a
                day of the month. If you specify 31, even though the month
                doesn't have 31, for example, February or April, the date recurs
                on the end day of each scheduled month. 



                **Notes**: 
                  - This field is only valid when the `repeatType` field is set to `Monthly`. 
                  - You can use one of the following methods to specify the invoice date:
                    - Specify `invoiceDate`
                    - Specify `invoiceDateMonthOffset` and `InvoiceDateDayOfMonth`
              type: integer
              maximum: 31
              minimum: 1
            name:
              description: |
                The name of the bill run.
              type: string
            noEmailForZeroAmountInvoice:
              default: false
              description: >
                Whether to suppress emails for invoices with zero total amount
                generated in this bill run after the bill run is complete. 


                It is best practice to not send emails for invoices with zero
                amount.
              type: boolean
            organizationLabels:
              description: >
                The organization(s) that the bill run is created for. 


                For each item in the array, either the `organizationId` or the
                `organizationName` field is required.


                This field is only required when you have already turned on
                Multi-Org feature.
              items:
                properties:
                  organizationId:
                    description: |
                      The organization ID.
                    type: string
                  organizationName:
                    description: |
                      The organization name.
                    type: string
                type: object
              type: array
            schedule:
              $ref: '#/components/schemas/BillRunScheduleRequestType'
            targetDate:
              description: >
                The target date for this bill run. 


                - You must specify this field when creating an ad-hoc bill run.

                - For scheduled bill runs, if you do not specify any value for
                this field, the target date is the value of the `repeatFrom`
                field.
              format: date
              type: string
            targetDateMonthOffset:
              description: >
                The month offset of target date for this bill run compared to
                bill run execution date.



                **Note**: This field is only valid when the `repeatType` field
                is set to `Monthly`.
              type: integer
            targetDateDayOfMonth:
              description: >
                The day of month of target date for this bill run. Specify a day
                of the month. If you specify 31, even though the month doesn't
                have 31, for example, February or April, the date recurs on the
                end day of each scheduled month. 



                **Note**: This field is only valid when the `repeatType` field
                is set to `Monthly`. 
              type: integer
              maximum: 31
              minimum: 1
          type: object
      example:
        autoEmail: false
        autoPost: false
        autoRenewal: false
        billRunFilters:
          - accountId: 2c9081a03c63c94c013c66688a2c00bf
            filterType: Subscription
            subscriptionId: 402882297e387c51017e38a245c313db
        chargeTypeToExclude:
          - OneTime
          - Usage
        invoiceDate: '2020-02-01'
        name: test
        noEmailForZeroAmountInvoice: false
        targetDate: '2020-02-01'
    BillRunFilterResponseType:
      allOf:
        - properties:
            accountId:
              description: |
                The target account of the bill run.
              type: string
            filterType:
              description: |
                The bill runs are created based on the selected filter type:
                  - `Account`: Create a bill run at account level.
                  - `Subscription`: Create a bill run at subscription level, you must specify the `subscriptionId` field.
                  - `InvoiceSchedule`: Create a scheduled bill run, you must specify the `schedule` field. See <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Automate_billing_document_generation/Bill_runs/Manage_scheduled_bill_runs" target="_blank">Manage scheduled bill runs</a>.
                  - `FilterCondition`: Create a bill run based on a custom filter, you must specify the `condition` and `objectType` fields. See <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Automate_billing_document_generation/Bill_runs/Bill_Run_Advanced_Filter" target="_blank">Bill Run Advanced Filter</a>.
              enum:
                - Account
                - Subscription
                - InvoiceSchedule
                - FilterCondition
              type: string
            condition:
              $ref: '#/components/schemas/Condition'
            objectType:
              description: >
                The target object type of the condition when the `filterType`
                field is specified as `FilterCondition`. See <a
                href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Automate_billing_document_generation/Bill_runs/Bill_Run_Advanced_Filter"
                target="_blank">Bill Run Advanced Filter</a>.
              type: string
              enum:
                - Account
                - Subscription
                - RatePlanCharge
            subscriptionId:
              description: |
                The target subscripiton ID of the account. 
              type: string
          type: object
      title: billRunFilters
    BillRunScheduleResponseType:
      allOf:
        - description: |
            Container for information about the scheduled bill run.
          properties:
            repeatFrom:
              description: |
                The start date of the scheduled bill run.
              format: date
              type: string
            repeatTo:
              description: |
                The end date of of the scheduled bill run.
              format: date
              type: string
            repeatType:
              description: |
                The repeat type of the bill run.
              enum:
                - None
                - Daily
                - Weekly
                - Monthly
              type: string
            runTime:
              description: |
                The scheduled run time (hour) of day.

                **Values:** 0 - 23
              type: integer
            weeklyOnDay:
              description: |
                The repeat day in a week.
              items:
                enum:
                  - Mon
                  - Tue
                  - Wed
                  - Thu
                  - Fri
                  - Sat
                  - Sun
                type: string
              type: array
            monthlyOnEndOfMonth:
              description: >
                Whether to schedule monthly bill run on the end of month or the
                specific day of month.



                **Note**: This field is available only when the `repeatType`
                field is set to `Monthly` and the `repeatFrom` field is set to
                the end of month.
                  
                For example:

                - When repeatFrom = `2024-04-30` and monthlyOnEndOfMonth =
                `true`, next bill run will be scheduled on `2024-05-31`.

                - When repeatFrom = `2024-04-30` and monthlyOnEndOfMonth =
                `false`, next bill run will be scheduled on `2024-05-30`.
              type: boolean
          type: object
      title: schedule
    GetBillRunResponseType:
      allOf:
        - properties:
            autoEmail:
              description: >
                Whether to automatically send emails after Auto-Post is
                complete.
              type: boolean
            autoPost:
              description: >
                Whether to automatically post the bill run after the bill run is
                created.
              type: boolean
            autoRenewal:
              description: >
                Whether to automatically renew auto-renew subscriptions that are
                up for renewal.
              type: boolean
            batches:
              description: >
                The batch of accounts for this bill run, this field can not
                exist with `billRunFilters` together.


                **Values:** `AllBatches` or an array of `Batch`*n* where *n* is
                a number between 1 and 50, for example, `Batch7`.
              items:
                type: string
              type: array
            billCycleDay:
              description: >
                The day of the bill cycle, this field is only valid when
                `batches` is specified.


                **Values:** 

                - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill
                run

                - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a
                scheduled bill run
              type: string
            billRunFilters:
              description: >
                The target account, subscriptions, invoice schedule, or a
                combination of objects for this bill run.

                You can only specify either this field or the `batches` field. 
              items:
                $ref: '#/components/schemas/BillRunFilterResponseType'
              type: array
            billRunNumber:
              description: |
                The number of the bill run.
              type: string
            chargeTypeToExclude:
              description: >
                The types of the charges to be excluded from the generation of
                billing documents.
              items:
                enum:
                  - OneTime
                  - Recurring
                  - Usage
                type: string
              type: array
            createdById:
              description: |
                The ID of the user who created the bill run.
              type: string
            createdDate:
              description: |
                The date and time when the bill run was created.
              format: date-time
              type: string
            includeSubscriptions:
              default: true
              description: |
                Indicates whether to bill subscriptions in the bill run.
              type: boolean
            includeOrderLineItems:
              default: true
              description: |
                Indicates whether to bill order line items in the bill run.
              type: boolean
            id:
              description: |
                The unqie ID of the bill run.
              type: string
            invoiceDate:
              description: >
                The invoice date for this bill run, only valid for ad-hoc bill
                runs.
              format: date
              type: string
            invoiceDateOffset:
              description: >
                The offset compared to bill run execution date, only valid for
                scheduled bill runs.
              type: integer
            invoiceDateMonthOffset:
              description: >
                The month offset of invoice date for this bill run compared to
                bill run execution date.



                **Note**: This field is only valid when the `repeatType` field
                is set to `Monthly`. When using the `invoiceDateMonthOffset` and
                `invoiceDateDayOfMonth` fields, do not use the
                `invoiceDateOffset` field, and vice versa.
              type: integer
            invoiceDateDayOfMonth:
              description: >
                The day of month of invoice date for this bill run. Specify a
                day of the month. If you specify 31, even though the month
                doesn't have 31, for example, February or April, the date recurs
                on the end day of each scheduled month. 



                **Note**: This field is only valid when the `repeatType` field
                is set to `Monthly`. When using the `invoiceDateMonthOffset` and
                `invoiceDateDayOfMonth` fields, do not use the
                `invoiceDateOffset` field, and vice versa. 
              type: integer
              maximum: 31
              minimum: 1
            name:
              description: |
                The name of the bill run.
              type: string
            noEmailForZeroAmountInvoice:
              description: >
                Whether to suppress emails for invoices with zero total amount
                generated in this bill run after the bill run is complete. 
              type: boolean
            organizationLabels:
              description: >
                The organization(s) that the run is created for. 


                Note: This field is available only when the Multi-Org feature is
                enabled.
              items:
                properties:
                  organizationId:
                    description: |
                      The organization ID.
                    type: string
                  organizationName:
                    description: |
                      The organization name.
                    type: string
                type: object
              type: array
            schedule:
              $ref: '#/components/schemas/BillRunScheduleResponseType'
            scheduledExecutionTime:
              description: |
                The scheduled execution time for a bill run.
              format: date-time
              type: string
            status:
              description: |
                The status of the bill run.
              enum:
                - Pending
                - Processing
                - Completed
                - Error
                - Canceled
                - Posted
                - PostInProgress
                - CancelInProgress
                - RemoveInProgress
                - Paused
              type: string
            targetDate:
              description: >
                The target date for this bill run, only valid for ad-hoc bill
                runs.
              format: date
              type: string
            targetDateOffset:
              description: >
                The offset compared to bill run execution date, only valid for
                scheduled bill runs.
              type: integer
            targetDateMonthOffset:
              description: >
                The month offset of target date for this bill run compared to
                bill run execution date.



                **Note**: This field is only valid when the `repeatType` field
                is set to `Monthly`. When using the `targetDateMonthOffset` and
                `targetDateDayOfMonth` fields, do not use the `targetDateOffset`
                field, and vice versa.
              type: integer
            targetDateDayOfMonth:
              description: >
                The day of month of target date for this bill run. Specify a day
                of the month. If you specify 31, even though the month doesn't
                have 31, for example, February or April, the date recurs on the
                end day of each scheduled month. 



                **Note**: This field is only valid when the `repeatType` field
                is set to `Monthly`. When using the `targetDateMonthOffset` and
                `targetDateDayOfMonth` fields, do not use the `targetDateOffset`
                field, and vice versa.
              type: integer
              maximum: 31
              minimum: 1
            updatedById:
              description: |
                The ID of the user who last updated the bill run.
              type: string
            updatedDate:
              description: |
                The date and time when the bill run was last updated.
              format: date-time
              type: string
          type: object
      example:
        autoEmail: false
        autoPost: false
        autoRenewal: false
        batches: null
        billCycleDay: 1
        billRunFilters:
          - accountId: 2c9081a03c63c94c013c66688a2c00bf
            filterType: Subscription
            subscriptionId: 402882297e387c51017e38a245c313db
        billRunNumber: BR-00000016
        chargeTypeToExclude:
          - OneTime
          - Usage
        createdById: ff808081298c6e5401298c7274a40005
        createdDate: '2022-01-24 19:58:27'
        id: 2c9890077e8a8490017e8bf3a5171a43
        invoiceDate: '2020-02-01'
        invoiceDateOffset: null
        name: test
        noEmailForZeroAmountInvoice: false
        schedule: null
        scheduledExecutionTime: null
        status: Pending
        success: true
        targetDate: '2020-02-01'
        targetDateOffset: null
        updatedById: ff808081298c6e5401298c7274a40005
        updatedDate: '2022-01-24 19:58:27'
    NextRunResponseType:
      allOf:
        - description: |
            Container about information about the next bill run to be executed.
          properties:
            autoEmail:
              description: >
                Whether to automatically send emails after Auto-Post is
                complete.
              type: boolean
            autoPost:
              description: >
                Whether to automatically post the bill run after the bill run is
                created.
              type: boolean
            autoRenewal:
              description: >
                Whether to automatically renew auto-renew subscriptions that are
                up for renewal.
              type: boolean
            batches:
              description: >
                The batch of accounts for this bill run. 


                **Values:** `AllBatches` or an array of `Batch`*n* where *n* is
                one of numbers 1 - 50, for example, `Batch7`.
              items:
                type: string
              type: array
            billCycleDay:
              description: >
                The day of the bill cycle. This field is only valid if the
                `batches` field is specified.


                **Values:** 

                - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill
                run

                - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a
                scheduled bill run
              type: string
            billRunFilters:
              description: |
                The target account or subscriptions for this bill run. 
              items:
                $ref: '#/components/schemas/BillRunFilterResponseType'
              type: array
            billRunNumber:
              description: |
                The number of the bill run.
              type: string
            chargeTypeToExclude:
              description: >
                The types of the charges to be excluded from the generation of
                billing documents.
              items:
                enum:
                  - OneTime
                  - Recurring
                  - Usage
                type: string
              type: array
            createdById:
              description: |
                The ID of the user who created the bill run.
              type: string
            createdDate:
              description: |
                The date and time when the bill run was created.
              format: date-time
              type: string
            id:
              description: |
                The ID of the bill run.
              type: string
            invoiceDate:
              description: >
                The invoice date for this bill run, only valid for ad-hoc bill
                runs.
              format: date
              type: string
            invoiceDateOffset:
              description: >
                The offset compared to the bill run execution date, only valid
                for scheduled bill runs.
              type: integer
            noEmailForZeroAmountInvoice:
              description: >
                Whether to suppress emails for invoices with zero total amount
                generated in this bill run after the bill run is complete. 
              type: boolean
            schedule:
              $ref: '#/components/schemas/BillRunScheduleResponseType'
            scheduledExecutionTime:
              description: |
                The scheduled execution time for the bill run.
              format: date-time
              type: string
            status:
              description: |
                The status of the bill run.
              enum:
                - Pending
                - Processing
                - Completed
                - Error
                - Canceled
                - Posted
                - PostInProgress
                - CancelInProgress
                - RemoveInProgress
                - Paused
              type: string
            targetDate:
              description: >
                The target date for this bill run, only valid for ad-hoc bill
                runs.
              format: date
              type: string
            targetDateOffset:
              description: >
                The offset compared to the bill run execution date, only valid
                for scheduled bill runs.
              type: integer
            updatedById:
              description: |
                The ID of the user who last updated the bill run.
              type: string
            updatedDate:
              description: |
                The date and time when the bill run was last updated.
              format: date-time
              type: string
          type: object
      example:
        autoEmail: false
        autoPost: false
        autoRenewal: false
        batches: null
        billCycleDay: null
        billRunFilters:
          - accountId: 2c9081a03c63c94c013c66688a2c00bf
            filterType: Subscription
            subscriptionId: 402882297e387c51017e38a245c313db
        billRunNumber: BR-00000016
        chargeTypeToExclude:
          - OneTime
          - Usage
        createdById: ff808081298c6e5401298c7274a40005
        createdDate: '2022-01-24 19:58:27'
        id: 2c9890077e8a8490017e8bf3a5171a43
        invoiceDate: '2020-02-01'
        invoiceDateOffset: null
        noEmailForZeroAmountInvoice: false
        schedule: null
        scheduledExecutionTime: null
        status: Pending
        success: true
        targetDate: '2020-02-01'
        targetDateOffset: null
        updatedById: ff808081298c6e5401298c7274a40005
        updatedDate: '2022-01-24 19:58:27'
      title: nextRun
    CancelBillRunResponseType:
      allOf:
        - $ref: '#/components/schemas/GetBillRunResponseType'
        - properties:
            nextRun:
              $ref: '#/components/schemas/NextRunResponseType'
          type: object
      example:
        autoEmail: false
        autoPost: false
        autoRenewal: true
        batches: null
        billCycleDay: 1
        billRunFilters: []
        billRunNumber: BR-00000014
        chargeTypeToExclude: null
        createdById: ff808081298c6e5401298c7274a40005
        createdDate: '2022-01-19 11:28:34'
        id: 2c9890e97e57e546017e706109df04a1
        invoiceDate: '2022-01-26'
        invoiceDateOffset: 0
        name: test
        nextRun:
          autoEmail: false
          autoPost: false
          autoRenewal: true
          batches: null
          billCycleDay: 1
          billRunFilters: []
          billRunNumber: BR-00000021
          chargeTypeToExclude: null
          createdById: ff808081298c6e5401298c7274a40005
          createdDate: '2022-01-26 14:47:05'
          id: 2c9890077e901749017e95235b13093d
          invoiceDate: null
          invoiceDateOffset: 0
          noEmailForZeroAmountInvoice: false
          schedule:
            repeatFrom: '2022-02-28'
            repeatTo: '2023-01-31'
            repeatType: Monthly
            runTime: 0
            weeklyOnDay: null
          scheduledExecutionTime: '2022-02-28 00:00:00'
          status: Pending
          targetDate: null
          targetDateOffset: 0
          updatedById: ff808081298c6e5401298c7274a40005
          updatedDate: '2022-01-26 14:47:05'
        noEmailForZeroAmountInvoice: false
        schedule: null
        scheduledExecutionTime: '2022-01-28 00:00:00'
        status: CancelInProgress
        success: true
        targetDate: null
        targetDateOffset: 0
        updatedById: ff808081298c6e5401298c7274a40005
        updatedDate: '2022-01-26 14:47:09'
    POSTEmailBillingDocfromBillRunType:
      example:
        resend: 'true'
      properties:
        resend:
          default: false
          description: >
            Whether to send out emails for all the billing documents that are
            associated with the bill run. 
              - If the value is `false`, emails are sent out only for the billing documents that never have emails sent out. **Note**: Do not perform this API operation with the `resend` field set to `false` multiple times in a short period. Otherwise, you may receive the same email multiple times, which contradicts the purpose of this setting.
              
              - If the value is `true`, emails are sent out for all the billing documents.
          type: boolean
      type: object
    BillingPreviewRunFilter:
      type: array
      description: >
        A list of filters to apply to the billing preview run. You can specify
        only one filter. 
      maxItems: 1
      items:
        type: object
        properties:
          filterType:
            description: |
              The type of filter to apply.
            enum:
              - Account
            type: string
          accountId:
            description: |
              The target account ID.
            type: string
            pattern: ^[0-9a-fA-F]{32}$
        required:
          - filterType
          - accountId
    PostBillingPreviewRunParam:
      example:
        batches: Batch1
        targetDate: '2024-11-05'
      properties:
        assumeRenewal:
          description: >
            Indicates whether to generate a preview of future invoice items and
            credit memo items with the assumption that the subscriptions are
            renewed.


            Set one of the following values in this field to decide how the
            assumption is applied in the billing preview.

              * **All:** The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.
              
              * **None:** (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date.
              
                * If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date.

                * If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memeo item data from the first day of the customer's next billing period to the target date.

              * **Autorenew:** The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.

              
            **Note:** 
              - This field can only be used if the subscription renewal term is not set to 0.  
              
              
              - The credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. 
          type: string
        batches:
          description: >
            The customer batches to include in the billing preview run. You can
            specify multiple batches separated by comma. If not specified, all
            customer batches are included.


            **Note**: 
              - By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the <a href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite" target="_blank">Performance Booster Elite</a> package.
              - This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `314.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          maxLength: 1000
          type: string
        chargeTypeToExclude:
          description: >
            The charge types to exclude from the forecast run.


            **Possible values:** OneTime, Recurring, Usage, and any
            comma-separated combination of these values.
          type: string
        includingDraftItems:
          description: >
            Whether draft document items are included in the billing preview
            run. By default, draft document items are not included.


            This field loads draft invoice items and credit memo items. The
            `chargeTypeToExclude`, `targetDate`,
            `includingEvergreenSubscription`, and `assumeRenewal` fields do not
            affect the behavior of the `includingDraftItems` field.
          type: boolean
        includingEvergreenSubscription:
          description: >
            Whether evergreen subscriptions are included in the billing preview
            run. By default, evergreen subscriptions are not included.
          type: boolean
        organizationLabels:
          description: >
            The organization(s) that this billing preview run is created for. 


            For each item in the array, either the `organizationId` or the
            `organizationName` field is required.


            This field is only required when you have already turned on
            Multi-Org feature.
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        storageOption:
          description: >
            The saving options. The default value is `Csv`.


            To compare the current billing preview run result with a specified
            billing preview run result and store the difference in the database,
            you must set the `storageOption` field to `Database`. For more
            information, see [Billing Preview Run Result data
            source](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference/Billing_Preview_Run_Result_data_source).
          enum:
            - Csv
            - Database
          type: string
        storeDifference:
          description: >
            Specify this field to `yes` to compare the current billing preview
            run result with a specified billing preview run result and store the
            difference in the database. You can view the difference in the
            Billing Preview Run Result Difference data source. **Note**: This
            feature is in the **Early Adopter** phase. If you want to use the
            feature, submit a request at <a href="http://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.


            The default value is `false`.
          type: boolean
        comparedBillingPreviewRunId:
          description: >
            Specify an existing billing preview run result to compare the
            current billing preview result with. You can view the difference in
            the Billing Preview Run Result Difference data source. **Note**:
            This feature is in the **Early Adopter** phase. If you want to use
            the feature, submit a request at <a href="http://support.zuora.com/"
            target="_blank">Zuora Global Support</a>.
          type: string
        targetDate:
          description: >
            The target date for the billing preview run. The billing preview run
            generates preview invoice item data and credit memo item data from
            the first day of the customer's next billing period to the target
            date. 


            The value for the `targetDate` field must be in _`YYYY-MM-DD`_
            format.


            If the target date is later than the subscription current term end
            date, the preview invoice item data and credit memo item data is
            generated from the first day of the customer's next billing period
            to the current term end date. If you want to generate preview
            invoice item data and credit memo item data past the end of the
            subscription current term, specify the AssumeRenewal field in the
            request.


            **Note:** The credit memo item data is only available if you have
            Invoice Settlement feature enabled. The Invoice Settlement feature
            is generally available as of Zuora Billing Release 296 (March 2021).
            This feature includes Unapplied Payments, Credit and Debit Memo, and
            Invoice Item Settlement. If you want to enable Invoice Settlement,
            see [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          format: date
          type: string
        filters:
          $ref: '#/components/schemas/BillingPreviewRunFilter'
      required:
        - targetDate
      type: object
    GetBillingPreviewRunResponse:
      description: get billingPreviewRun response
      properties:
        assumeRenewal:
          description: ''
          type: string
        batches:
          description: >
            The customer batches included in the billing preview run. 


            **Note**: This field is available only if you are on the latest
            Zuora API minor version, or you set the `Zuora-Version` request
            header to `314.0` or [a later available
            version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
          type: string
        chargeTypeToExclude:
          description: |
            The charge types excluded from the forecast run.
          type: string
        createdById:
          description: |
            The ID of the user who created the billing preview run.
          type: string
        createdDate:
          description: |
            The date and time when the billing preview run was created.
          format: datetime
          type: string
        endDate:
          description: |
            The date and time when the billing preview run completes.
          format: datetime
          type: string
        errorMessage:
          description: |
            The error message generated by a failed billing preview run.
          type: string
        includingDraftItems:
          description: >
            Whether draft document items are included in the billing preview
            run. By default, draft document items are not included.
          type: boolean
        includingEvergreenSubscription:
          description: >
            Indicates if evergreen subscriptions are included in the billing
            preview run.
          type: boolean
        organizationLabels:
          description: >
            The organization(s) that the object belongs to. 


            Note: This field is available only when the Multi-Org feature is
            enabled.            
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        resultFileUrl:
          description: >
            The URL of the zipped CSV result file generated by the billing
            preview run. This file contains the preview invoice item data and
            credit memo item data for the specified customers.


            If the value of `storageOption` field is `Database`, the returned
            `resultFileUrl` field is null.


            **Note:** The credit memo item data is only available if you have
            Invoice Settlement feature enabled. The Invoice Settlement feature
            is generally available as of Zuora Billing Release 296 (March 2021).
            This feature includes Unapplied Payments, Credit and Debit Memo, and
            Invoice Item Settlement. If you want to enable Invoice Settlement,
            see [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: string
        runNumber:
          description: |
            The run number of the billing preview run.
          type: string
        startDate:
          description: |
            The date and time when the billing preview run starts.
          format: datetime
          type: string
        status:
          description: |
            The status of the >billing preview run.

            **Possible values:** 

            * 0: Pending
            * 1: Processing
            * 2: Completed
            * 3: Error
            * 4: Canceled
          type: string
        storageOption:
          description: |
            The saving options. The default value is `Csv`.    
          enum:
            - Csv
            - Database
          type: string
        succeededAccounts:
          description: >
            The number of accounts for which preview invoice item data and
            credit memo item data was successfully generated during the billing
            preview run.


            **Note:** The credit memo item data is only available if you have
            Invoice Settlement feature enabled. The Invoice Settlement feature
            is generally available as of Zuora Billing Release 296 (March 2021).
            This feature includes Unapplied Payments, Credit and Debit Memo, and
            Invoice Item Settlement. If you want to enable Invoice Settlement,
            see [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          type: integer
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        targetDate:
          description: |
            The target date for the billing preview run.          
          format: date
          type: string
        totalAccounts:
          description: |
            The total number of accounts in the billing preview run.
          format: int32
          type: integer
        updatedById:
          description: |
            The ID of the user who last updated the billing preview run.
          type: string
        updatedDate:
          description: |
            The date and time when the billing preview run was last updated.
          format: date-time
          type: string
      type: object
    POSTPaymentMethodResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - properties:
            id:
              description: |
                Internal ID of the payment method that was created.
              type: string
            reasons:
              items:
                description: >
                  Error information. Only applicable if the payment method was
                  not created.
                properties:
                  code:
                    description: |
                      Error code.
                    type: string
                  message:
                    description: |
                      Error message.
                    type: string
                type: object
              type: array
          type: object
    CreateApplePayPaymentMethodCardholderInfo:
      description: >
        The container for the cardholder information.


        The cardholder name is required for credit card validation. It is
        strongly recommended to specify the nested `cardHolderName` field in
        this container. For more information, see `cardHolderName`.


        The required cardholder address fields vary by gateway. It is strongly
        recommended to review the gateway's documentation for the most accurate
        and up-to-date information.
      properties:
        addressLine1:
          description: |
            The first address line.
          maxLength: 255
          type: string
        addressLine2:
          description: |
            The second address line.
          maxLength: 255
          type: string
        cardHolderName:
          description: >
            The cardholder's full name as it appears on the card.


            The cardholder name information is required for credit card
            validation. 

            Zuora retrieves the cardholder name using the following priority:
              1. This `cardHolderName` field if available.
              2. The cardholder name in the `paymentToken` field if available. 
              3. The full bill-to-contact name of the customer account.

            It is strongly recommended to provide the cardholder name through
            this field.
          maxLength: 50
          type: string
        city:
          description: |
            The city.

            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          maxLength: 40
          type: string
        country:
          description: |
            The country, which must be a valid country name or abbreviation.

            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          type: string
        email:
          description: |
            The cardholder's email address.
          maxLength: 80
          type: string
        phone:
          description: |
            The phone number.
          maxLength: 40
          type: string
        state:
          description: >
            The state, which must be a valid subregion (state or province) name
            or code. For more information, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
            target="_blank">View subregions of a specific country or region</a>.
          type: string
        zipCode:
          description: |
            The zip code.
          maxLength: 20
          type: string
      title: CardHolderInfo
      type: object
    POSTPaymentMethodDecryption:
      example:
        accountID: 402891a25a02e11c015a02f3c6100003
        cardHolderInfo:
          cardHolderName: Amy Lawrence
          addressLine1: 101 Redwood Shores Parkway
          city: Redwood City
          country: USA
        integrationType: ApplePay
        invoiceId: INV000000005
        merchantID: merchant.US.com.zuora.services001
        mitConsentAgreementSrc: External
        mitProfileAction: Activate
        mitProfileType: Recurring
        paymentGateway: CyberSourceOPG
        paymentToken:
          data: xGc......JDxuYz1gug0KZRrGXJQ=
          header:
            ephemeralPublicKey: MFkwEw......TMbLoojKBA==
            publicKeyHash: HuLvfqvLon......9jEyX0w=
            transactionId: abbadd18818baea1f37b40844c9e09afa9733b0eccb373905b811da43cf1753b
          signature: MIAGCSqGSIb......AEtrLSv7hE9gAAAAAAAA==
          version: EC_v1
        processPayment: true
      properties:
        accountID:
          description: >-
            The ID of the customer account associated with this payment method.

            To create an orphan payment method that is not associated with any
            customer account, you can skip this field.  As soon as the account
            information is available, associate the payment method with an
            account through the [Update a payment
            method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) 
            operation.
          type: string
        cardHolderInfo:
          $ref: '#/components/schemas/CreateApplePayPaymentMethodCardholderInfo'
        integrationType:
          description: |
            Field to identify the token decryption type.

            **Note:** The only value at this time is `ApplePay`.
          type: string
        invoiceId:
          description: >
            The id of invoice this payment will apply to.


            **Note:** When `processPayment` is `true`, this field is required.

            Only one invoice can be paid; for scenarios where you want to pay
            for multiple invoices, set `processPayment` to `false` and call
            payment API separately.
          type: string
        merchantID:
          description: >
            The Merchant ID that was configured for use with Apple Pay in the
            Apple iOS Developer Center.
          type: string
        mitConsentAgreementSrc:
          description: >
            This field is only available for the following gateway integrations
            to create stored credential profiles within payment methods:
              - Chase Paymentech Orbital Gateway
              - CyberSource Payment API v2.0
              - Stripe v2
              - Vantiv (Now Worldpay)
              - Worldpay 1.4

            Specify how the consent agreement has been established with the
            customer. The allowed value is `External`. It is required if the
            `mitProfileAction` field is specified. If you do not specify the
            `mitProfileAction` field, Zuora will automatically create a stored
            credential profile for the payment method, with the default value
            `External` set to this field.
          enum:
            - External
          type: string
        mitProfileAction:
          description: >
            This field is only available for the following gateway integrations
            to create stored credential profiles within payment methods:
              - Chase Paymentech Orbital Gateway
              - CyberSource Payment API v2.0
              - Stripe v2
              - Vantiv (Now Worldpay)
              - Worldpay 1.4

            Specify either of the following values in this field:
                
              - `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent.
                
                Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.
                  
                If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.
                
              - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`.

              If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field.
                
          enum:
            - Activate
            - Persist
          type: string
        mitProfileType:
          description: >
            This field is only available for the following gateway integrations
            to create stored credential profiles within payment methods:
              - Chase Paymentech Orbital Gateway
              - CyberSource Payment API v2.0
              - Stripe v2
              - Vantiv (Now Worldpay)
              - Worldpay 1.4

            This field indicates the type of the stored credential profile to
            process recurring or unsecheduled transactions. It is required if
            the `mitProfileAction` field is specified. If you do not specify the
            `mitProfileAction` field, Zuora will automatically create a stored
            credential profile for the payment method, with the default value
            `Recurring` set to this field.
                
          enum:
            - Recurring
            - Unscheduled
          type: string
        paymentGateway:
          description: >
            The label name of the gateway instance configured in Zuora that will
            be used for 

            payment method validation and payment processing.
              - When `processPayment` is `true`, this `paymentGateway` field is required.
              - When `processPayment` is `false`  or is not provided, the specified gateway instance will be used for 
              payment method validation.

            Specify a valid gateway instance and it must support the Apple Pay
            payment method. 

            If not specified, the default gateway of your Zuora customer account
            will be used.
          type: string
        paymentToken:
          description: |
            The payload with the Apple Pay token or payment data.
          type: object
        processPayment:
          description: >
            A boolean flag to control whether a payment should be processed
            after

            creating payment method. The payment amount will be equivalent to
            the

            amount the merchant supplied in the ApplePay session. Default is
            false.



            If this field is set to `true`, you must specify the
            `paymentGateway`

            field with the payment gateway instance name.



            If this field is set to `false`:
              - You must select the **Verify new credit card** check box on the gateway instance settings page. Otherwise, the cryptogram will not be sent to the gateway.
              - A separate subscribe or payment API call is required after this payment method creation call.
          type: boolean
      required:
        - integrationType
        - merchantID
        - paymentToken
      type: object
    POSTPaymentMethodResponseDecryption:
      properties:
        amount:
          description: |
            The payment amount contained within the encrypted token.
          type: string
        paymentId:
          description: |
            The ID of newly processed payment,
          type: string
        paymentMethodId:
          description: |
            ID of the newly-created payment method.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETPMAccountHolderInfo:
      description: |
        The account holder information.
      properties:
        accountHolderName:
          description: |
            The full name of the account holder.
          type: string
        addressLine1:
          description: |
            The first line of the address for the account holder.
          type: string
        addressLine2:
          description: |
            The second line of the address for the account holder. 
          type: string
        city:
          description: |
            The city where the account holder stays.
          type: string
        country:
          description: >
            The country where the account holder stays.


            When creating a payment method through a translated UI or Payment
            Page, a country name in a translated language might be selected.
            Regardless of the country texts selected when creating the payment
            method, only the supported country name returns in this field. For a
            complete list of supported country names, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a>. Internationalization
            is not supported for the API field value.
          type: string
        email:
          description: |
            The email address of the account holder.
          type: string
        phone:
          description: |
            The phone number of the account holder.
          type: string
        state:
          description: |
            The state where the account holder stays.
          type: string
        zipCode:
          description: |
            The zip code for the address of the account holder.
          type: string
      title: accountHolderInfo
      type: object
    POSTPMMandateInfo:
      description: >
        The mandate information for the Credit Card, Apple Pay, Google Pay,
        Credit Card Reference Transaction, ACH, or Bank Transfer payment method.


        The following mandate fields are common to all supported payment
        methods:

        * `mandateId`

        * `mandateReason`

        * `mandateStatus`


        The following mandate fields are specific to the ACH and Bank Transfer
        payment methods:

        * `mandateReceivedStatus`

        * `existingMandateStatus`

        * `mandateCreationDate`

        * `mandateUpdateDate`


        The following mandate fields are specific to the Credit Card, Apple Pay,
        and Google Pay payment methods:

        * `mitTransactionId`

        * `mitProfileAgreedOn`

        * `mitConsentAgreementRef`

        * `mitConsentAgreementSrc`

        * `mitProfileType`

        * `mitProfileAction`
      properties:
        existingMandateStatus:
          description: |
            Indicates whether the mandate is an existing mandate.
          enum:
            - 'Yes'
            - 'No'
          type: string
        mandateCreationDate:
          description: |
            The date on which the mandate was created.
          format: date
          type: string
        mandateId:
          description: |
            The mandate ID.
          type: string
        mandateReason:
          description: |
            The reason of the mandate from the gateway side.
          type: string
        mandateReceivedStatus:
          description: |
            Indicates whether the mandate is received from the gateway
          enum:
            - 'Yes'
            - 'No'
          type: string
        mandateStatus:
          description: |
            The status of the mandate from the gateway side.
          type: string
        mandateUpdateDate:
          description: |
            The date on which the mandate was updated.
          format: date
          type: string
        mitConsentAgreementRef:
          description: >
            Reference for the consent agreement that you have established with
            the customer.  
          type: string
        mitConsentAgreementSrc:
          description: >
            Required if you set the `mitProfileAction` field. Specifies how the
            consent agreement has been established with the customer. The
            allowed value is `External`. If you do not specify the
            `mitProfileAction` field, Zuora will automatically create a stored
            credential profile for the payment method, with the default value
            `External` set to this field.
          enum:
            - External
          type: string
        mitProfileAction:
          description: >
            Specifies how Zuora creates and activates the stored credential
            profile. Only applicable if you set the `status` field to `Active`.


            - `Activate` (default) - Use this value if you are creating the
            stored credential profile after receiving the customer's consent.

              Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.
              
              If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.


            - `Persist` - Use this value if the stored credential profile
            represents a stored credential profile in an external system. The
            status of the payment method's stored credential profile will be
            `Active`.


            If you do not specify this field, Zuora will automatically create a
            stored credential profile for the payment method, with the default
            value `Activate` set to this field.
          enum:
            - Activate
            - Persist
          type: string
        mitProfileAgreedOn:
          description: >
            The date on which the stored credential profile is agreed. The date
            format is `yyyy-mm-dd`.
          format: date
          type: string
        mitProfileType:
          description: >
            Indicates the type of the stored credential profile. If you do not
            specify the `mitProfileAction` field, Zuora will automatically
            create a stored credential profile for the payment method, with the
            default value `Recurring` set to this field.
          type: string
        mitTransactionId:
          description: >
            Specifies the ID of the transaction. Only applicable if you set the
            `mitProfileAction` field to `Persist`.
          maxLength: 128
          type: string
      title: mandateInfo
      type: object
    GETPaymentMethodResponseBankTransfer:
      properties:
        IBAN:
          description: >
            The International Bank Account Number used to create the SEPA
            payment method. The value is masked.
          type: string
        accountNumber:
          description: |
            The number of the customer's bank account and it is masked.
          type: string
        bankCode:
          description: >
            The sort code or number that identifies the bank. This is also known
            as the sort code.         
          type: string
        bankTransferType:
          description: |
            The type of the Bank Transfer payment method. For example, `SEPA`.
          type: string
        branchCode:
          description: |
            The branch code of the bank used for Direct Debit.          
          type: string
        businessIdentificationCode:
          description: |
            The BIC code used for SEPA. The value is masked.       
          type: string
        identityNumber:
          description: |
            The identity number of the account holder or the cardholder.
          type: string
      type: object
    GETPaymentMethodResponseACH:
      properties:
        bankABACode:
          description: >
            The nine-digit routing number or ABA number used by banks. This
            field is only required if the `type` field is set to `ACH`.
          type: string
        bankAccountName:
          description: >
            The name of the account holder, which can be either a person or a
            company. This field is only required if the `type` field is set to
            `ACH`.
          type: string
        bankAccountNumber:
          description: >
            The bank account number associated with the ACH payment. This field
            is only required if the `type` field is set to `ACH`.
          type: string
        bankAccountType:
          description: >
            The type of bank account associated with the ACH payment. This field
            is only required if the `type` field is set to `ACH`.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify any of
            the allowed values as a dummy value, `Checking` preferably.
          enum:
            - BusinessChecking
            - Checking
            - Saving
          type: string
        bankName:
          description: >
            The name of the bank where the ACH payment account is held. This
            field is only required if the `type` field is set to `ACH`.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify a dummy
            value.
          type: string
      type: object
    GETPaymentMethodResponseCreditCard:
      properties:
        cardNumber:
          description: >
            The masked credit card number.


            When `cardNumber` is `null`, the following fields will not be
            returned:
              - `expirationMonth`
              - `expirationYear`
              - `accountHolderInfo`
          type: string
        expirationMonth:
          description: |
            One or two digits expiration month (1-12).
                    
          type: integer
        expirationYear:
          description: |
            Four-digit expiration year.
          type: integer
        securityCode:
          description: |
            The CVV or CVV2 security code for the credit card or debit card.
                        Only required if changing expirationMonth, expirationYear, or cardHolderName.
                        To ensure PCI compliance, this value isn''t stored and can''t be queried.                  
          type: string
      type: object
    GETPaymentMethodResponsePayPal:
      properties:
        BAID:
          description: |
            ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9.
          type: string
        email:
          description: |
            Email address associated with the PayPal payment method. 
          type: string
        preapprovalKey:
          description: |
            The PayPal preapproval key.
          type: string
      type: object
    GETPaymentMethodResponseGooglePay:
      properties:
        googleBIN:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
        googleCardNumber:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
        googleCardType:
          description: >
            This field is only available for Google Pay payment methods.


            For Google Pay payment methods on Adyen, the first 100 characters of
            [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant)
            returned from Adyen are stored in this field.
          type: string
        googleExpiryDate:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
        googleGatewayToken:
          description: |
            This field is only available for Google Pay payment methods.
          type: string
      type: object
    GETPaymentMethodResponseApplePay:
      properties:
        appleBIN:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
        appleCardNumber:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
        appleCardType:
          description: >
            This field is only available for Apple Pay payment methods.


            For Apple Pay payment methods on Adyen, the first 100 characters of
            [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant)
            returned from Adyen are stored in this field.
          type: string
        appleExpiryDate:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
        appleGatewayToken:
          description: |
            This field is only available for Apple Pay payment methods.
          type: string
      type: object
    GETPaymentMethodResponse:
      allOf:
        - properties:
            accountHolderInfo:
              $ref: '#/components/schemas/GETPMAccountHolderInfo'
            accountVerificationService:
              description: |
                Displays the name of the service provider. For example, Plaid.
              type: string
            accountVerificationStatus:
              description: >
                Displays the status of the account.

                **Note:** 

                - `Active` - Access token is active. 

                - `Expired` - Access token has expired and must be linked
                again. 

                - `Expiring` - Access token will expire in few days(7 days for
                Plaid) and must be linked again

                - `Inactive` - The end customer has revoked the account
                permission. The end customer can login again and select the same
                method for the access token to be linked again.
              enum:
                - Active
                - Expired
                - Expiring
                - Inactive
              type: string
            bankIdentificationNumber:
              description: >
                The first six or eight digits of the payment method's number,
                such as the credit card number or account number. Banks use this
                number to identify a payment method.
              type: string
            createdBy:
              description: ID of the user who created this payment method.
              type: string
            createdOn:
              description: >
                The date and time when the payment method was created, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
            creditCardMaskNumber:
              description: |
                The masked credit card number, such as:
                ```
                *********1112
                ```
              type: string
            creditCardType:
              description: >
                The type of the credit card or debit card.


                Possible values include `Visa`, `MasterCard`, `AmericanExpress`,
                `Discover`, `JCB`, and `Diners`. For more information about
                credit card types supported by different payment gateways, see
                [Supported Payment
                Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).


                **Note:** This field is only returned for the Credit Card and
                Debit Card payment types.
              type: string
            deviceSessionId:
              description: >
                The session ID of the user when the `PaymentMethod` was created
                or updated.
              type: string
            existingMandate:
              description: |
                Indicates whether the mandate is an existing mandate.
              enum:
                - 'Yes'
                - 'No'
              type: string
            id:
              description: |
                The payment method ID.
              type: string
            ipAddress:
              description: >
                The IP address of the user when the payment method was created
                or updated.
              type: string
            isDefault:
              description: >
                Indicates whether this payment method is the default payment
                method for the account.
              type: boolean
            lastFailedSaleTransactionDate:
              description: >
                The date of the last failed attempt to collect payment with this
                payment method.
              format: date-time
              type: string
            lastTransaction:
              description: Indicates the occurrence and status of the last transaction.
              type: string
            lastTransactionTime:
              description: >-
                The time when the last transaction of this payment method
                happened.
              format: date-time
              type: string
            mandateInfo:
              $ref: '#/components/schemas/POSTPMMandateInfo'
            maxConsecutivePaymentFailures:
              description: >
                The number of allowable consecutive failures Zuora attempts with
                the payment method before stopping.
              type: integer
            numConsecutiveFailures:
              description: >
                The number of consecutive failed payments for this payment
                method. It is reset to `0` upon successful payment. 
              format: int32
              type: integer
            paymentRetryWindow:
              description: >
                The retry interval setting, which prevents making a payment
                attempt if the last failed attempt was within the last specified
                number of hours.
              type: integer
            secondTokenId:
              description: >
                A gateway unique identifier that replaces sensitive payment
                method data.


                **Note:** This field is only returned for the Credit Card
                Reference Transaction payment type.
              type: string
            status:
              description: |
                The status of the payment method.
              enum:
                - Active
                - Closed
                - Scrubbed
              type: string
            tokenId:
              description: >
                A gateway unique identifier that replaces sensitive payment
                method data or represents a gateway's unique customer profile.


                **Note:** This field is only returned for the Credit Card
                Reference Transaction payment type.
              type: string
            totalNumberOfErrorPayments:
              description: |
                The number of error payments that used this payment method.
              format: int32
              type: integer
            totalNumberOfProcessedPayments:
              description: |
                The number of successful payments that used this payment method.
              format: int32
              type: integer
            type:
              description: |
                The type of the payment method.
              type: string
              enum:
                - CreditCard
                - CreditCardReferenceTransaction
                - ACH
                - SEPA
                - Betalingsservice
                - Autogiro
                - Bacs
                - Becs
                - Becsnz
                - PAD
                - PayPalCP
                - PayPalEC
                - PayPalNativeEC
                - PayPalAdaptive
                - AdyenApplePay
                - AdyenGooglePay
                - GooglePay
            updatedBy:
              description: ID of the user who made the last update to this payment method.
              type: string
            updatedOn:
              description: >
                The last date and time when the payment method was updated, in
                `yyyy-mm-dd hh:mm:ss` format.
              format: date-time
              type: string
            useDefaultRetryRule:
              description: >
                Indicates whether this payment method uses the default retry
                rules configured in the Zuora Payments settings.
              type: boolean
            cardBinInfo:
              description: |
                The BIN information of a card payment method.
              properties:
                brand:
                  description: |
                    The card brand, such as `Visa` and `MasterCard`.
                  type: string
                cardClass:
                  description: |
                    The type of the card.
                  type: string
                  enum:
                    - ChargeCard
                    - Credit
                    - Debit
                    - DeferredDebit
                    - Prepaid
                productType:
                  description: |
                    The product type of the card.
                  type: string
                  enum:
                    - Commercial_or_Corporate_Card
                    - Consumer_Card
                issuer:
                  description: >
                    The issuer bank of the card, such as `JPMORGAN CHASE BANK
                    N.A.`.
                  type: string
                issuingCountryCode:
                  description: |
                    The issuing country code of the card, such as `US`.
                  type: string
              type: object
          type: object
        - $ref: '#/components/schemas/PaymentMethodObjectCustomFields'
        - $ref: '#/components/schemas/GETPaymentMethodResponseBankTransfer'
        - $ref: '#/components/schemas/GETPaymentMethodResponseACH'
        - $ref: '#/components/schemas/GETPaymentMethodResponseCreditCard'
        - $ref: '#/components/schemas/GETPaymentMethodResponsePayPal'
        - $ref: '#/components/schemas/GETPaymentMethodResponseGooglePay'
        - $ref: '#/components/schemas/GETPaymentMethodResponseApplePay'
    PUTPMAccountHolderInfo:
      description: >
        The account holder information. This field is not supported in updating
        Credit Card Reference Transaction payment methods.
      properties:
        addressLine1:
          description: >
            The first line of the address for the account holder.


            This field is required for SEPA Direct Debit payment methods on
            Stripe v2 for [certain
            countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
          type: string
        addressLine2:
          description: |
            The second line of the address for the account holder. 
          type: string
        city:
          description: |
            The city where the account holder stays.
          type: string
        country:
          description: >
            The country where the account holder stays.


            This field is required for SEPA payment methods on Stripe v2 for
            [certain
            countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method).
          type: string
        email:
          description: |
            The email address of the account holder.
          type: string
        phone:
          description: |
            The phone number of the account holder.
          type: string
        state:
          description: |
            The state where the account holder stays.
          type: string
        zipCode:
          description: |
            The zip code for the address of the account holder.
          type: string
      title: accountHolderInfo
      type: object
    PUTPMCreditCardInfo:
      properties:
        expirationMonth:
          description: |
            One or two digits expiration month (1-12).
                    
          type: integer
        expirationYear:
          description: |
            Four-digit expiration year.
          type: integer
        securityCode:
          description: >
            Optional. It is the CVV or CVV2 security code specific for the
            credit card or debit card. To ensure PCI compliance, this value is
            not stored and cannot be queried. 


            If securityCode code is not passed in the request payload, this
            operation only updates related fields in the payload. It does not
            validate the payment method through the gateway.


            If securityCode is passed in the request payload, this operation
            retrieves the credit card information from payload and validates
            them through the gateway.
          type: string
      type: object
    PUTPaymentMethodObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the payment method. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.


          Custom fields are not supported in updating Credit Card Reference
          Transaction payment methods.
      description: |
        Container for custom fields of a payment method object.
      title: paymentMethodFieldsCustom
      type: object
    PUTPaymentMethodRequest:
      allOf:
        - properties:
            accountHolderInfo:
              $ref: '#/components/schemas/PUTPMAccountHolderInfo'
            accountKey:
              description: >
                The customer account ID such as
                `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account
                number such as `A02855638`.


                **Note:** You can use this field to associate an orphan payment
                method with a customer account. If a payment method is already
                associated with a customer account, you cannot change the
                associated payment method through this operation. You cannot
                remove the previous account ID and leave this field empty,
                either.
              type: string
            authGateway:
              description: >
                Specifies the ID of the payment gateway that Zuora will use to
                authorize the payments that are made with the payment method. 

                This field is not supported in updating Credit Card Reference
                Transaction payment methods.


                If <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
                target="_blank">Payment Gateway Routing</a> is enabled: 
                  - If this field is not specified, gateway routing rules will be invoked.
                  -  If this field is specified, the specified gateway will be used to update the payment.

                If Payment Gateway Routing is disabled:
                  -  If this field is not specified, the default payment gateway will be used to update the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. 
                  -  If this field is specified, the specified gateway will be used to update the payment.
              type: string
            currencyCode:
              description: |
                The currency used for payment method authorization.
              type: string
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values. The fields supported by gateways vary. For more
                information, see the Overview topic of each gateway integration
                in [Zuora Knowledge
                Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


                Zuora sends all the information that you specified to the
                gateway. If you specify any unsupported gateway option
                parameters, they will be ignored without error prompts.


                This field is not supported in updating Credit Card Reference
                Transaction payment methods.
              properties:
                key:
                  description: |
                    The name of a gateway-specific parameter.
                  type: string
                value:
                  description: |
                    The value of the gateway-specific parameter.
                  type: string
              type: object
            ipAddress:
              description: >
                The IPv4 or IPv6 information of the user when the payment method
                is created or updated. Some gateways use this field for fraud
                prevention. If this field is passed to Zuora, Zuora directly
                passes it to gateways. 


                If the IP address length is beyond 45 characters, a validation
                error occurs.


                For validating SEPA payment methods on Stripe v2, this field is
                required.
              type: string
            mandateInfo:
              description: >
                The mandate information for the Credit Card, Credit Card
                Reference Transaction, ACH, or Bank Transfer payment method.
              properties:
                mandateId:
                  description: |
                    The mandate ID.
                  maxLength: 36
                  type: string
                mandateReason:
                  description: |
                    The reason of the mandate from the gateway side.
                  maxLength: 64
                  type: string
                mandateStatus:
                  description: |
                    The status of the mandate from the gateway side.
                  maxLength: 64
                  type: string
              type: object
            processingOptions:
              description: |
                The container for payment method processing options.
              properties:
                checkDuplicated:
                  description: >
                    Indicates whether to perform a duplication check when you
                    create a payment method of the following types:
                      - Credit Card
                      - ACH
                      - Bank Transfer

                    The default value is `false`.


                    With this field set to `true`, Zuora will check the active
                    and closed payment methods associated with the same billing
                    account to ensure that no duplicate payment methods are
                    created. 


                    For more information, see <a
                    href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Methods/D1_Duplication_check_on_payment_methods"
                    target="_blank">Duplication check on payment methods</a>.
                  type: boolean
              type: object
            maxConsecutivePaymentFailures:
              description: >
                The maximum number of payment failures allowed for this payment
                method.  

                This field is only applicable if `useDefaultRetryRule` is set to
                `false`.
              type: integer
              minimum: 1
              maximum: 100
              nullable: true
            paymentRetryWindow:
              description: >
                The retry interval in hours.  

                This field is only applicable if `useDefaultRetryRule` is set to
                `false`.
              type: integer
              minimum: 1
              maximum: 1000
              nullable: true
            useDefaultRetryRule:
              description: >
                Specifies whether to apply the default retry rule configured for
                your tenant in the Zuora Payments settings:
                  - To use the default retry rule, specify `true`. 
                  - To use the custom retry rule specific to this payment method, specify `false`.
              type: boolean
          type: object
        - $ref: '#/components/schemas/PUTPMCreditCardInfo'
        - $ref: '#/components/schemas/PUTPaymentMethodObjectCustomFields'
      example:
        securityCode: '331'
    PUTPaymentMethodResponse:
      properties:
        id:
          description: |
            ID of the updated payment method.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    PUTVerifyPaymentMethodType:
      example:
        securityCode: '737'
      properties:
        currencyCode:
          description: |
            The currency used for payment method authorization. 
          type: string
        gatewayOptions:
          description: >
            The field used to pass gateway-specific parameters and parameter
            values. The fields supported by gateways vary. For more information,
            see the Overview topic of each gateway integration in [Zuora
            Knowledge
            Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


            Zuora sends all the information that you specified to the gateway.
            If you specify any unsupported gateway option parameters, they will
            be ignored without error prompts.
          properties:
            key:
              description: |
                The name of a gateway-specific parameter.
              type: string
            value:
              description: |
                The value of the gateway-specific parameter.
              type: string
          type: object
        paymentGatewayName:
          description: >
            The name of the payment gateway instance.
             
            If <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
            target="_blank">Payment Gateway Routing</a> is enabled: 
              - If this field is not specified, gateway routing rules will be invoked.
              - If this field is specified, the specified gateway will be used to verify the payment.

            If Payment Gateway Routing is disabled:
              - If this field is not specified, the default payment gateway will be used to verify the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. 
              - If this field is specified, the specified gateway will be used to verify the payment.
          type: string
        securityCode:
          description: >
            The CVV or CVV2 security code for the credit card or debit card. To
            ensure PCI compliance, the value of this field is not stored and
            cannot be queried.
          type: string
      type: object
    PUTVerifyPaymentMethodResponseType:
      properties:
        paymentMethodId:
          description: |
            The ID of the verified payment method.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GetBankAccountBalanceResponse:
      properties:
        success:
          description: |
            Indicates whether this call succeeds.
          type: boolean
        currency:
          description: |
            The currency of the account balance.
          type: string
        availableBalance:
          description: >
            The amount of funds available to be withdrawn from the account. 

            For more information, see <a
            href="https://plaid.com/docs/api/products/balance/#accounts-balance-get-response-accounts-balances"
            target="_blank">Plaid's documentation</a>.
          type: number
          format: double
        currentBalance:
          description: >
            The total amount of funds in the account, which does not take
            pending transactions into account. 

            For more information, see <a
            href="https://plaid.com/docs/api/products/balance/#accounts-balance-get-response-accounts-balances"
            target="_blank">Plaid's documentation</a>.
          type: number
          format: double
      type: object
    GetStoredCredentialProfilesResponse:
      properties:
        profiles:
          description: |
            Container for stored credential profiles.
          items:
            properties:
              activatedOn:
                description: >
                  The date when the stored credential profile was activated (if
                  applicable).
                format: date-time
                type: string
              agreedOn:
                description: |
                  The date when the stored credential profile was created.
                format: date-time
                type: string
              brand:
                description: >
                  The stored credential transaction framework. For example,
                  Visa.
                type: string
              cancelledOn:
                description: >
                  The date when the stored credential profile was cancelled (if
                  applicable).
                format: date-time
                type: string
              consentAgreementRef:
                description: >
                  Your reference for the consent agreement that you have
                  established with the customer.
                maxLength: 128
                type: string
              consentAgreementSrc:
                enum:
                  - External
                type: string
              expiredOn:
                description: >
                  The date when the stored credential profile was expired (if
                  applicable).
                format: date-time
                type: string
              number:
                description: >
                  The number that identifies the stored credential profile
                  within the payment method.
                type: integer
              paymentMethodId:
                description: |
                  ID of the payment method.
                type: string
              status:
                description: >
                  The status of the stored credential profile.


                  * `Agreed` - The stored credential profile has not been
                  validated via an authorization transaction with the payment
                  gateway.

                  * `Active` - The stored credential profile has been validated
                  via an authorization transaction with the payment gateway.

                  * `Cancelled` - The stored credentials are no longer valid,
                  per a customer request. Zuora cannot use the stored
                  credentials in transactions.

                  * `Expired` - The stored credentials are no longer valid, per
                  an expiration policy in the stored credential transaction
                  framework. Zuora cannot use the stored credentials in
                  transactions.
                enum:
                  - Agreed
                  - Active
                  - Cancelled
                  - Expired
                type: string
              type:
                enum:
                  - Recurring
                  - Unscheduled
                type: string
          type: array
        success:
          type: boolean
      type: object
    CreateStoredCredentialProfileRequest:
      example:
        authGateway: 4028905f5702783601570291e14c0015
        consentAgreementRef: ACCT1338AgreementV1.pdf
        consentAgreementSrc: External
        status: Active
        type: Recurring
      properties:
        action:
          description: >
            Specifies how Zuora activates the stored credential profile. Only
            applicable if you set the `status` field to `Active`.


            - `Activate` (default) - Use this value if you are creating the
            stored credential profile after receiving the customer's consent.

              Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile.
              
              If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`.


            - `Persist` - Use this value if the stored credential profile
            represents a stored credential profile in an external system. The
            status of the payment method's stored credential profile will be
            `Active`.
          enum:
            - Activate
            - Persist
          type: string
        agreedOn:
          description: >
            The date on which the profile is agreed. The date format is
            `yyyy-mm-dd`.
          format: date
          type: string
        authGateway:
          description: >
            Specifies the ID of the payment gateway that Zuora will use when
            activating the stored credential profile.
          type: string
        cardSecurityCode:
          description: |
            The security code of the credit card.
          type: string
        consentAgreementRef:
          description: >
            Specifies your reference for the consent agreement that you have
            established with the customer.
          maxLength: 128
          type: string
        consentAgreementSrc:
          description: >
            Specifies how the consent agreement has been established with the
            customer. The allowed value is `External`.
          enum:
            - External
          type: string
        networkTransactionId:
          description: >
            The ID of a network transaction. Only applicable if you set the
            `action` field to `Persist`.
          maxLength: 128
          type: string
        status:
          description: >
            Specifies the status of the stored credential profile.


            - `Active` - Use this value if you are creating the stored
            credential profile after receiving the customer's consent, or if the
            stored credential profile represents a stored credential profile in
            an external system.

              You can use the `action` field to specify how Zuora activates the stored credential profile.


            - `Agreed` - Use this value if you are migrating the payment method
            to the stored credential transaction framework.

              In this case, Zuora will not send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile.
          enum:
            - Agreed
            - Active
          type: string
        type:
          description: >
            Indicates the type of the stored credential profile to process
            recurring or unsecheduled transactions.
          enum:
            - Recurring
            - Unscheduled
          type: string
      required:
        - status
        - type
        - consentAgreementSrc
      type: object
    ModifiedStoredCredentialProfileResponse:
      properties:
        number:
          description: >
            The number that identifies the stored credential profile within the
            payment method.
          type: integer
        paymentMethodId:
          description: |
            ID of the payment method.
          type: string
        success:
          type: boolean
      type: object
    GETListApplePayDomainsResponse:
      properties:
        domains:
          description: |
            Container for domains that are already registered with Apple Pay.
          items:
            properties:
              createdBy:
                description: |
                  The ID of the user who created this domain.
                type: string
              createdOn:
                description: >
                  The date and time when the domain was created, in `yyyy-mm-dd
                  hh:mm:ss` format. 
                format: date-time
                type: string
              domainName:
                description: >
                  The name of the domain registered with Apple Pay, such as
                  `testapplepay.zuora.com`. 
                type: string
              domainVerified:
                description: >
                  Indicates whether the domain registration is successfully
                  verified. 
                type: boolean
              id:
                description: >
                  The ID of the domain, such as
                  `402881a38924ff1001892502da090021`.
                type: string
              updatedBy:
                description: |
                  The ID of the user who made the last update to this domain.
                type: string
              updatedOn:
                description: >
                  The last date and time when the domain was updated, in
                  `yyyy-mm-dd hh:mm:ss` format.
                format: date-time
                type: string
          type: array
        success:
          description: |
            Indicates whether this call succeeds.
          type: boolean
      type: object
    POSTRegisterApplePayDomainRequest:
      example:
        domainName: testapplepay.zuora.com
      properties:
        domainName:
          description: >
            The name of the domain to be registered with Apple Pay, such as
            `testapplepay.zuora.com`.
          type: string
      required:
        - domainName
      type: object
    POSTRegisterApplePayDomainResponse:
      properties:
        domainName:
          description: >
            The name of the domain registered with Apple Pay, such as
            `testapplepay.zuora.com`.
          type: string
        domainVerified:
          description: |
            Indicates whether the domain registration is successfully verified.
          type: boolean
        id:
          description: |
            The ID of the domain, such as `402881a38924ff1001892502da090021`.
          type: string
        success:
          description: |
            Indicates whether this call succeeds.
          type: boolean
      type: object
    DELETEUnresigerApplePayDomainResponse:
      properties:
        success:
          description: Indicates whether this call succeeds.
          type: boolean
      type: object
    POSTCreatePaymentSessionRequest:
      example:
        currency: USD
        accountId: 402882e98d3a964b018d3a9c99ef0167
        processPayment: true
        storePaymentMethod: true
        paymentGateway: 402883827d097a28017d09b41f690261
        invoices:
          - invoiceNumber: INV00001274
          - invoiceNumber: INV00001278
        amount: 100
      properties:
        accountId:
          description: >
            The ID of the customer account in Zuora that is associated with this

            payment method.


            This field is required when `processPayment` is set to `true`. It is
            optional when `processPayment` is set to `false`.
          type: string
        amount:
          description: >
            If `processPayment` is `true`, it is the amount of the payment. If
            `invoices` is specified, the value of `amount` must be the current
            total balances of the specified invoices.


            If `processPayment` is `false`, it is the authorization amount for
            the payment method.
          type: number
        authAmount:
          description: >
            The authorization amount for the payment method. Specify a value
            greater

            than 0.


            **Note:** This field is being deprecated. It is recommended to use
            the `amount` field.
          type: number
        currency:
          description: |
            The currency of the payment in the format of the three-character ISO
            currency code.
          type: string
        gatewayOptions:
          description: >
            The field used to pass gateway-specific parameters and parameter
            values.

            The fields supported by gateways vary. For more information, see the

            overview topic of each gateway integration in <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Manage_payment_gateway_integrations_and_payment_methods/Set_up_payment_gateway_integrations"
            target="_blank">Zuora Knowledge Center</a>.


            Zuora sends all the information that you specified to the gateway.
            If you

            specify any unsupported gateway option parameters, they will be
            ignored

            without error prompts.
          type: object
          title: GatewayOptions
          additionalProperties:
            type: string
            description: |
              The gateway options specification consists of key-value pairs:
                - Field name: The name of a gateway-specific parameter.
                - Field value: The value of the gateway-specific parameter.
        paymentGateway:
          description: >
            The ID of the payment gateway instance configured in Zuora that will

            process the payment, such as `e884322ab8c711edab030242ac120004`.


            If <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
            target="_blank">Payment Gateway Routing</a> is enabled: 
              - If this field is not specified, gateway routing rules will be invoked.
              - If this field is specified, the specified gateway will be used to process the payment.

            If Payment Gateway Routing is disabled:
              - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. 
              - If this field is specified, the specified gateway will be used to process the payment.
          type: string
        processPayment:
          description: >
            Indicate whether a payment should be processed after creating the
            payment

            method.


            If this field is set to `true`, you must specify either the `amount`
            field or the `invoices` and `amount` fields.


            If this field is set to `false`, you must specify the `amount`
            field.
          type: boolean
        storePaymentMethod:
          description: >
            `true` indicates that the payment method will be stored in Zuora and
            will be used 

            in subsequent recurring payments.


            `false` indicates that the payment method will not be stored in
            Zuora. 

            End-customers need to be brought back on-session to authenticate the
            payment.
          type: boolean
          default: true
        invoices:
          description: >
            The array of invoices that a payment applies to. All the specified
            invoices will be fully paid. 

            The value of the `amount` field must be the current total balances
            of the specified invoices.


            Here is an example:


            ```

            "invoices": [
              {
                "invoiceNumber": "INV00001274"
              },
              {
                "invoiceNumber": "INV00001278"
              }
            ]

            ```
          items:
            type: object
            properties:
              invoiceNumber:
                description: |
                  The invoice number, such as `INV0000001`.
                type: string
          type: array
      required:
        - currency
        - processPayment
        - amount
      type: object
    POSTCreatePaymentSessionResponse:
      properties:
        token:
          description: |
            The token for the payment session data.
          type: string
      type: object
    ProxyGetPaymentMethodSnapshot:
      properties:
        AccountId:
          description: The ID of the customer account associated with this payment method.
          type: string
        AchAbaCode:
          description: >-
            The nine-digit routing number or ABA number used by banks.
            Applicable to ACH payment methods.
          type: string
        AchAccountName:
          description: >-
            The name of the account holder, which can be either a person or a
            company. Applicable to ACH payment methods.
          type: string
        AchAccountNumberMask:
          description: >-
            This is a masked displayable version of the ACH account number, used
            for security purposes. For example: `XXXXXXXXX54321`.
          type: string
        AchAccountType:
          description: The type of bank account associated with the ACH payment.
          enum:
            - BusinessChecking
            - Checking
            - Saving
          type: string
        AchBankName:
          description: The name of the bank where the ACH payment account is held.
          type: string
        BankBranchCode:
          description: The branch code of the bank used for direct debit.
          type: string
        BankCheckDigit:
          description: >-
            The check digit in the international bank account number, which
            confirms the validity of the account. Applicable to direct debit
            payment methods.
          type: string
        BankCity:
          description: The city of the direct debit bank.
          type: string
        BankCode:
          description: >-
            The sort code or number that identifies the bank. This is also known
            as the sort code.
          type: string
        BankIdentificationNumber:
          description: >-
            The first six or eight digits of the payment method's number, such
            as the credit card number or account number. Banks use this number
            to identify a payment method.
          type: string
        BankName:
          description: The name of the direct debit bank.
          type: string
        BankPostalCode:
          description: The zip code or postal code of the direct debit bank.
          type: string
        BankStreetName:
          description: The name of the street of the direct debit bank.
          type: string
        BankStreetNumber:
          description: The number of the direct debit bank.
          type: string
        BankTransferAccountName:
          description: The name on the direct debit bank account.
          type: string
        BankTransferAccountNumberMask:
          description: >-
            This is a masked displayable version of the bank account number,
            used for security purposes. For example: `XXXXXXXXX54321`.
          type: string
        BankTransferAccountType:
          description: >-
            The type of the customer's bank account. Applicable to direct debit
            payment methods.
          type: string
        BankTransferType:
          description: >
            Specifies the type of direct debit transfer. The value of this field
            is dependent on the country of the user.


            Possible Values: 



            * `AutomatischIncasso` (NL)


            * `LastschriftDE` (Germany)


            * `LastschriftAT` (Austria)


            * `DemandeDePrelevement` (FR)


            * `DirectDebitUK` (UK)


            * `Domicil` (Belgium)


            * `LastschriftCH` (CH)


            * `RID` (Italy)


            * `OrdenDeDomiciliacion` (Spain)

            * `Autogiro` (Sweden)

            * `Betalingsservice` (Denmark)
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        BusinessIdentificationCode:
          description: >-
            The business identification code for Swiss direct payment methods
            that use the Global Collect payment gateway. Only applicable to
            direct debit payments in Switzerland with Global Collect.
          type: string
        City:
          description: >-
            The city of the customer's address. Applicable to debit payment
            methods.
          type: string
        CompanyName:
          description: |
            The name of the company.
          type: string
        Country:
          description: >-
            The two-letter country code of the customer's address. Applicable to
            direct debit payment methods.
          type: string
        CreditCardAddress1:
          description: >-
            The first line of the card holder's address, which is often a street
            address or business name. Applicable to credit card and direct debit
            payment methods.
          type: string
        CreditCardAddress2:
          description: >-
            The second line of the card holder's address. Applicable to credit
            card and direct debit payment methods.
          type: string
        CreditCardCity:
          description: >-
            The city of the card holder's address. Applicable to credit card and
            direct debit payment methods.
          type: string
        CreditCardCountry:
          description: The country of the card holder's address.
          type: string
        CreditCardExpirationMonth:
          description: >-
            The expiration month of the credit card or debit card. Applicable to
            credit card and direct debit payment methods.
          format: int32
          type: integer
        CreditCardExpirationYear:
          description: >-
            The expiration month of the credit card or debit card. Applicable to
            credit card and direct debit payment methods.
          format: int32
          type: integer
        CreditCardHolderName:
          description: >-
            The full name of the card holder. Applicable to credit card and
            direct debit payment methods.
          type: string
        CreditCardMaskNumber:
          description: A masked version of the credit or debit card number.
          type: string
        CreditCardPostalCode:
          description: The billing address's zip code.
          type: string
        CreditCardState:
          description: >-
            The billing address's state. Applicable if `CreditCardCountry` is
            either Canada or the US.
          type: string
        CreditCardType:
          description: The type of credit card or debit card.
          enum:
            - AmericanExpress
            - Discover
            - MasterCard
            - Visa
          type: string
        DeviceSessionId:
          description: >-
            The session ID of the user when the `PaymentMethod` was created or
            updated.
          type: string
        Email:
          description: >-
            An email address for the payment method in addition to the bill to
            contact email address.
          type: string
        ExistingMandate:
          description: >-
            Indicates if the customer has an existing mandate or a new mandate.
            Only applicable to direct debit payment methods.
          enum:
            - 'Yes'
            - 'No'
          type: string
        FirstName:
          description: >-
            The customer's first name. Only applicable to direct debit payment
            methods.
          type: string
        IBAN:
          description: >-
            The International Bank Account Number. Only applicable to direct
            debit payment methods.
          type: string
        IPAddress:
          description: >-
            The IP address of the user when the payment method was created or
            updated.
          type: string
        Id:
          description: Object identifier.
          type: string
        IdentityNumber:
          description: |
            The unique identity number of the customer account. 
          type: string
        IsCompany:
          description: |
            Whether the customer account is a company.
          type: boolean
        LastFailedSaleTransactionDate:
          description: >-
            The date of the last failed attempt to collect payment with this
            payment method.
          format: date-time
          type: string
        LastName:
          description: >-
            The customer's last name. Only applicable to direct debit payment
            methods.
          type: string
        LastTransactionDateTime:
          description: The date of the most recent transaction.
          format: date-time
          type: string
        LastTransactionStatus:
          description: The status of the most recent transaction.
          type: string
        MandateCreationDate:
          description: >-
            The date when the mandate was created, in `yyyy-mm-dd` format. A
            mandate is a signed authorization for UK and NL customers. Only
            applicable to direct debit payment methods.
          format: date
          type: string
        MandateID:
          description: >-
            The ID of the mandate. A mandate is a signed authorization for UK
            and NL customers. Only applicable to direct debit payment methods.
          type: string
        MandateReceived:
          description: >-
            Indicates if  the mandate was received. A mandate is a signed
            authorization for UK and NL customers. Only applicable to direct
            debit payment methods.
          type: string
        MandateUpdateDate:
          description: >-
            The date when the mandate was last updated, in `yyyy-mm-dd` format.
            A mandate is a signed authorization for UK and NL customers. Only
            applicable to direct debit payment methods.
          format: date
          type: string
        MaxConsecutivePaymentFailures:
          description: >-
            The number of allowable consecutive failures Zuora attempts with the
            payment method before stopping.
          type: integer
        Name:
          description: The name of the payment method.
          type: string
        NumConsecutiveFailures:
          description: The number of consecutive failed payment for the payment method.
          format: int32
          type: integer
        PaymentMethodId:
          description: Object identifier of the payment method.
          type: string
        PaymentMethodStatus:
          description: Specifies the status of the payment method.
          enum:
            - Active
            - Closed
          type: string
        PaymentRetryWindow:
          description: >-
            The retry interval setting, which prevents making a payment attempt
            if the last failed attempt was within the last specified number of
            hours.
          type: integer
        PaypalBaid:
          description: >-
            The PayPal billing agreement ID, which is a contract between two
            PayPal accounts.
          type: string
        PaypalEmail:
          description: >-
            The email address associated with the account holder's PayPal
            account or of the PayPal account of the person paying for the
            service.
          type: string
        PaypalPreapprovalKey:
          description: PayPal's Adaptive Payments API key.
          type: string
        PaypalType:
          description: >-
            Specifies the PayPal gateway: PayFlow Pro (Express Checkout) or
            Adaptive Payments.
          enum:
            - ExpressCheckout
            - AdaptivePayments
          type: string
        Phone:
          description: >-
            The phone number that the account holder registered with the bank.
            This field is used for credit card validation when passing to a
            gateway.
          type: string
        PostalCode:
          description: >-
            The zip code of the customer's address. Only applicable to direct
            debit payment methods.
          type: string
        SecondTokenId:
          description: >-
            A gateway unique identifier that replaces sensitive payment method
            data. Applicable to CC Reference Transaction payment methods.
          type: string
        State:
          description: >-
            The state of the customer's address. Only applicable to direct debit
            payment methods.
          type: string
        StreetName:
          description: >-
            The street name of the customer's address. Only applicable to direct
            debit payment methods.
          type: string
        StreetNumber:
          description: >-
            The street number of the customer's address. Only applicable to
            direct debit payment methods.
          type: string
        TokenId:
          description: >-
            A gateway unique identifier that replaces sensitive payment method
            data or represents a gateway's unique customer profile. Applicable
            to CC Reference Transaction payment methods.
          type: string
        TotalNumberOfErrorPayments:
          description: The number of error payments that used this payment method.
          format: int32
          type: integer
        TotalNumberOfProcessedPayments:
          description: The number of successful payments that used this payment method.
          format: int32
          type: integer
        Type:
          description: The type of payment method.
          enum:
            - ACH
            - ApplePay
            - BankTransfer
            - Cash
            - Check
            - CreditCard
            - CreditCardReferenceTransaction
            - DebitCard
            - Other
            - PayPal
            - WireTransfer
          type: string
        UseDefaultRetryRule:
          description: >-
            Determines whether to use the default retry rules configured in the
            Zuora Payments settings.
          type: boolean
      type: object
    ProxyGetPaymentMethodTransactionLog:
      properties:
        Gateway:
          description: ''
          type: string
        GatewayReasonCode:
          description: ''
          type: string
        GatewayReasonCodeDescription:
          description: ''
          type: string
        GatewayTransactionType:
          description: ''
          type: string
        Id:
          description: Object identifier.
          type: string
        PaymentMethodId:
          description: ''
          type: string
        PaymentMethodType:
          description: ''
          type: string
        RequestString:
          description: ''
          type: string
        ResponseString:
          description: ''
          type: string
        TransactionDate:
          description: ''
          format: date-time
          type: string
        TransactionId:
          description: ''
          type: string
      type: object
    GETPaymentMethodUpdaterInstancesResponse:
      properties:
        success:
          description: Indicates whether the call is successful.
          type: boolean
        updaters:
          description: |
            Container for PMU instances available on your tenant.
          properties:
            daysToUpdateBeforeBcd:
              description: |
                The days prior to the Bill Cycle Day to start PMU service.
              type: integer
            id:
              description: |
                The ID of the PMU instance.
              type: string
            isActive:
              description: |
                `true` indicates that this PMU instance is active.
              type: boolean
            isDefault:
              description: |
                `true` indicates that it is the default PMU instance.
              type: boolean
            isTest:
              description: |
                `true` indicates that this PMU instance is for testing.
              type: string
            processAssociatedGwOnly:
              description: >
                `true` indicates that only the payment methods for customer
                accounts that meet either of the following conditions are
                included in the updates:
                  - The default payment gateway of the customer account is set to an instance of the same type as `updaterGatewayType`.
                  - The default payment gateway of the customer account is not configured, but the default payment gateway of the tenant is set to an instance of the same type as `updaterGatewayType`.

                `false` indicates that information of all payment methods is
                submitted.
              type: boolean
            processAutopayDefaultPmOnly:
              description: >
                `true` indicates that only the default payment methods for
                customer accounts with the AutoPay setting enabled are included
                in the updates. 


                `false` indicates that data of all payment methods for all
                customer accounts is submitted, regardless of whether AutoPay is
                enabled for the customer account or not.
              type: boolean
            processMastercard:
              description: |
                `true` indicates that Mastercard data processing is supported.
              type: boolean
            processVisa:
              description: |
                `true` indicates that Visa data processing is supported.
              type: boolean
            updaterGatewayType:
              description: |
                The payment gateway type of the PMU instance.
              type: string
            updaterName:
              description: |
                The name of the PMU instance.
              type: string
          type: object
      type: object
    POSTPaymentMethodUpdaterBatchRequest:
      example:
        billingCycleDay: 5
        updaterAccountId: 418734b01fbb11ee821f0e4e5eec84cf
      properties:
        billingCycleDay:
          description: >
            The billing cycle day. The allowed value is an integer in the range
            of 1 - 31.


            The payment methods from accounts where the billing cycle day is the
            specified value in this field will be included in the updates.
          type: integer
        updaterAccountId:
          description: >
            The ID (UUID) of the PMU account. This field must be a string of 32
            characters consisting of digits and letters a - f.
          type: string
      required:
        - updaterAccountId
        - billingCycleDay
      type: object
    POSTPaymentMethodUpdaterResponse:
      properties:
        success:
          description: >
            Indicates whether the request to create a PMU batch is sent
            successfully.
          type: boolean
      type: object
    POSTRSASignatureType:
      example:
        method: POST
        pageId: 2c92c0f855e2b4630155ec9e6a1b6eec
        uri: https://apisandbox.zuora.com/apps/PublicHostedPageLite.do
      properties:
        IBAN:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        accountId:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        authorizationAmount:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: number
        bankBranchCode:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        bankCheckDigit:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        bankCity:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        bankPostalCode:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        bankStreetName:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        bankStreetNumber:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        businessIdentificationCode:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for Bank Transfer - Direct
            Debit. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        cityBlackList:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for credit cards. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        cityWhiteList:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for credit cards. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        currency:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        deviceSessionId:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        gatewayName:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        id:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        key:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        locale:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        maxConsecutivePaymentFailures:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: integer
        method:
          description: |
            The type of the request. Set it to POST.
          type: string
        pageId:
          description: >
            The page id of your Payment Pages 2.0 form. Click **Show Page Id**
            next to the Payment Page name in the Hosted Page List to retrieve
            the page id.
          type: string
        param_gwOptions_[*option*]:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        param_supportedTypes:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for credit cards. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        passthrough[1,2,3,4,5]:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.


            Note: Although up to 15 passthrough parameters can be supported when
            passing in your client parameters, only the first 5 parameters are
            used for signature generation and validation.
          type: string
        paymentGateway:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        paymentRetryWindow:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: integer
        pmId:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters specific for credit cards. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        signature:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        signatureType:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        style:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        submitEnabled:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: boolean
        tenantId:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        token:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: string
        uri:
          description: >
            The URL that the Payment Page will be served from.

            * For US Cloud 1 Production environment: Use
            https://na.zuora.com/apps/PublicHostedPageLite.do

            * For US Cloud 1 Sandbox environment: Use
            https://sandbox.na.zuora.com/apps/PublicHostedPageLite.do

            * For US Cloud 2 Production environment: Use
            https://www.zuora.com/apps/PublicHostedPageLite.do

            * For US Cloud 2 API Sandbox environment: Use
            https://apisandbox.zuora.com/apps/PublicHostedPageLite.do

            * For US Central Sandbox environment: Use
            https://test.zuora.com/apps/PublicHostedPageLite.do

            * For EU Cloud Production environment: Use
            https://eu.zuora.com/apps/PublicHostedPageLite.do

            * For EU Cloud Sandbox environment: Use
            https://sandbox.eu.zuora.com/apps/PublicHostedPageLite.do

            * For EU Central Sandbox environment: Use
            https://test.eu.zuora.com/apps/PublicHostedPageLite.do
          type: string
        useDefaultRetryRule:
          description: >
            An optional client parameter that can be used for validating
            client-side HPM parameters. 

            See [Client parameters for Payment Pages
            2.0](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/J_Client_Parameters_for_Payment_Pages_2.0) 

            and [Validate client-side HPM
            parameters](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/LA_Hosted_Payment_Pages/B_Payment_Pages_2.0/F_Generate_the_Digital_Signature_for_Payment_Pages_2.0#Validate_Client-side_HPM_Parameters) 

            for details.
          type: boolean
      required:
        - method
        - pageId
        - uri
      type: object
    POSTRSASignatureResponseType:
      properties:
        key:
          description: |
            Public key generated for this Payment Page.
          type: string
        signature:
          description: >
            Digital signature generated for this Payment Page.


            If `signature` returns `null` but `token` is successfully returned,
            please limit the number of the fields in your request to make sure
            that the maximum length supported by the RSA signature algorithm is
            not exceeded.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        tenantId:
          description: |
            ID of the Zuora tenant.
          type: string
        token:
          description: |
            Token generated for this Payment Page.
          type: string
      type: object
    POSTDecryptionType:
      example:
        method: POST
        publicKey: >-
          MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmWRFTwxQOqaG4JDZSQF/NJWvCDoSXm3TYilNzoN8nBbuvhKa7SZBBS+VP6rFqcbIU38Fu+Rf09vqyYOxuasPJe7yhqeOiStWB/aCPLhwXBeKt37L/qkwpNOKb1FETtUgrc+UjbtT0pnl55wCfi+Ik//X5SQi0B+c0ei1DQv99qmPJJErrhnBtdxeaWAT0EYAo42AOQ5cp0UWDY6OdOYL6+RyFOUFIs1yEgtfg4VMMSpSOKBOhYclQYuSC7nBF5Cc18ydtzsBpf7l49gCLTFzG45NCDAocada8KihFNpGXbauV9V4EPRD4lofaXdsXJ5Tw8/+KCsrUlvIQI3vcEv9LQIDAQAB
        signature: >-
          BeNYuHFkp/sbfm3clYyCkKEqd7XVTRDOJ1/5rL0tpkqxiSq+maqYkDz5kA+lN64ipoefQuJ7Rdm5TpICErufeJfa2sfTmGARDJ0hr+StXfLsIxHmDoNH5dqcXv3W6MR4kaljEqPVuhzGQ0We98DG52JcHWqqN53oHwTyuZuXocQqnmiE23IPm8UrU3g4hX/OLat0R81wDQ1SslZ+4pnqlncpTpopCK4FxeG3B0gYMhZcYd17Cmf0N3tEHVXHDlJIm4rOx0OVT+YBnjbKYLM0jxYu7PRKRis+yzN1BoappOEB0gmPjznIeiYF0u/fJdZWoEwK7d9mrfJeOBbpFyRoHA==
      properties:
        method:
          description: |
            The type of the request. Set it to POST.
          type: string
        publicKey:
          description: |
            The public key generated by Zuora.
          type: string
        signature:
          description: |
            The signature generated by Zuora.
          type: string
      required:
        - method
        - publicKey
        - signature
      type: object
    POSTDecryptResponseType:
      properties:
        decryptedSignature:
          description: >
            The string of a list of the following items: Payment Pages 2.0 URL,
            tenant ID, timestamp,the Payment Page ID


            The items are separated by '#', e.g.,
            "/apps/publichostedpagelite.do#12271#rvBp1AxBJwk6FrT7aqFuABIINiRbwJCc

            #1418848373103#2c92c0f948f899"
          type: string
        publicKey:
          description: |
            The public key passed in as a request parameter.
          type: string
        signature:
          description: |
            The signature passed in as a request parameter.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GetHostedPageType:
      properties:
        pageId:
          description: |
            Page ID of the Payment Page that Zuora assigns when it is created.
          type: string
        pageName:
          description: >
            Name of the Payment Page that specified during the page
            configuration.
          type: string
        pageType:
          description: >
            Payment method type of this Payment Page, e.g. 'Credit Card', 'ACH',
            or 'Bank Transfer'.
          type: string
        pageVersion:
          description: |
            Version of the Payment Page. 2 for Payment Pages 2.0.
          type: string
      title: hostedpages
      type: object
    GetHostedPagesType:
      properties:
        hostedpages:
          description: |
            Container for the hosted page information.
          items:
            $ref: '#/components/schemas/GetHostedPageType'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    OpenPaymentMethodTypeRequestFields:
      properties:
        checksum:
          description: >
            The checksum value of a payment method is used to identify if this
            payment method is the same as another one, or if this payment method
            is altered to another new payment method.


            Set this flag to `true` for the following scenarios:
              - The field should be part of checksum calculation.
              - The field is a critical differentiator for this type. 

                
            For example, if you select the credit card number and expiration
            date as the checksum fields for the CreditCard payment method type,
            when you modified the expiration date, Zuora considers this payment
            method as a different payment method compared to the original one.


            This field cannot be `null` or empty.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: boolean
        defaultValue:
          description: >
            The default value of the field. `null` is supported.


            If a required field is added after the custom payment method type is
            published, `defaultValue` is required.


            This field cannot be updated after the creation of the custom
            payment method type.
          maxLength: 255
          type: string
        description:
          description: |
            An explanation of this field. It can be an empty string.
          maxLength: 70
          type: string
        editable:
          description: >
            Specify `true` if this field can be updated through PUT API or UI.


            This field cannot be `null` or empty.


            Note: If `editable` is set to `false`, you can specify the value of
            this field in the UI and POST API when creating a payment method.
            However, after you created the payment method, you cannot edit this
            field through PUT API or UI.
          type: boolean
        index:
          description: >
            The order of the field in this type, starting from 1. It must be
            unique.


            This field cannot be `null` or empty.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: integer
        label:
          description: >
            The label that is used to refer to this field in the Zuora UI.


            An alphanumeric string, excluding JSON preserved characters e.g.  *
            \ ’ ”


            This field cannot be `null` or empty or any reserved field name.
          maxLength: 30
          type: string
        maxLength:
          description: >
            A maximum length limitation of the field value. The specified value
            must be in the range of [1,8000]. `maxLength` must be greater than
            or equal to `minLength`.


            After the custom payment method type is created, you can only
            increase the value of `maxLength`. Decreasing the value is not
            supported.
          type: integer
        minLength:
          description: >
            A minimal length limitation of the field value.
                
            0 <= `minLength` <= `maxLength`


            The value of this metadata does not determine whether the field is a
            required field. It only defines the minimal length of the field
            value.


            After the custom payment method type is created, you can only
            decrease the value of `minLength`. Increasing the value is not
            supported.
          type: integer
        name:
          description: >
            The API name of this field. It must be uinique.


            An alphanumeric string starting with a capital letter, excluding
            JSON preserved characters e.g.  * \ ’ ”


            Though this field must be defined with a string starting with a
            capital letter, use this string with the first letter in lowercase
            when you specify it in other API operations. For example,
            `AmazonPayToken` is the defined value for `name`. In the request of
            the "Create a payment method" API operation, use `amazonPayToken`.


            This field cannot be `null` or empty or any reserved field name.


            This field cannot be updated after the creation of the custom
            payment method type.
          maxLength: 30
          type: string
        representer:
          description: >
            This flag determines whether this field will be used for identifying
            this payment method in the Zuora UI. The field will be shown in the
            Payment Method field in the UI.


            This field cannot be `null` or empty.


            Notes:
              - In one custom payment method type, set `representer` to `true` for at least one field .
              - In one custom payment method type, you can set `representer` to `true` for multiple fields.
          type: boolean
        required:
          description: >
            Specify whether this field is required.


            This field cannot be `null` or empty.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: boolean
        type:
          description: >
            The type of this field.


            For the `date` type, ISO_LOCAL_DATE format is supported, such as
            `2011-12-03`. The timezone is not expected for the `date` type. For
            example, `2011-12-03+01:00` will be rejected.


            For the `datetime` type, only ISO_OFFSET_DATE_TIME format is
            supported, such as `2011-12-03T10:15:30+01:00`. Timezone must be
            included. A string like `2011-12-03T10:15:30` or
            `2011-12-03T10:15:30+01:00[Europe/Paris]` will be rejected.


            If you need to define a `date` type with timezone or a `datetime`
            type without timezone, use the `string` type for now.


            This field cannot be `null` or empty.


            This field cannot be updated after the creation of the custom
            payment method type.
          enum:
            - string
            - date
            - datetime
            - number
            - boolean
          type: string
        visible:
          description: >
            Specify `true` if this field can be retrieved through GET API or UI
            for displaying payment method details.


            This field cannot be `null` or empty.


            Notes: 
              - If `visible` is set to `false`, you can still specify the value of this field in the UI and POST API when creating the payment method.
              - If `visible` is set to `false` and `editable` is set to `true`, this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method.
          type: boolean
      title: fields
    POSTCreateOpenPaymentMethodTypeRequest:
      example:
        entityId: ''
        fields:
          - checksum: true
            defaultValue: null
            description: The Token value
            editable: true
            index: 1
            label: AmazonToken
            maxLength: 100
            minLength: 1
            name: AmazonToken
            representer: true
            required: true
            type: string
            visible: true
          - checksum: true
            defaultValue: null
            description: The Type of Token, e.g. GoCardlessToken
            editable: true
            index: 2
            label: Amazon TokenType
            maxLength: 100
            minLength: 1
            name: AmazonTokenType
            representer: true
            required: true
            type: string
            visible: true
        internalName: AmazonPay
        label: ZuoraQA Amazon Pay
        methodReferenceIdField: AmazonToken
        subTypeField: AmazonTokenType
        tenantId: '9'
        userReferenceIdField: ''
      properties:
        entityId:
          description: >
            If this custom payment method type is specific to one entity only,
            provide the entity ID in this field in UUID format, such as
            `123e4567-e89b-12d3-a456-426614174000`. If no entity UUID is
            provided, the custom payment method type is available to the global
            entity and all the sub entities in the tenant.


            You can get the entity ID through the [Multi-entity: List
            entities](https://developer.zuora.com/api-references/older-api/operation/GET_Entities/)
            API operation or the **Manage Entity Profile** administration
            setting in the UI. To convert the format of the entity ID to UUID,
            separate the entity ID string in five groups with hyphens, in the
            form
            `<8-characters>-<4-characters>-<4-characters>-<4-characters>-<12-characters>`
            for a total of 36 characters.


            Note: After the custom payment method type is created, you can only
            update this field to be empty.
          type: string
        fields:
          description: >
            An array containing field metadata of the custom payment method
            type.


            Notes:
              - All the following nested metadata must be provided in the request to define a field. 
              - At least one field must be defined in the fields array for a custom payment method type. 
              - Up to 20 fields can be defined in the fields array for a custom payment method type.
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeRequestFields'
          type: array
        internalName:
          description: >
            A string to identify the custom payment method type in the API name
            of the payment method type.


            This field must be alphanumeric, starting with a capital letter,
            excluding JSON preserved characters such as  * \ ’ ”. Additionally,
            '_' or '-' is not allowed.


            This field must be unique in a tenant.


            This field is used along with the `tenantId` field by the system to
            construct and generate the API name of the custom payment method
            type in the following way:


            `<internalName>__c_<tenantId>`


            For example, if `internalName` is `AmazonPay`, and `tenantId` is
            `12368`, the API name of the custom payment method type will be
            `AmazonPay__c_12368`.


            This field cannot be updated after the creation of the custom
            payment method type.
          maxLength: 19
          type: string
        isSupportAsyncPayment:
          description: >
            If you want to enable the <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow"
            target="_blank">Asynchronous Payment Statuses</a> feature in
            handling transactions 

            with your custom payment method, specify `true` in this field. 

            You also need to complete tasks described in <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Enable_the_Asynchronous_Payment_Statuses_feature"
            target="_blank">Enable the Asynchronous Payment Statuses feature</a>
            in Zuora Knowledge Center.
          type: boolean
          default: false
        label:
          description: >
            The label that is used to refer to this type in the Zuora UI.


            This value must be alphanumeric, excluding JSON preserved characters
            such as  * \ ’ ” 
          maxLength: 40
          type: string
        methodReferenceIdField:
          description: >
            The identification reference of the custom payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Payment Method Data Source Exports and Data Query.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
        subTypeField:
          description: >
            The identification reference indicating the subtype of the custom
            payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
        tenantId:
          description: >
            Zuora tenant ID. If multi-entity is enabled in your tenant, this is
            the ID of the parent tenant of all the sub entities.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
        userReferenceIdField:
          description: >
            The identification reference of the user or customer account.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
      required:
        - internalName
        - tenantId
        - label
        - methodReferenceIdField
        - fields
    POSTCreateOpenPaymentMethodTypeResponse:
      properties:
        paymentMethodType:
          description: |
            The API name of the custom payment method type.
          type: string
        publishDate:
          description: >
            The date when the custom payment method type was published. It is
            empty if the custom payment method type has not been published yet.
          type: string
        revision:
          description: >
            The revision number of the custom payment method type, which starts
            from 1 and increases by 1 when you update a published revision for
            the first time.
          type: integer
        status:
          description: |
            The status of the custom payment method type.
          type: string
    OpenPaymentMethodTypeResponseFields:
      properties:
        checksum:
          description: >
            The checksum value of a payment method is used to identify if this
            payment method is the same as another one, or if this payment method
            is altered to another new payment method.


            For example, if you select the credit card number and expiration
            date as the checksum fields for the CreditCard payment method type,
            when you modified the expiration date, Zuora considers this payment
            method as a different payment method compared to the original one.
          type: boolean
        defaultValue:
          description: |
            The default value of the field.
          type: string
        description:
          description: |
            An explanation of this field.
          type: string
        editable:
          description: >
            Specify `true` if this field can be updated through PUT API or UI.


            Note: If `editable` is set to `false`, you can specify the value of
            this field in the UI and POST API when creating a payment method.
            However, after you created the payment method, you cannot edit this
            field through PUT API or UI.
          type: boolean
        index:
          description: |
            The order of the field in this type, starting from 1.
          type: integer
        label:
          description: |
            The label that is used to refer to this field in the Zuora UI.
          type: string
        maxLength:
          description: |
            A maximum length limitation of the field value.
          type: integer
        minLength:
          description: |
            A minimal length limitation of the field value.
          type: integer
        name:
          description: |
            The API name of this field. It must be uinique.
          type: string
        representer:
          description: >
            This flag determines whether this field will be used for identifying
            this payment method in the Zuora UI. The field will be shown in the
            Payment Method field in the UI.
          type: boolean
        required:
          description: |
            Specify whether this field is required.
          type: boolean
        type:
          description: |
            The type of this field.
          enum:
            - string
            - date
            - datetime
            - number
            - boolean
          type: string
        visible:
          description: >
            Specify `true` if this field can be retrieved through GET API or UI
            for displaying payment method details.


            Notes: 
              - If `visible` is set to `false`, you can still specify the value of this field in the UI and POST API when creating the payment method.
              - If `visible` is set to `false` and `editable` is set to `true`, this field is not accessible through GET API or UI for displaying details, but you can still see it and edit the value in the UI and PUT API when updating this payment method.
          type: boolean
      title: fields
    PUTPublishOpenPaymentMethodTypeResponse:
      properties:
        entityId:
          description: >
            If an entity UUID is provided, this custom payment method type is
            specific to this entity only. If no entity UUID is provided, the
            custom payment method type is available to the global entity and all
            the sub entities in the tenant.
          type: string
        fields:
          description: >
            An array containing field metadata of the custom payment method
            type.
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeResponseFields'
          type: array
        internalName:
          description: >
            A string to identify the custom payment method type in the API name
            of the payment method type.


            This field is used along with the `tenantId` field by the system to
            construct and generate the API name of the custom payment method
            type in the following way:


            `<internalName>__c_<tenantId>`


            For example, if `internalName` is `AmazonPay`, and `tenantId` is
            `12368`, the API name of the custom payment method type will be
            `AmazonPay__c_12368`.
          type: string
        label:
          description: |
            The label that is used to refer to this type in the Zuora UI.
          type: string
        methodReferenceIdField:
          description: >
            The identification reference of the custom payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Payment Method Data Source Exports and Data Query.
          type: string
        revision:
          description: >
            The revision number of the custom payment method type, which starts
            from 1 and increases by 1 when you update a published revision for
            the first time.
          type: integer
        status:
          description: |
            The status of the custom payment method type.
          type: string
        subTypeField:
          description: >
            The identification reference indicating the subtype of the custom
            payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
          type: string
        tenantId:
          description: >
            Zuora tenant ID. If multi-entity is enabled in your tenant, this is
            the ID of the parent tenant of all the sub entities.
          type: string
        userReferenceIdField:
          description: >
            The identification reference of the user or customer account.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
          type: string
        version:
          description: |
            The time when the custom payment method type was first published.
          type: string
    PUTUpdateOpenPaymentMethodTypeRequest:
      example:
        entityId: ''
        fields:
          - checksum: true
            defaultValue: null
            description: The Token value
            editable: true
            index: 1
            label: AmazonToken
            maxLength: 100
            minLength: 1
            name: AmazonToken
            representer: true
            required: true
            type: string
            visible: true
          - checksum: true
            defaultValue: null
            description: The Type of Token, e.g. GoCardlessToken
            editable: true
            index: 2
            label: Amazon TokenType
            maxLength: 100
            minLength: 1
            name: AmazonTokenType
            representer: true
            required: true
            type: string
            visible: true
        internalName: AmazonPay
        label: ZuoraQA Amazon Pay
        methodReferenceIdField: AmazonToken
        subTypeField: AmazonTokenType
        tenantId: '9'
        userReferenceIdField: ''
      properties:
        entityId:
          description: >
            If this custom payment method type is specific to one entity only,
            specify the entity ID in UUID format when creating the draft payment
            method type, such as `123e4567-e89b-12d3-a456-426614174000`.


            You can only update this field to be empty, indicating that this
            custom payment method type is available to the global entity and all
            the sub entities in the tenant.
          type: string
        fields:
          description: >
            An array containing field metadata of the custom payment method
            type.


            Notes:
              - All the following nested metadata fields must be provided in the request to define a field. 
              - At least one field must be defined in the fields array for a custom payment method type. 
              - Up to 20 fields can be defined in the fields array for a custom method type.
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeRequestFields'
          type: array
        internalName:
          description: >
            A string to identify the custom payment method type in the API name
            of the payment method type.


            The value of this field must be the same as the value specified when
            creating the draft revision of this custom payment method type.


            This field cannot be updated after the creation of the custom
            payment method type.


            This field is used along with the `tenantId` field by the system to
            construct and generate the API name of the custom payment method
            type in the following way:


            `<internalName>__c_<tenantId>`


            For example, if `internalName` is `AmazonPay`, and `tenantId` is
            `12368`, the API name of the custom payment method type will be
            `AmazonPay__c_12368`.
          maxLength: 19
          type: string
        isSupportAsyncPayment:
          description: >
            If you want to enable the <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow"
            target="_blank">Asynchronous Payment Statuses</a> feature in
            handling transactions 

            with your custom payment method, specify `true` in this field. 

            You also need to complete tasks described in <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Enable_the_Asynchronous_Payment_Statuses_feature"
            target="_blank">Enable the Asynchronous Payment Statuses feature</a>
            in Zuora Knowledge Center.
          type: boolean
          default: false
        label:
          description: >
            The label that is used to refer to this type in the Zuora UI.


            This value must be alphanumeric, excluding JSON preserved characters
            such as  * \ ’ ” 
          maxLength: 40
          type: string
        methodReferenceIdField:
          description: >
            The identification reference of the custom payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Payment Method Data Source Exports and Data Query.


            The value of this field must be the same as the value specified when
            creating the draft revision of this custom payment method type.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
        subTypeField:
          description: >
            The identification reference indicating the subtype of the custom
            payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
        tenantId:
          description: >
            Zuora tenant ID. If multi-entity is enabled in your tenant, this is
            the ID of the parent tenant of all the sub entities.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
        userReferenceIdField:
          description: >
            The identification reference of the user or customer account.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.


            This field cannot be updated after the creation of the custom
            payment method type.
          type: string
      required:
        - internalName
        - tenantId
        - label
        - methodReferenceIdField
        - fields
    PUTUpdateOpenPaymentMethodTypeResponse:
      properties:
        paymentMethodType:
          description: |
            The API name of the custom payment method type.
          type: string
        publishDate:
          description: >
            The date when the custom payment method type was published. It is
            emptry if the custom payment method type has not been published yet.
          type: string
        revision:
          description: >
            The revision number of the custom payment method type, which starts
            from 1 and increases by 1 when you update a published revision for
            the first time.
          type: integer
        status:
          description: |
            The status of the custom payment method type.
          type: string
    GETOpenPaymentMethodTypeRevisionResponse:
      properties:
        entityId:
          description: >
            If an entity UUID is provided, this custom payment method type is
            specific to this entity only. If no entity UUID is provided, the
            custom payment method type is available to the global entity and all
            the sub entities in the tenant.
          type: string
        fields:
          description: >
            An array containing field metadata of the custom payment method
            type.
          items:
            $ref: '#/components/schemas/OpenPaymentMethodTypeResponseFields'
          type: array
        internalName:
          description: >
            A string to identify the custom payment method type in the API name
            of the payment method type.


            This field is used along with the `tenantId` field by the system to
            construct and generate the API name of the custom payment method
            type in the following way:


            `<internalName>__c_<tenantId>`


            For example, if `internalName` is `AmazonPay`, and `tenantId` is
            `12368`, the API name of the custom payment method type will be
            `AmazonPay__c_12368`.
          type: string
        label:
          description: |
            The label that is used to refer to this type in the Zuora UI.
          type: string
        methodReferenceIdField:
          description: >
            The identification reference of the custom payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
          type: string
        revision:
          description: >
            The revision number of the custom payment method type, which starts
            from 1 and increases by 1 when you update a published revision for
            the first time.
          type: integer
        status:
          description: |
            The status of the custom payment method type.
          type: string
        subTypeField:
          description: >
            The identification reference indicating the subtype of the custom
            payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
          type: string
        tenantId:
          description: >
            Zuora tenant ID. If multi-entity is enabled in your tenant, this is
            the ID of the parent tenant of all the sub entities.
          type: string
        userReferenceIdField:
          description: >
            The identification reference of the user or customer account.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
          type: string
        version:
          description: |
            The time when the custom payment method type was first published.
          type: string
    POSTDelayAuthorizeCapture:
      example:
        accountId: 402881e861bd8a7e0161c6a453750026
        amount: 1.99
        gatewayOrderId: A001
      properties:
        accountId:
          description: >-
            The ID of the customer account. Either `accountId` or
            `accountNumber` is required.
          type: string
        accountNumber:
          description: >-
            The number of the customer account. Either `accountNumber` or
            `accountId` is required.
          type: string
        amount:
          description: The amount of the transaction.
          type: number
        gatewayOptions:
          description: >
            The field used to pass gateway-specific parameters and parameter
            values. The fields supported by gateways vary. For more information,
            see the Overview topic of each gateway integration in [Zuora
            Knowledge
            Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


            Zuora sends all the information that you specified to the gateway.
            If you specify any unsupported gateway option parameters, they will
            be ignored without error prompts.
          properties:
            key:
              description: |
                The name of a gateway-specific parameter.
              type: string
            value:
              description: |
                The value of the gateway-specific parameter.
              type: string
          type: object
        gatewayOrderId:
          description: >
            The order ID for the specific gateway.


            The specified order ID will be used in transaction authorization. If
            you specify an empty value for this field, Zuora will generate an ID
            and you will have to associate this ID with your order ID by
            yourself if needed. It is recommended to specify an ID for this
            field.
          type: string
        mitTransactionSource:
          description: >
            Payment transaction source used to differentiate the transaction
            source in Stored Credential Transaction framework.
              - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
              - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.
              - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
              - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.
          enum:
            - C_Unscheduled
            - M_Recurring
            - M_Unscheduled
            - M_MOTO
          type: string
        paymentGatewayId:
          description: >
            The ID of the payment gateway instance.


            If <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
            target="_blank">Payment Gateway Routing</a> is enabled: 
              - If this field is not specified, gateway routing rules will be invoked.
              - If this field is specified, the specified gateway will be used to authorize the payment.

            If Payment Gateway Routing is disabled:
              - If this field is not specified, the default payment gateway will be used to authorize the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. 
               - If this field is specified, the specified gateway will be used to authorize the payment.
              
          type: string
        softDescriptor:
          description: >-
            A text, rendered on a cardholder’s statement, describing a
            particular product or service purchased by the cardholder.
          type: string
        softDescriptorPhone:
          description: >-
            The phone number that relates to the soft descriptor, usually the
            phone number of customer service.
          type: string
      required:
        - amount
        - gatewayOrderId
      type: object
    POSTAuthorizeResponse:
      example:
        gatewayOrderId: A001
        resultCode: 0
        resultMessage: 'Request ID: 5231719060426316203012'
        success: true
        transactionId: '5231719060426316203012'
      properties:
        gatewayOrderId:
          description: >
            The order ID for the specific gateway.


            The specified order ID will be used in transaction authorization. If
            you specify an empty value for this field, Zuora will generate an ID
            and you will have to associate this ID with your order ID by
            yourself if needed. It is recommended to specify an ID for this
            field.
          type: string
        paymentGatewayResponse:
          description: >
            The response data returned from the gateway. This field is available
            only if the `success` field is `false` and the support for returning
            additional error information from the gateway is enabled.
          properties:
            additionalInfo:
              description: >
                The additional information returned from the gateway. The
                returned fields vary for gateways. Here is an example.


                ```

                "additionalInfo": {
                  "ProcessorName": "MasterCard Saferpay Test",
                  "ProcessorResult": "51",
                  "ProcessorMessage": "Insufficient funds",
                  "ErrorName": "TRANSACTION_DECLINED"
                }

                ```
              type: object
            gatewayResponseCode:
              description: |
                The HTTP response code.
              type: string
            gatewayResponseMessage:
              description: |
                The error message returned from the gateway.
              type: string
            gatewayType:
              description: |
                The gateway type.
              type: string
            gatewayVersion:
              description: |
                The gateway version.
              type: string
          type: object
        processId:
          description: >
            The ID of the running process when the exception occurs. This field
            is available only if the `success` field is `false`.
          type: string
        reasons:
          description: >
            The container of the error code and message. This field is available
            only if the `success` field is `false`.
          items:
            properties:
              code:
                description: |
                  Error code.
                type: string
              message:
                description: >
                  Error message. It usually contains a combination of gateway
                  response code and response message.
                type: string
            type: object
          type: array
        requestId:
          description: >
            The ID of the request. This field is available only if the `success`
            field is `false`
          type: string
        resultCode:
          description: >
            The result code of the request. 


            0 indicates that the request succeeded, and the following values
            indicate that the request failed:
              - 1: The request is declined.
              - 7: The field format is not correct.
              - 10: Client connection has timed out.
              - 11: Host connection has timed out.
              - 12: Processor connection has timed out.
              - 13: Gateway server is busy.
              - 20: The card type is not supported.
              - 21: The merchant account information is invalid.
              - 22: A generic error occurred on the processor.
              - 40: The card type has not been set up yet.
              - 41: The limit for a single transaction is exceeded.
              - 42: Address checking failed.
              - 43: Card security code checking failed.
              - 44: Failed due to the gateway security setting.
              - 45: Fraud protection is declined.
              - 46: Address checking or card security code checking failed (for Authorize.net gateway only).
              - 47: The maximum amount is exceeded (for Authorize.net gateway only).
              - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).
              - 49: Card security code checking failed (for Authorize.net gateway only).
              - 60: User authentication failed.
              - 61: The currency code is invalid.
              - 62: The transaction ID is invalid.
              - 63: The credit card number is invalid.
              - 64: The card expiration date is invalid.
              - 65: The transaction is duplicated.
              - 66: Credit transaction error.
              - 67: Void transaction error.
              - 90: A valid amount is required.
              - 91: The BA code is invalid.
              - 92: The account number is invalid.
              - 93: The ACH transaction is not accepted by the merchant.
              - 94: An error occurred for the ACH transaction.
              - 95: The version parameter is invalid.
              - 96: The transaction type is invalid.
              - 97: The transaction method is invalid.
              - 98: The bank account type is invalid.
              - 99: The authorization code is invalid.
              - 200: General transaction error.
              - 500: The transaction is queued for submission.
              - 999: Unknown error.
              - -1: An error occurred in gateway communication.
              - -2: Idempotency is not supported.
              - -3: Inquiry call is not supported.
          type: string
        resultMessage:
          description: The corresponding request ID.
          type: string
        success:
          description: Indicates whether the call succeeded.
          type: boolean
        transactionId:
          description: The ID of the transaction.
          type: string
      type: object
    POSTVoidAuthorize:
      example:
        accountId: 402881e861bd8a7e0161c6a453750026
        gatewayOrderId: A001
        transactionId: '5205213224866613203009'
      properties:
        accountId:
          description: The ID of the customer account.
          type: string
        accountNumber:
          description: The number of the customer account.
          type: string
        gatewayOptions:
          description: >
            The field used to pass gateway-specific parameters and parameter
            values. The fields supported by gateways vary. For more information,
            see the Overview topic of each gateway integration in [Zuora
            Knowledge
            Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


            Zuora sends all the information that you specified to the gateway.
            If you specify any unsupported gateway option parameters, they will
            be ignored without error prompts.
          properties:
            key:
              description: |
                The name of a gateway-specific parameter.
              type: string
            value:
              description: |
                The value of the gateway-specific parameter.
              type: string
          type: object
        gatewayOrderId:
          description: >
            The order ID for the specific gateway.


            The specified order ID will be used in transaction authorization. If
            you specify an empty value for this field, Zuora will generate an ID
            and you will have to associate this ID with your order ID by
            yourself if needed. It is recommended to specify an ID for this
            field.
          type: string
        paymentGatewayId:
          description: |
            The ID of the payment gateway instance. 
              - If this field is specified and it is a Worldline Global Collect gateway, the specified gateway is used.
              - If this field is not specified or is not a Worldline Global Collect gateway, the cancellation operation uses the payment gateway originally used for the authorization.
          type: string
          nullable: true
        transactionId:
          description: The ID of the transaction.
          type: string
      required:
        - transactionId
        - gatewayOrderId
      type: object
    POSTVoidAuthorizeResponse:
      example:
        gatewayOrderId: A001
        resultCode: 0
        resultMessage: 'Request ID: 5231719060426316203012'
        success: true
        transactionId: '5231719060426316203012'
      properties:
        gatewayOrderId:
          description: >
            The order ID for the specific gateway.


            The specified order ID will be used in transaction authorization. If
            you specify an empty value for this field, Zuora will generate an ID
            and you will have to associate this ID with your order ID by
            yourself if needed. It is recommended to specify an ID for this
            field.
          type: string
        resultCode:
          description: >
            The result code of the request. 


            0 indicates that the request succeeded, and the following values
            indicate that the request failed:
              - 1: The request is declined.
              - 7: The field format is not correct.
              - 10: Client connection has timed out.
              - 11: Host connection has timed out.
              - 12: Processor connection has timed out.
              - 13: Gateway server is busy.
              - 20: The card type is not supported.
              - 21: The merchant account information is invalid.
              - 22: A generic error occurred on the processor.
              - 40: The card type has not been set up yet.
              - 41: The limit for a single transaction is exceeded.
              - 42: Address checking failed.
              - 43: Card security code checking failed.
              - 44: Failed due to the gateway security setting.
              - 45: Fraud protection is declined.
              - 46: Address checking or card security code checking failed (for Authorize.net gateway only).
              - 47: The maximum amount is exceeded (for Authorize.net gateway only).
              - 48: The IP address is blocked by the gateway (for Authorize.net gateway only).
              - 49: Card security code checking failed (for Authorize.net gateway only).
              - 60: User authentication failed.
              - 61: The currency code is invalid.
              - 62: The transaction ID is invalid.
              - 63: The credit card number is invalid.
              - 64: The card expiration date is invalid.
              - 65: The transaction is duplicated.
              - 66: Credit transaction error.
              - 67: Void transaction error.
              - 90: A valid amount is required.
              - 91: The BA code is invalid.
              - 92: The account number is invalid.
              - 93: The ACH transaction is not accepted by the merchant.
              - 94: An error occurred for the ACH transaction.
              - 95: The version parameter is invalid.
              - 96: The transaction type is invalid.
              - 97: The transaction method is invalid.
              - 98: The bank account type is invalid.
              - 99: The authorization code is invalid.
              - 200: General transaction error.
              - 500: The transaction is queued for submission.
              - 999: Unknown error.
              - -1: An error occurred in gateway communication.
              - -2: Idempotency is not supported.
              - -3: Inquiry call is not supported.
          type: string
        resultMessage:
          description: The corresponding request ID.
          type: string
        success:
          description: Indicates whether the call succeeded.
          type: boolean
        transactionId:
          description: The ID of the transaction.
          type: string
      type: object
    GETAPaymentGatwayResponse:
      properties:
        id:
          description: The ID of the payment gateway.
          type: string
        isActive:
          description: Specifies if this payment gateway is in active status.
          type: boolean
        isDefault:
          description: >-
            Specifies if this is the default payment gateway to process payments
            for your customer accounts.
          type: boolean
        name:
          description: The name of the payment gateway.
          type: string
        type:
          description: The type of the payment gateway
          type: string
      title: paymentgateways
      type: object
    GETPaymentGatwaysResponse:
      properties:
        paymentgateways:
          description: ''
          items:
            $ref: '#/components/schemas/GETAPaymentGatwayResponse'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    PostTriggerPreDebitNotificationRequest:
      example:
        invoiceKey: c2289d0a8d3af0f2018d3b2b1fd00000
        paymentGatewayId: 80289d0a8d3af0f2018d3b1b8b800000
        paymentMethodId: 40289d0a8d3af0f2018d3b2b1fd00000
      properties:
        invoiceKey:
          type: string
          description: |
            The unique identifier for an invoice. It can be either a UUID  
            such as `2c92c8955bd63cc1015bd7c151af0000`, or an invoice number  
            such as `INV-0000001`.
        paymentGatewayId:
          type: string
          description: >
            The ID of the payment gateway used to process the payment, such as
            `8ad08aef83d0c3000183d4b5a2d51933`.


            If it is not provided, the ID of the default payment gateway is
            used.
        paymentMethodId:
          type: string
          description: >
            The ID of the payment method used for the payment, such as
            `4ad08aef83d0c30102183d4b5a2d51733`.


            If it is not provided, the ID of the default payment method is used.
      required:
        - invoiceKey
      type: object
    PostTriggerPreDebitNotificationResponse:
      example:
        success: true
        invoiceId: c2289d0a8d3af0f2018d3b2b1fd00000
        paymentMethodId: 40289d0a8d3af0f2018d3b2b1fd00000
        gatewayId: 80289d0a8d3af0f2018d3b1b8b800000
        gatewayType: Adyen
        gatewayVersion: '2'
        notificationReferenceId: 40289d0a8d3af0f2018d3b2b1fd00000
        secondNotificationReferenceId: null
        thirdNotificationReferenceId: null
        extraParameters: null
      properties:
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
        invoiceId:
          description: >
            The ID of the invoice, for which the pre-debit notification is
            triggered.
          type: string
        paymentMethodId:
          description: |
            The ID of the associated payment method.
          type: string
        gatewayId:
          description: |
            The ID of the associated payment gateway.
          type: string
        gatewayType:
          description: |
            The gateway type used in this operation.
          type: string
        gatewayVersion:
          description: |
            The version number of the gateway used.
          type: string
        notificationReferenceId:
          description: >
            The value of the `shopperNotificationReference` field returned from
            the gateway.
          type: string
        secondNotificationReferenceId:
          description: |
            The additional second reference ID returned from the gateway.
          type: string
          nullable: true
        thirdNotificationReferenceId:
          description: |
            The additional third reference ID returned from the gateway.
          type: string
          nullable: true
        extraParameters:
          description: |
            The extra optional parameter returned from the gateway.
          type: string
          nullable: true
      type: object
    POSTReversePaymentRequest:
      example:
        amount: 10
      properties:
        amount:
          description: >
            The amount that needs to be reversed (chargeback). It cannot be
            greater than the total Payment amount. 
          type: number
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: >
            The transaction response returned by the gateway for this
            transaction. If the transaction was declined, this reason is
            provided in the message.
          type: string
        gatewayResponseCode:
          description: >
            Response message Code returned by the gateway about the transaction
            status.
          type: string
        payoutId:
          description: |
            The payout ID from the gateway side.
          type: string
        referenceId:
          description: >
            Unique Id generated by the gateway for each transaction. Use this ID
            to find the respective Zuora Payment ID. 
          maxLength: 100
          type: string
        secondReferenceId:
          description: >
            The second reference Id. Some gateways use two unique transaction
            IDs.
          maxLength: 100
          type: string
        settledOn:
          description: >
            The date and time of the transaction settlement. The format is
            `yyyy-mm-dd hh:mm:ss`.
          format: date-time
          type: string
      required:
        - amount
      type: object
    POSTReversePaymentResponse:
      properties:
        accountId:
          description: |
            The ID of the customer account that the payment is for.
          type: string
        amount:
          description: |
            The total amount of the payment.
          format: double
          type: number
        cancelledOn:
          description: >
            The date and time when the payment was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        comment:
          description: |
            Comments about the payment.
          type: string
          nullable: true
        createdById:
          description: |
            The ID of the Zuora user who created the refund.
          type: string
        createdDate:
          description: >
            The date and time when the chargeback is created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2019-03-01 15:31:10.
          format: date-time
          type: string
        creditMemoId:
          description: |
            The ID of the credit memo that is refunded.
          type: string
        financeInformation:
          description: |
            Container for the finance information related to the refund.
          properties:
            bankAccountAccountingCode:
              description: >
                The accounting code that maps to a bank account in your
                accounting system.
              maxLength: 100
              minLength: 0
              type: string
            bankAccountAccountingCodeType:
              description: >
                The type of the accounting code that maps to a bank account in
                your accounting system.
                  
              type: string
            transferredToAccounting:
              description: >
                Whether the refund was transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: |
                The accounting code for the unapplied payment.
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              description: |
                The type of the accounting code for the unapplied payment.
                  
              type: string
          type: object
        gatewayId:
          description: |
            The ID of the gateway instance that processes the payment.
          type: string
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: >
            The message returned from the payment gateway for the payment. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: >
            The code returned from the payment gateway for the payment. This
            code is gateway-dependent.
          type: string
        gatewayState:
          description: >
            The status of the payment in the gateway; specifically used for
            reconciliation.
          enum:
            - Submitted
            - NotSubmitted
            - Settled
            - FailedToSettle
          type: string
        id:
          description: |
            The ID of the payment chargeback.
          type: string
        markedForSubmissionOn:
          description: >
            The date and time when a charge was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        methodType:
          description: |
            How an external refund was issued to a customer. 
          enum:
            - ACH
            - Cash
            - Check
            - CreditCard
            - PayPal
            - WireTransfer
            - DebitCard
            - CreditCardReferenceTransaction
            - BankTransfer
            - Other
          type: string
        number:
          description: >
            The unique identification number of the payment. For example,
            P-00000001.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        paymentId:
          description: |
            The ID of the payment that is refunded.
          type: string
        paymentMethodId:
          description: >
            The unique ID of the payment method that the customer used to make
            the payment.
          type: string
        paymentMethodSnapshotId:
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular Payment Method used in a transaction.
          type: string
        payoutId:
          description: |
            The payout ID from the gateway side.
          type: string
        reasonCode:
          description: |
            A code identifying the reason for the transaction.   
          type: string
        referenceId:
          description: >
            The transaction ID returned by the payment gateway for an electronic
            refund. Use this field to reconcile refunds between your gateway and
            Zuora Payments.
          type: string
        refundDate:
          description: >
            The date when the refund takes effect, in `yyyy-mm-dd` format. For
            example, 2017-03-01.
          format: date
          type: string
        refundTransactionTime:
          description: >
            The date and time when the refund was issued, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        secondRefundReferenceId:
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional refund. 
          type: string
        settledOn:
          description: >
            The date and time when the transaction is settled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        softDescriptor:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        softDescriptorPhone:
          description: >
            A payment gateway-specific field that maps Zuora to other
            gateways.          
          type: string
        status:
          description: |
            The status of the payment.
          type: string
        submittedOn:
          description: >
            The date and time when the payment was submitted, in yyyy-mm-dd
            hh:mm:ss format.
          format: date-time
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        type:
          description: |
            The type of the payment.
          enum:
            - External
            - Electronic
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment.
          type: string
        updatedDate:
          description: >
            The date and time when the payment was last updated, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2019-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    POSTRejectPaymentRequest:
      example:
        gatewayReconciliationReason: insufficient_funds
      properties:
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: >
            The transaction response returned by the gateway for this
            transaction. If the transaction was declined, this reason is
            provided in the message.
          type: string
        gatewayResponseCode:
          description: >
            Response message Code returned by the gateway about the transaction
            status.
          type: string
        referenceId:
          description: >
            Unique Id generated by the gateway for each transaction. Use this ID
            to find the respective Zuora Payment ID. 
          maxLength: 100
          type: string
        secondReferenceId:
          description: >
            The second reference Id. Some gateway uses two unique transaction
            IDs.
          maxLength: 100
          type: string
        settledOn:
          description: >
            The date and time of the transaction settlement. The format is
            `yyyy-mm-dd hh:mm:ss`.
          format: date-time
          type: string
      type: object
    POSTRejectPaymentResponse:
      properties:
        accountId:
          description: |
            The ID of the customer account that the payment is for.
          type: string
        amount:
          description: |
            The total amount of the payment.
          format: double
          type: number
        cancelledOn:
          description: >
            The date and time when the payment was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        comment:
          description: |
            Comments about the payment.
          type: string
          nullable: true
        createdById:
          description: |
            The ID of the Zuora user who created the refund.
          type: string
        createdDate:
          description: >
            The date and time when the chargeback is created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2019-03-01 15:31:10.
          format: date-time
          type: string
        creditMemoId:
          description: |
            The ID of the credit memo that is refunded.
          type: string
        financeInformation:
          description: |
            Container for the finance information related to the refund.
          properties:
            bankAccountAccountingCode:
              description: >
                The accounting code that maps to a bank account in your
                accounting system.
              maxLength: 100
              minLength: 0
              type: string
            bankAccountAccountingCodeType:
              description: >
                The type of the accounting code that maps to a bank account in
                your accounting system.
                  
              type: string
            transferredToAccounting:
              description: >
                Whether the refund was transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: |
                The accounting code for the unapplied payment.
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              description: |
                The type of the accounting code for the unapplied payment.
                  
              type: string
          type: object
        gatewayId:
          description: |
            The ID of the gateway instance that processes the payment.
          type: string
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: >
            The message returned from the payment gateway for the payment. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: >
            The code returned from the payment gateway for the payment. This
            code is gateway-dependent.
          type: string
        gatewayState:
          description: >
            The status of the payment in the gateway; specifically used for
            reconciliation.
          enum:
            - Submitted
            - NotSubmitted
            - Settled
            - FailedToSettle
          type: string
        id:
          description: |
            The ID of the payment chargeback.
          type: string
        markedForSubmissionOn:
          description: >
            The date and time when a charge was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        methodType:
          description: |
            How an external refund was issued to a customer. 
          enum:
            - ACH
            - Cash
            - Check
            - CreditCard
            - PayPal
            - WireTransfer
            - DebitCard
            - CreditCardReferenceTransaction
            - BankTransfer
            - Other
          type: string
        number:
          description: >
            The unique identification number of the payment. For example,
            P-00000001.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        paymentId:
          description: |
            The ID of the payment that is refunded.
          type: string
        paymentMethodId:
          description: >
            The unique ID of the payment method that the customer used to make
            the payment.
          type: string
        paymentMethodSnapshotId:
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular Payment Method used in a transaction.
          type: string
        payoutId:
          description: |
            The payout ID from the gateway side.
          type: string
        reasonCode:
          description: |
            A code identifying the reason for the transaction.      
          type: string
        referenceId:
          description: >
            The transaction ID returned by the payment gateway for an electronic
            refund. Use this field to reconcile refunds between your gateway and
            Zuora Payments.
          type: string
        refundDate:
          description: >
            The date when the refund takes effect, in `yyyy-mm-dd` format. For
            example, 2017-03-01.       
          format: date
          type: string
        refundTransactionTime:
          description: >
            The date and time when the refund was issued, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        secondRefundReferenceId:
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional refund. 
          type: string
        settledOn:
          description: >
            The date and time when the transaction is settled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        softDescriptor:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        softDescriptorPhone:
          description: >
            A payment gateway-specific field that maps Zuora to other
            gateways.          
          type: string
        status:
          description: |
            The status of the payment.
          type: string
        submittedOn:
          description: >
            The date and time when the payment was submitted, in yyyy-mm-dd
            hh:mm:ss format.
          format: date-time
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        type:
          description: |
            The type of the payment.
          enum:
            - External
            - Electronic
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment.
          type: string
        updatedDate:
          description: >
            The date and time when the payment was last updated, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2019-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    POSTSettlePaymentRequest:
      example:
        gatewayReconciliationReason: paid
      properties:
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        payoutId:
          description: |
            The payout ID from the gateway side.
          type: string
        settledOn:
          description: >
            The date and time of the transaction settlement. The format is
            `yyyy-mm-dd hh:mm:ss`.
          format: date-time
          type: string
      type: object
    POSTSettlePaymentResponse:
      properties:
        accountId:
          description: |
            The ID of the customer account that the payment is for.
          type: string
        accountNumber:
          description: |
            The number of the customer account that the payment is for.
          type: string
        amount:
          description: |
            The total amount of the payment.
          format: double
          type: number
        appliedAmount:
          description: |
            The applied amount of the payment.
          format: double
          type: number
        authTransactionId:
          description: |
            The authorization transaction ID from the payment gateway.
          type: string
        bankIdentificationNumber:
          description: >
            The first six or eight digits of the credit card or debit card used
            for the payment, when applicable.
          type: string
        cancelledOn:
          description: >
            The date and time when the payment was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        comment:
          description: |
            Comments about the payment.
          type: string
          nullable: true
        createdById:
          description: |
            The ID of the Zuora user who created the refund.
          type: string
        createdDate:
          description: >
            The date and time when the chargeback is created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2019-03-01 15:31:10.
          format: date-time
          type: string
        creditBalanceAmount:
          description: >
            The amount that the payment transfers to the credit balance. The
            value is not `0` only for those payments that come from legacy
            payment operations performed without the Invoice Settlement feature.
          format: double
          type: number
        currency:
          description: |
            A currency defined in the web-based UI administrative settings.
          type: string
        effectiveDate:
          description: >
            The date and time when the payment takes effect, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        paymentGatewayNumber:
          description: |
            The number of the payment gateway instance.
          type: string
          nullable: true
        financeInformation:
          description: |
            Container for the finance information related to the refund.
          properties:
            bankAccountAccountingCode:
              description: >
                The accounting code that maps to a bank account in your
                accounting system.
              maxLength: 100
              minLength: 0
              type: string
              nullable: true
            bankAccountAccountingCodeType:
              description: >
                The type of the accounting code that maps to a bank account in
                your accounting system.
                  
              type: string
              nullable: true
            transferredToAccounting:
              description: >
                Whether the refund was transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: |
                The accounting code for the unapplied payment.
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              description: |
                The type of the accounting code for the unapplied payment.
                  
              type: string
          type: object
        gatewayId:
          description: |
            The ID of the gateway instance that processes the payment.
          type: string
        gatewayOrderId:
          description: >
            A merchant-specified natural key value that can be passed to the
            electronic payment gateway when a payment is created. If not
            specified, the payment number will be passed in instead.
          type: string
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
          nullable: true
        gatewayResponse:
          description: >
            The message returned from the payment gateway for the payment. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: >
            The code returned from the payment gateway for the payment. This
            code is gateway-dependent.
          type: string
        gatewayState:
          description: >
            The status of the payment in the gateway; specifically used for
            reconciliation.
          enum:
            - Submitted
            - NotSubmitted
            - Settled
            - FailedToSettle
          type: string
        id:
          description: |
            The ID of the payment chargeback.
          type: string
        markedForSubmissionOn:
          description: >
            The date and time when a charge was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        number:
          description: >
            The unique identification number of the payment. For example,
            P-00000001.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        paymentMethodId:
          description: >
            The unique ID of the payment method that the customer used to make
            the payment.
          type: string
        paymentMethodSnapshotId:
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular Payment Method used in a transaction.
          type: string
        payoutId:
          description: |
            The payout ID from the gateway side.
          type: string
          nullable: true
        referenceId:
          description: >
            The transaction ID returned by the payment gateway for an electronic
            refund. Use this field to reconcile refunds between your gateway and
            Zuora Payments.
          type: string
        refundAmount:
          description: |
            The amount of the payment that is refunded.
          format: double
          type: number
        secondPaymentReferenceId:
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional transaction for the payment. 
          type: string
          nullable: true
        settledOn:
          description: >
            The date and time when the transaction is settled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        softDescriptor:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        softDescriptorPhone:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        status:
          description: |
            The status of the payment.
          type: string
        submittedOn:
          description: >
            The date and time when the payment was submitted, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        success:
          description: |
            Indicates if the request is processed successfully.
          type: boolean
        type:
          description: |
            The type of the payment.
          enum:
            - External
            - Electronic
          type: string
        unappliedAmount:
          description: |
            The unapplied amount of the payment.
          format: double
          type: number
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment.
          type: string
        updatedDate:
          description: >
            The date and time when the payment was last updated, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2019-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    POSTReconcileRefundRequest:
      example:
        action: settle
        gatewayReconciliationStatus: paid
      properties:
        action:
          description: |
            The action of the refund reconciliation.
              - `settle`: Sets Gateway State to "Settled" and returns the refund object as response.
              - `reject`: Sets Gateway State to "FailedToSettle" and handle the event according to the settings configured in the Gateway Reconciliation Configuration in Payments Settings through Zuora UI. See [Configure how to handle refund rejected events](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Gateway_Reconciliation#Configure_how_to_handle_refund_rejected_events) for details.
          enum:
            - settle
            - reject
          type: string
        actionDate:
          description: >
            The date and time of the refund reconciliation action, in
            `yyyy-mm-dd hh:mm:ss` format.
          format: datetime
          type: string
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        payoutId:
          description: |
            The payout ID of the refund from the gateway side.
          type: string
      type: object
    POSTReconcileRefundResponse:
      example:
        id: 8ad083f092d66ff90192dc309ec31b7e
        number: R-00000025
        status: Processed
        type: Electronic
        methodType: CreditCard
        accountId: 8ad09bce83f1da020183f97e245c1c47
        amount: 55
        refundDate: '2024-10-30'
        comment: null
        paymentMethodId: null
        paymentMethodSnapshotId: 8ad083f092d66ff90192dc309e941b7d
        paymentId: 8ad097b48f0b078f018f0df4a6cf2ff4
        paymentNumber: P-00001536
        creditMemoId: null
        reasonCode: Other
        gatewayId: 8ad095dd813e750f0181461a8e350ce7
        paymentGatewayNumber: null
        gatewayResponse: This transaction has been approved by the gateway.
        gatewayResponseCode: approve
        gatewayState: Settled
        markedForSubmissionOn: null
        referenceId: 5066779.708498786
        secondRefundReferenceId: null
        softDescriptor: null
        softDescriptorPhone: null
        submittedOn: '2024-10-30 14:50:27'
        settledOn: '2024-11-13 16:07:24'
        cancelledOn: null
        createdDate: '2024-10-30 14:50:26'
        createdById: 8ad084a67f9c7138017fab8a8b511b5a
        updatedDate: '2024-11-13 16:07:24'
        updatedById: 8ad084a67f9c7138017fab8a8b511b5a
        refundTransactionTime: '2024-10-30 14:50:27'
        financeInformation:
          bankAccountAccountingCode: null
          bankAccountAccountingCodeType: null
          unappliedPaymentAccountingCode: Accounts Receivable
          unappliedPaymentAccountingCodeType: AccountsReceivable
          transferredToAccounting: 'No'
        gatewayReconciliationStatus: paid
        gatewayReconciliationReason: null
        payoutId: null
        success: true
      properties:
        accountId:
          description: |
            The ID of the customer account that the refund is for.
          type: string
        amount:
          description: |
            The total amount of the refund.
          format: double
          type: number
        cancelledOn:
          description: >
            The date and time when the transaction was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        comment:
          description: |
            Comments about the refund.
          type: string
        createdById:
          description: |
            The ID of the Zuora user who created the refund.
          type: string
        createdDate:
          description: >
            The date and time when the refund is created, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        creditMemoId:
          description: |
            The ID of the credit memo that is refunded.
          type: string
        financeInformation:
          description: |
            Container for the finance information related to the refund.
          properties:
            bankAccountAccountingCode:
              description: >
                The accounting code that maps to a bank account in your
                accounting system.
              maxLength: 100
              minLength: 0
              type: string
            bankAccountAccountingCodeType:
              description: >
                The type of the accounting code that maps to a bank account in
                your accounting system.
                  
              type: string
            transferredToAccounting:
              description: >
                Whether the refund was transferred to an external accounting
                system. Use this field for integration with accounting systems,
                such as NetSuite. 
              enum:
                - Processing
                - 'Yes'
                - 'No'
                - Error
                - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: |
                The accounting code for the unapplied payment.
              maxLength: 100
              minLength: 0
              type: string
            unappliedPaymentAccountingCodeType:
              description: |
                The type of the accounting code for the unapplied payment.
                  
              type: string
          type: object
        gatewayId:
          description: |
            The ID of the gateway instance that processes the refund.
          type: string
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: >
            The message returned from the payment gateway for the refund. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: >
            The code returned from the payment gateway for the refund. This code
            is gateway-dependent.
          type: string
        gatewayState:
          description: >
            The status of the refund in the gateway; specifically used for
            reconciliation.
          enum:
            - Settled
            - FailedToSettle
          type: string
        id:
          description: |
            The ID of the refund.
          type: string
        markedForSubmissionOn:
          description: >
            The date and time when a refund was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        methodType:
          description: |
            How an external refund was issued to a customer. 
          enum:
            - ACH
            - Cash
            - Check
            - CreditCard
            - PayPal
            - WireTransfer
            - DebitCard
            - CreditCardReferenceTransaction
            - BankTransfer
            - Other
          type: string
        number:
          description: >
            The unique identification number of the refund. For example,
            R-00000001.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        paymentId:
          description: |
            The ID of the payment that is refunded.
          type: string
        paymentMethodId:
          description: >
            The unique ID of the payment method that the customer used to make
            the refund.
          type: string
        paymentMethodSnapshotId:
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular Payment Method used in a transaction.
          type: string
        payoutId:
          description: |
            The payout ID of the refund from the gateway side.
          type: string
        reasonCode:
          description: |
            A code identifying the reason for the transaction.      
          type: string
        referenceId:
          description: >
            The transaction ID returned by the payment gateway for an electronic
            refund. Use this field to reconcile refunds between your gateway and
            Zuora Payments.
          type: string
        refundDate:
          description: >
            The date when the refund takes effect, in `yyyy-mm-dd` format. For
            example, 2020-03-01.       
          format: date
          type: string
        refundTransactionTime:
          description: >
            The date and time when the refund was issued, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        secondRefundReferenceId:
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional refund. 
          type: string
        settledOn:
          description: >
            The date and time when the transaction is settled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        softDescriptor:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        softDescriptorPhone:
          description: >
            A payment gateway-specific field that maps Zuora to other
            gateways.          
          type: string
        status:
          description: |
            The status of the refund.
          type: string
        submittedOn:
          description: >
            The date and time when the refund was submitted, in yyyy-mm-dd
            hh:mm:ss format.
          format: date-time
          type: string
        success:
          description: |
            Indicates if the request is processed successfully.
          type: boolean
        type:
          description: |
            The type of the refund.
          enum:
            - External
            - Electronic
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the refund.
          type: string
        updatedDate:
          description: >
            The date and time when the refund was last updated, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
      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
    PaymentObjectNSFields:
      description: >
        Container for Payment fields provided by the [Zuora Connector for
        NetSuite](https://www.zuora.com/connect/app/?appId=265).
      properties:
        IntegrationId__NS:
          description: >
            ID of the corresponding object in NetSuite. Only available if you
            have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        IntegrationStatus__NS:
          description: >
            Status of the payment's synchronization with NetSuite. Only
            available if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Origin__NS:
          description: >
            Origin of the corresponding object in NetSuite. Only available if
            you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        SyncDate__NS:
          description: >
            Date when the payment was synchronized with NetSuite. Only available
            if you have installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
        Transaction__NS:
          description: >
            Related transaction in NetSuite. Only available if you have
            installed the [Zuora Connector for
            NetSuite](https://www.zuora.com/connect/app/?appId=265).
          maxLength: 255
          type: string
      title: paymentFieldsNS
      type: object
    PaymentObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Payment object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Payment object.
      title: paymentFieldsCustom
      type: object
    GETARPaymentTypewithSuccess:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account that the payment is for.
              type: string
            accountNumber:
              description: |
                The number of the customer account that the payment is for.
              type: string
            amount:
              description: |
                The total amount of the payment.
              format: double
              type: number
            appliedAmount:
              description: |
                The applied amount of the payment.
              format: double
              type: number
            authTransactionId:
              description: |
                The authorization transaction ID from the payment gateway.
              type: string
              nullable: true
            bankIdentificationNumber:
              description: >
                The first six or eight digits of the credit card or debit card
                used for the payment, when applicable.
              type: string
              nullable: true
            cancelledOn:
              description: >
                The date and time when the payment was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the payment.
              type: string
            createdById:
              description: |
                The ID of the Zuora user who created the payment part.
              type: string
            createdDate:
              description: >
                The date and time when the payment was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditBalanceAmount:
              description: >
                The amount that the payment transfers to the credit balance. The
                value is not `0` only for those payments that come from legacy
                payment operations performed without the Invoice Settlement
                feature.
              format: double
              type: number
            currency:
              description: >
                When Standalone Payment is not enabled, the `currency` of the
                payment must be the same as the payment currency defined in the
                customer account settings through Zuora UI.


                When Standalone Payment is enabled and `standalone` is `true`,
                the `currency` of the standalone payment can be different from
                the payment currency defined in the customer account settings.
                The amount will not be summed up to the account balance or key
                metrics regardless of currency.
              type: string
            effectiveDate:
              description: >
                The date and time when the payment takes effect, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the payment.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                  nullable: true
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                  nullable: true
                transferredToAccounting:
                  description: >
                    Whether the payment was transferred to an external
                    accounting system. Use this field for integration with
                    accounting systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                  nullable: true
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                  nullable: true
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
                  nullable: true
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the payment.
              type: string
              nullable: true
            gatewayOrderId:
              description: >
                A merchant-specified natural key value that can be passed to the
                electronic payment gateway when a payment is created.
              type: string
              nullable: true
            gatewayReconciliationReason:
              description: |
                The reason of gateway reconciliation.
              type: string
              nullable: true
            gatewayReconciliationStatus:
              description: |
                The status of gateway reconciliation.
              type: string
              nullable: true
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the payment.
                This message is gateway-dependent.
              type: string
              nullable: true
            gatewayResponseCode:
              description: >
                The code returned from the payment gateway for the payment. This
                code is gateway-dependent.
              type: string
              nullable: true
            gatewayState:
              description: >
                The status of the payment in the gateway; use for
                reconciliation. 
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: >
                The unique ID of the payment. For example,
                4028905f5a87c0ff015a87eb6b75007f.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a payment was marked and waiting for
                batch submission to the payment process, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            number:
              description: >
                The unique identification number of the payment. For example,
                P-00000001.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentGatewayNumber:
              description: |
                The natural key for the payment gateway.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the payment.
              type: string
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot which is a copy of
                the particular Payment Method used in a transaction.
              type: string
              nullable: true
            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: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleKey:
              description: >-
                The unique ID or the number of the payment schedule that is
                linked to the payment. See [Link payments to payment
                schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules)
                for more information.
              type: string
            payoutId:
              description: |
                The payout ID of the payment from the gateway side.
              type: string
              nullable: true
            prepayment:
              description: >
                Indicates whether the payment is used as a reserved payment. 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
            referenceId:
              description: >
                The transaction ID returned by the payment gateway. Use this
                field to reconcile payments between your gateway and Zuora
                Payments.
              type: string
              nullable: true
            refundAmount:
              description: |
                The amount of the payment that is refunded.
              format: double
              type: number
            secondPaymentReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the payment. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
              nullable: true
            settledOn:
              description: >
                The date and time when the payment was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
              nullable: true
            softDescriptor:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            standalone:
              default: false
              description: >
                This field is only available if the support for standalone
                payment is enabled.


                The value `true` indicates this is a standalone payment that is
                created and processed in Zuora through Zuora gateway integration
                but will be settled outside of Zuora. No settlement data will be
                created. The standalone payment cannot be applied, unapplied, or
                transferred.


                The value `false` indicates this is an ordinary payment that is
                created, processed, and settled in Zuora.
              type: boolean
            status:
              description: |
                The status of the payment.
              enum:
                - Draft
                - Processing
                - Processed
                - Error
                - Canceled
                - Posted
              type: string
            submittedOn:
              description: >
                The date and time when the payment was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            type:
              description: |
                The type of the payment.
              enum:
                - External
                - Electronic
              type: string
            unappliedAmount:
              description: |
                The unapplied amount of the payment.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the payment.
              type: string
            updatedDate:
              description: >
                The date and time when the payment was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentObjectNSFields'
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
      title: payments
    PaymentCollectionResponseType:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        payments:
          description: |
            Container for payments.
          items:
            $ref: '#/components/schemas/GETARPaymentTypewithSuccess'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    PaymentWithCustomRatesType:
      allOf:
        - properties:
            currency:
              description: >
                The currency code for either Reporting or Home currency.


                **Note**: This field is only available if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              type: string
            customFxRate:
              description: >
                The Custom FX conversion rate between Home/Reporting and
                Transactional currency items.


                **Note**: This field is only available if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: decimal
              type: number
            rateDate:
              description: >
                The date on which a particular currency rate is fixed or
                obtained on.


                **Note**: This field is only available if you are on the latest
                Zuora API minor version, or you set the `Zuora-Version` request
                header to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              format: date
              type: string
          required:
            - currency
            - customFxRate
          type: object
      title: customRates
    PaymentDebitMemoApplicationItemCreateRequestType:
      properties:
        amount:
          description: >
            The amount of the payment associated with the specific debit memo or
            taxation item.
          format: double
          type: number
        debitMemoItemId:
          description: |
            The ID of the specific debit memo item.
          type: string
        taxItemId:
          description: |
            The ID of the specific taxation item.
          type: string
      required:
        - amount
      title: items
      type: object
    PaymentDebitMemoApplicationCreateRequestType:
      properties:
        amount:
          description: |
            The amount of the payment associated with the debit memo.
          format: double
          type: number
        debitMemoId:
          description: |
            The unique ID of the debit memo that the payment is created on.

            **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter stage. To gain access to this capability, please create a Zuora support ticket. 
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        items:
          description: >
            Container for debit memo items. The maximum number of items is
            1,000.


            **Note:** This field is only available if you have the [Invoice Item
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
            feature enabled. Invoice Item Settlement must be used together with
            other Invoice Settlement features (Unapplied Payments, and Credit
            and Debit memos).  If you wish to enable Invoice Settlement, see
            [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: >-
              #/components/schemas/PaymentDebitMemoApplicationItemCreateRequestType
          type: array
      title: debitMemos
      type: object
    PaymentInvoiceApplicationItemCreateRequestType:
      properties:
        amount:
          description: >
            The amount of the payment associated with the specific invoice or
            taxation item.
          format: double
          type: number
        invoiceItemId:
          description: |
            The ID of the specific invoice item.
          type: string
        taxItemId:
          description: |
            The ID of the specific taxation item.
          type: string
      required:
        - amount
      title: items
      type: object
    PaymentInvoiceApplicationCreateRequestType:
      properties:
        amount:
          description: >
            The amount of the payment associated with the invoice. This amount
            must be equal to or lesser than the balance of the invoice.
          format: double
          type: number
        invoiceId:
          description: >
            The unique ID of the invoice that the payment is created on. The
            balance of the invoice specified must not be `0`.

             **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter stage. To gain access to this capability, please create a Zuora support ticket. 
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        items:
          description: >
            Container for invoice items. The maximum number of items is 1,000.


            **Note:** This field is only available if you have the [Invoice Item
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
            feature enabled. Invoice Item Settlement must be used together with
            other Invoice Settlement features (Unapplied Payments, and Credit
            and Debit memos).  If you wish to enable Invoice Settlement, see
            [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: >-
              #/components/schemas/PaymentInvoiceApplicationItemCreateRequestType
          type: array
      title: invoices
      type: object
    CreatePaymentType:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account that the payment is created for.
              type: string
            accountNumber:
              description: >
                The number of the customer account that the payment is created
                for, such as `A00000001`.


                You can specify either `accountNumber` or `accountId` for a
                customer account. If both of them are specified, they must refer
                to the same customer account.
              type: string
            amount:
              description: |
                The total amount of the payment.
              format: double
              type: number
            authTransactionId:
              description: >
                The authorization transaction ID from the payment gateway. Use
                this field for electronic payments, such as credit cards.


                When you create a payment for capturing the authorized funds, it
                is highly recommended to pass in the gatewayOrderId that you
                used when authorizing the funds by using the [Create
                authorization](https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization)
                operation, together with the `authTransactionId` field.


                The following payment gateways support this field:
                  - Adyen Integration v2.0
                  - CyberSource 1.28
                  - CyberSource 1.97
                  - CyberSource 2.0
                  - Chase Paymentech Orbital
                  - Ingenico ePayments
                  - SlimPay
                  - Stripe v2
                  - Verifi Global Payment Gateway
                  - WePay Payment Gateway Integration
              maxLength: 50
              type: string
            comment:
              description: |
                Additional information related to the payment.
              maxLength: 255
              minLength: 0
              type: string
            currency:
              description: >
                When Standalone Payment is not enabled, the `currency` of the
                payment must be the same as the payment currency defined in the
                customer account settings through Zuora UI. But if you have the
                [Multiple
                Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies)
                feature enabled, you can have a different payment currency.


                When Standalone Payment is enabled and `standalone` is `true`,
                the `currency` of the standalone payment can be different from
                the payment currency defined in the customer account settings.
                The amount will not be summed up to the account balance or key
                metrics regardless of currency.
              type: string
            customRates:
              description: >
                It contains Home currency and Reporting currency custom rates
                currencies. The maximum number of items is 2 (you can pass the
                Home currency item or Reporting currency item or both).


                **Note**:
                  
                - This field is only available if you are on the latest Zuora
                API minor version, or you set the `Zuora-Version` request header
                to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).

                - You cannot set the custom rates, if both the **Automatically
                include additional Currency Conversion information in data
                source exports** option and **Fx data** feature are enabled.

                - Payment, PaymentApplication, and PaymentApplicationItem will
                utilize the provided custom Fx rate to convert amounts from the
                transactional currency to the home currency.
              items:
                $ref: '#/components/schemas/PaymentWithCustomRatesType'
              maxItems: 2
              type: array
            debitMemos:
              description: >
                Container for debit memos. The maximum number of debit memos is
                1,000.
              items:
                $ref: >-
                  #/components/schemas/PaymentDebitMemoApplicationCreateRequestType
              type: array
            effectiveDate:
              description: |
                The date when the payment takes effect, in `yyyy-mm-dd` format.

                **Note:**
                  - This field is required for only electronic payments. It's an optional field for external payments.
                  - When specified, this field must be set to the date of today.
                  - When applying or transferring payments, this field must be later than or equal to the maximum effective date of the payment.
              format: date
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the payment.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the payment was transferred to an external
                    accounting system. Use this field for integration with
                    accounting systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            gatewayId:
              description: >
                The ID of the gateway instance that processes the payment. The
                ID must be a valid gateway instance ID and this gateway must
                support the specific payment method.


                - If <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
                target="_blank">Payment Gateway Routing</a> is enabled, when
                creating electronic payments, this field is optional. 
                    - If this field is not specified, gateway routing rules will be invoked.
                    - If this field is specified, the specified gateway will be used to process the payment.

                - If Payment Gateway Routing is disabled, when creating
                electronic payments, this field is required.


                - When creating external payments, this field is optional.


                Use the same gateway instance if both `paymentGatewayNumber` and

                `gatewayId` are sent in the request.
              type: string
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values. The fields supported by gateways vary. For more
                information, see the Overview topic of each gateway integration
                in [Zuora Knowledge
                Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


                Zuora sends all the information that you specified to the
                gateway. If you specify any unsupported gateway option
                parameters, they will be ignored without error prompts.
              properties:
                key:
                  description: |
                    The name of a gateway-specific parameter.
                  maxLength: 255
                  type: string
                value:
                  description: |
                    The value of the gateway-specific parameter.
                  maxLength: 255
                  type: string
              type: object
            gatewayOrderId:
              description: >
                A merchant-specified natural key value that can be passed to the
                electronic payment gateway when a payment is created. If not
                specified, the payment number will be passed in instead.


                Gateways check duplicates on the gateway order ID to ensure that
                the merchant do not accidentally enter the same transaction
                twice. This ID can also be used to do reconciliation and tie the
                payment to a natural key in external systems. The source of this
                ID varies by merchant. Some merchants use their shopping cart
                order IDs, and others use something different. Merchants use
                this ID to track transactions in their eCommerce systems.


                When you create a payment for capturing the authorized funds, it
                is highly recommended to pass in the gatewayOrderId that you
                used when authorizing the funds by using the [Create
                authorization](https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization)
                operation, together with the `authTransactionId` field.
              maxLength: 50
              type: string
            invoices:
              description: |
                Container for invoices. The maximum number of invoices is 1,000.
              items:
                $ref: >-
                  #/components/schemas/PaymentInvoiceApplicationCreateRequestType
              type: array
            mitTransactionSource:
              description: >
                Payment transaction source used to differentiate the transaction
                source in Stored Credential Transaction framework.
                  - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
                  - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.
                  - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
                  - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.
              enum:
                - C_Unscheduled
                - M_Recurring
                - M_Unscheduled
                - M_MOTO
              type: string
            paymentGatewayNumber:
              description: >
                The natural key for the payment gateway. 


                Use the same gateway instance if both `paymentGatewayNumber` and
                `gatewayId` are sent in the request.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the payment. 


                If no payment method ID is specified in the request body, the
                default payment method for the customer account is used
                automatically. If the default payment method is different from
                the type of payments that you want to create, an error occurs.
              type: string
            paymentMethodType:
              default: null
              description: >
                The type of the payment method that the customer used to make
                the payment. 


                Specify this value when you are creating an external payment
                method. If both `paymentMethodType` and `paymentMethodId` are
                specified, only the `paymentMethodId` value is used to create
                the payment.
              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.


                Here is an example:

                ```

                "paymentOption": [
                  {
                    "type": "GatewayOptions",
                    "detail": {
                      "SecCode":"WEB"
                    }
                  }
                ]

                ```


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


                You can use this field or the `gatewayOptions` field to pass the
                Gateway Options fields supported by a payment gateway. However,
                the Gateway Options fields passed through the `paymentOption`
                field will be stored in the Payment Option object and can be
                easily retrieved.
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleKey:
              description: >-
                The unique ID or the number of the payment schedule to be linked
                with the payment. See [Link payments to payment
                schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules)
                for more information.
              type: string
            prepayment:
              description: >
                Indicates whether the payment will be used as a reserved
                payment. 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
            referenceId:
              description: >
                The transaction ID returned by the payment gateway. Use this
                field to reconcile payments between your gateway and Zuora
                Payments.
              maxLength: 100
              minLength: 0
              type: string
            softDescriptor:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 35
              type: string
            softDescriptorPhone:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 20
              type: string
            standalone:
              default: false
              description: >
                This field is only available if support for standalone payments
                is enabled.


                Specify `true` to create a standalone payment that will be
                processed in Zuora through Zuora gateway integration but will be
                settled outside of Zuora.


                When `standalone` is set to `true`:
                  - `accountId`, `amount`, `currency`, and `type` are required. 
                  - `type` must be `Electronic`.
                  - `currency` of the payment can be different from the payment currency in the customer account settings.
                  - The amount will not be summed up into the account balance and key metrics regardless of the payment currency.
                  - No settlement data will be created.
                  - Either the applied amount or the unapplied amount of the payment is zero.
                  - The standalone payment cannot be applied, unapplied, or transferred.

                Specify `false` to create an ordinary payment that will be
                created, processed, and settled in Zuora. The `currency` of an
                ordinary payment must be the same as the currency in the
                customer account settings.
              type: boolean
            type:
              description: >
                The type of the payment.


                **Note**:  If you specify the type as `Electronic`, you must
                specify the value for `accountId` or `accountNumber`.
              enum:
                - External
                - Electronic
              type: string
          required:
            - amount
            - currency
            - type
          type: object
        - $ref: '#/components/schemas/PaymentObjectNSFields'
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
      example:
        accountId: 8a90b4488e7d5c0f018e7db3892400b2
        type: External
        paymentMethodId: 2c92c8f95e2d6ebb015e325df7a70356
        amount: 14.99
        currency: USD
        invoices:
          - invoiceId: 8a90e5e4914ad4fa01914b25ff2c036e
            amount: 14.99
    GETARPaymentTypeWithPaymentOption:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account that the payment is for.
              type: string
            accountNumber:
              description: |
                The number of the customer account that the payment is for.
              type: string
            amount:
              description: |
                The total amount of the payment.
              format: double
              type: number
            appliedAmount:
              description: |
                The applied amount of the payment.
              format: double
              type: number
            authTransactionId:
              description: |
                The authorization transaction ID from the payment gateway.
              type: string
            bankIdentificationNumber:
              description: >
                The first six or eight digits of the credit card or debit card
                used for the payment, when applicable.
              type: string
            cancelledOn:
              description: >
                The date and time when the payment was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the payment.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the payment.
              type: string
            createdDate:
              description: >
                The date and time when the payment was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditBalanceAmount:
              description: >
                The amount that the payment transfers to the credit balance. The
                value is not `0` only for those payments that come from legacy
                payment operations performed without the Invoice Settlement
                feature.
              format: double
              type: number
            currency:
              description: >
                When Standalone Payment is not enabled, the `currency` of the
                payment must be the same as the payment currency defined in the
                customer account settings through Zuora UI.


                When Standalone Payment is enabled and `standalone` is `true`,
                the `currency` of the standalone payment can be different from
                the payment currency defined in the customer account settings.
                The amount will not be summed up to the account balance or key
                metrics regardless of currency.
              type: string
            effectiveDate:
              description: >
                The date and time when the payment takes effect, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the payment.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                  nullable: true
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                  nullable: true
                transferredToAccounting:
                  description: >
                    Whether the payment was transferred to an external
                    accounting system. Use this field for integration with
                    accounting systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                  nullable: true
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                  nullable: true
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
                  nullable: true
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the payment.
              type: string
              nullable: true
            gatewayOrderId:
              description: >
                A merchant-specified natural key value that can be passed to the
                electronic payment gateway when a payment is created.  If not
                specified, the payment number will be passed in instead.
              type: string
            gatewayReconciliationReason:
              description: |
                The reason of gateway reconciliation.
              type: string
              nullable: true
            gatewayReconciliationStatus:
              description: |
                The status of gateway reconciliation.
              type: string
              nullable: true
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the payment.
                This message is gateway-dependent.
              type: string
              nullable: true
            gatewayResponseCode:
              description: >
                The code returned from the payment gateway for the payment. This
                code is gateway-dependent.
              type: string
            gatewayState:
              description: >
                The status of the payment in the gateway; use for
                reconciliation.
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: >
                The unique ID of the created payment. For example,
                4028905f5a87c0ff015a87eb6b75007f.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a payment was marked and waiting for
                batch submission to the payment process, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            number:
              description: >
                The unique identification number of the payment. For example,
                P-00000001.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentGatewayNumber:
              description: |
                The natural key for the payment gateway.
              type: string
              nullable: true
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the payment.
              type: string
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot which is a copy of
                the particular Payment Method used in a transaction.
              type: string
              nullable: true
            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: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleKey:
              description: >-
                The unique ID or the number of the payment schedule that is
                linked to the payment. See [Link payments to payment
                schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules)
                for more information.
              type: string
            payoutId:
              description: |
                The payout ID of the payment from the gateway side.
              type: string
              nullable: true
            prepayment:
              description: >
                Indicates whether the payment is used as a reserved payment. 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
            referenceId:
              description: >
                The transaction ID returned by the payment gateway. Use this
                field to reconcile payments between your gateway and Zuora
                Payments.
              type: string
              nullable: true
            refundAmount:
              description: |
                The amount of the payment that is refunded.
              format: double
              type: number
            secondPaymentReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the payment. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
              nullable: true
            settledOn:
              description: >
                The date and time when the payment was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
              nullable: true
            softDescriptor:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            standalone:
              default: false
              description: >
                This field is only available if the support for standalone
                payment is enabled. This field is not available for
                transferring, applying, or unapplying a payment.


                The value `true` indicates this is a standalone payment that is
                created and processed in Zuora through Zuora gateway integration
                but will be settled outside of Zuora. No settlement data will be
                created. The standalone payment cannot be applied, unapplied, or
                transferred.


                The value `false` indicates this is an ordinary payment that is
                created, processed, and settled in Zuora.
              type: boolean
            status:
              description: >
                The status of the payment.


                If the <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow"
                target="_blank">Asynchronous Payment Statuses</a> feature is not
                enabled, possible values are `Draft`, `Processing`, `Processed`,
                `Error`, `Canceled`, and `Posted`.


                If the Asynchronous Payment Statuses feature is enabled, when
                the ACH or Bank Transfer payment is created, it is in a
                `Pending` status upon successful network communication with the
                gateway. To transition from a `Pending` status to another
                status, use one of our Gateway Reconciliation options or cancel
                the payment.
              enum:
                - Draft
                - Processing
                - Processed
                - Error
                - Canceled
                - Posted
                - Pending
              type: string
            submittedOn:
              description: >
                The date and time when the payment was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            type:
              description: |
                The type of the payment.
              enum:
                - External
                - Electronic
              type: string
            unappliedAmount:
              description: |
                The unapplied amount of the payment.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the payment.
              type: string
            updatedDate:
              description: >
                The date and time when the payment was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentObjectNSFields'
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
    GETARPaymentType:
      allOf:
        - properties:
            accountId:
              description: |
                The ID of the customer account that the payment is for.
              type: string
            accountNumber:
              description: |
                The number of the customer account that the payment is for.
              type: string
            amount:
              description: |
                The total amount of the payment.
              format: double
              type: number
            appliedAmount:
              description: |
                The applied amount of the payment.
              format: double
              type: number
            authTransactionId:
              description: |
                The authorization transaction ID from the payment gateway.
              type: string
            bankIdentificationNumber:
              description: >
                The first six or eight digits of the credit card or debit card
                used for the payment, when applicable.
              type: string
            cancelledOn:
              description: >
                The date and time when the payment was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            comment:
              description: |
                Comments about the payment.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the payment.
              type: string
            createdDate:
              description: >
                The date and time when the payment was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditBalanceAmount:
              description: >
                The amount that the payment transfers to the credit balance. The
                value is not `0` only for those payments that come from legacy
                payment operations performed without the Invoice Settlement
                feature.
              format: double
              type: number
            currency:
              description: >
                When Standalone Payment is not enabled, the `currency` of the
                payment must be the same as the payment currency defined in the
                customer account settings through Zuora UI.


                When Standalone Payment is enabled and `standalone` is `true`,
                the `currency` of the standalone payment can be different from
                the payment currency defined in the customer account settings.
                The amount will not be summed up to the account balance or key
                metrics regardless of currency.
              type: string
            effectiveDate:
              description: >
                The date and time when the payment takes effect, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the payment.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the payment was transferred to an external
                    accounting system. Use this field for integration with
                    accounting systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the payment.
              type: string
            gatewayOrderId:
              description: >
                A merchant-specified natural key value that can be passed to the
                electronic payment gateway when a payment is created.  If not
                specified, the payment number will be passed in instead.
              type: string
            gatewayReconciliationReason:
              description: |
                The reason of gateway reconciliation.
              type: string
            gatewayReconciliationStatus:
              description: |
                The status of gateway reconciliation.
              type: string
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the payment.
                This message is gateway-dependent.
              type: string
            gatewayResponseCode:
              description: >
                The code returned from the payment gateway for the payment. This
                code is gateway-dependent.
              type: string
            gatewayState:
              description: >
                The status of the payment in the gateway; use for
                reconciliation.
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: >
                The unique ID of the created payment. For example,
                4028905f5a87c0ff015a87eb6b75007f.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a payment was marked and waiting for
                batch submission to the payment process, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            number:
              description: >
                The unique identification number of the payment. For example,
                P-00000001.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentGatewayNumber:
              description: |
                The natural key for the payment gateway.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the payment.
              type: string
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot which is a copy of
                the particular Payment Method used in a transaction.
              type: string
            paymentScheduleKey:
              description: >-
                The unique ID or the number of the payment schedule that is
                linked to the payment. See [Link payments to payment
                schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules)
                for more information.
              type: string
            payoutId:
              description: |
                The payout ID of the payment from the gateway side.
              type: string
            prepayment:
              description: >
                Indicates whether the payment is used as a reserved payment. 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
            referenceId:
              description: >
                The transaction ID returned by the payment gateway. Use this
                field to reconcile payments between your gateway and Zuora
                Payments.
              type: string
            refundAmount:
              description: |
                The amount of the payment that is refunded.
              format: double
              type: number
            secondPaymentReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the payment. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
            settledOn:
              description: >
                The date and time when the payment was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
            softDescriptor:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
            standalone:
              default: false
              description: >
                This field is only available if the support for standalone
                payment is enabled. This field is not available for
                transferring, applying, or unapplying a payment.


                The value `true` indicates this is a standalone payment that is
                created and processed in Zuora through Zuora gateway integration
                but will be settled outside of Zuora. No settlement data will be
                created. The standalone payment cannot be applied, unapplied, or
                transferred.


                The value `false` indicates this is an ordinary payment that is
                created, processed, and settled in Zuora.
              type: boolean
            status:
              description: |
                The status of the payment.
              enum:
                - Draft
                - Processing
                - Processed
                - Error
                - Canceled
                - Posted
              type: string
            submittedOn:
              description: >
                The date and time when the payment was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            type:
              description: |
                The type of the payment.
              enum:
                - External
                - Electronic
              type: string
            unappliedAmount:
              description: |
                The unapplied amount of the payment.
              format: double
              type: number
            updatedById:
              description: |
                The ID of the Zuora user who last updated the payment.
              type: string
            updatedDate:
              description: >
                The date and time when the payment was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentObjectNSFields'
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
    UpdatePaymentType:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the payment.
              maxLength: 255
              minLength: 0
              type: string
            financeInformation:
              description: >
                Container for the finance information related to the payment.


                For a standalone payment, the finance information cannot be
                updated.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the payment was transferred to an external
                    accounting system. Use this field for integration with
                    accounting systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            gatewayState:
              description: >
                This field is mainly used for gateway reconciliation. See <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Gateway_Reconciliation_Consideration"
                target="_blank">Electronic payment processing</a> for details.


                You must have the **Edit Payment Gateway Status** <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/User_Roles/e_Payments_Roles"
                target="_blank">user permission</a> to update this field.
              enum:
                - NotSubmitted
                - Submitted
                - Settled
                - FailedToSettle
              type: string
            paymentScheduleKey:
              description: >-
                The unique ID or the number of the payment schedule to be linked
                with the payment. See [Link payments to payment
                schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules)
                for more information.
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway. Use this
                field to reconcile payments between your gateway and Zuora
                Payments.


                You can only update the reference ID for external payments.
              maxLength: 100
              minLength: 0
              type: string
          type: object
        - $ref: '#/components/schemas/PaymentObjectNSFields'
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
      example:
        comment: Details about this payment
    PaymentDebitMemoApplicationItemApplyRequestType:
      properties:
        amount:
          description: >
            The amount of the payment that is applied to the specific debit memo
            or taxation item.
          format: double
          type: number
        debitMemoItemId:
          description: |
            The ID of the specific debit memo item.
          type: string
        taxItemId:
          description: |
            The ID of the specific taxation item.
          type: string
      required:
        - amount
      title: items
      type: object
    PaymentDebitMemoApplicationApplyRequestType:
      properties:
        amount:
          description: |
            The amount that is applied from the payment to the debit memo.
          format: double
          type: number
        debitMemoId:
          description: >
            The unique ID of the debit memo that the payment is applied to.


            If `debitMemoId` or `debitMemoNumber` is specified, the `writeOff`
            value can be set to true. This enables writing off a debit memo at
            the time of refund.


            **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter phase.
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        debitMemoNumber:
          description: |
            The number of the debit memo that the payment is applied to.

            **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter phase. 
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        items:
          description: >
            Container for debit memo items. The maximum number of items is
            1,000.


            **Note:** This field is only available if you have the [Invoice Item
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
            feature enabled. Invoice Item Settlement must be used together with
            other Invoice Settlement features (Unapplied Payments, and Credit
            and Debit memos).  If you wish to enable Invoice Settlement, see
            [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: >-
              #/components/schemas/PaymentDebitMemoApplicationItemApplyRequestType
          type: array
      required:
        - amount
      title: debitMemos
      type: object
    PaymentInvoiceApplicationItemApplyRequestType:
      properties:
        amount:
          description: >
            The amount of the payment that is applied to the specific invoice or
            taxation item.
          format: double
          type: number
        invoiceItemId:
          description: |
            The ID of the specific invoice item.
          type: string
        taxItemId:
          description: |
            The ID of the specific taxation item.
          type: string
      required:
        - amount
      title: items
      type: object
    PaymentInvoiceApplicationApplyRequestType:
      properties:
        amount:
          description: |
            The amount that is applied from the payment to the invoice.
          format: double
          type: number
        invoiceId:
          description: >
            The unique ID of the invoice that the payment is applied to.


            If `invoiceId` or `invoiceNumber` is specified, the `writeOff` value
            can be set to true. This enables writing off a debit memo at the
            time of refund.


            **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter phase.
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        invoiceNumber:
          description: >
            The number of the invoice that the payment is applied to. For
            example, `INV00000001`. 


            **Note:** When both the `invoiceNumber` and `invoiceId` fields are
            specified, the two fields must match with each other.

              - The Payment Cross Account (PCA) feature is in the Early Adopter phase.
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        items:
          description: >
            Container for invoice items. The maximum number of items is 1,000.


            **Note:** This field is only available if you have the [Invoice Item
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
            feature enabled. Invoice Item Settlement must be used together with
            other Invoice Settlement features (Unapplied Payments, and Credit
            and Debit memos).  If you wish to enable Invoice Settlement, see
            [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: '#/components/schemas/PaymentInvoiceApplicationItemApplyRequestType'
          type: array
      required:
        - amount
      title: invoices
      type: object
    ApplyPaymentType:
      example:
        invoices:
          - invoiceId: 8ad097b490c4e5aa0190c9b931817cef
            amount: 12
      properties:
        debitMemos:
          description: >
            Container for debit memos. The maximum number of debit memos is
            1,000.
          items:
            $ref: '#/components/schemas/PaymentDebitMemoApplicationApplyRequestType'
          type: array
        effectiveDate:
          description: >
            The date when the payment application takes effect, in `yyyy-mm-dd`
            format. The effective date must be later than or equal to the
            maximum effective date of the payment.
          format: date
          type: string
        invoices:
          description: |
            Container for invoices. The maximum number of invoices is 1,000.
          items:
            $ref: '#/components/schemas/PaymentInvoiceApplicationApplyRequestType'
          type: array
      type: object
    GETPaymentPartTypewithSuccess:
      properties:
        amount:
          description: |
            The amount of the payment part.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the payment part.
          type: string
        createdDate:
          description: >
            The date and time when the payment part was created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        debitMemoId:
          description: |
            The ID of the debit memo associated with the payment part.
          type: string
        id:
          description: |
            The ID of the payment part.
          type: string
        invoiceId:
          description: |
            The ID of the invoice associated with the payment part.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment part.
          type: string
        updatedDate:
          description: >
            The date and time when the payment part was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      title: parts
      type: object
    GETPaymentPartsCollectionType:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        parts:
          description: |
            Container for payment parts.
          items:
            $ref: '#/components/schemas/GETPaymentPartTypewithSuccess'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETPaymentPartType:
      properties:
        amount:
          description: |
            The amount of the payment part.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the payment part.
          type: string
        createdDate:
          description: >
            The date and time when the payment part was created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        debitMemoId:
          description: |
            The ID of the debit memo associated with the payment part.
          type: string
        id:
          description: |
            The ID of the payment part.
          type: string
        invoiceId:
          description: |
            The ID of the invoice associated with the payment part.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment part.
          type: string
        updatedDate:
          description: >
            The date and time when the payment part was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    GETPaymentItemPartTypewithSuccess:
      properties:
        amount:
          description: |
            The amount of the payment part item.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the payment part item.
          type: string
        createdDate:
          description: >
            The date and time when the payment part item was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        debitMemoItemId:
          description: |
            The ID of the debit memo item associated with the payment part item.
          type: string
        id:
          description: |
            The ID of the payment part item.
          type: string
        invoiceItemId:
          description: |
            The ID of the invoice item associated with the payment part item.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        taxItemId:
          description: |
            The ID of the taxation item associated with the payment part item.
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment part item.
          type: string
        updatedDate:
          description: >
            The date and time when the payment part item was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      title: itemParts
      type: object
    GETPaymentItemPartCollectionType:
      properties:
        itemParts:
          description: |
            Container for payment part items.
          items:
            $ref: '#/components/schemas/GETPaymentItemPartTypewithSuccess'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETPaymentItemPartType:
      properties:
        amount:
          description: |
            The amount of the payment part item.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the payment part item.
          type: string
        createdDate:
          description: >
            The date and time when the payment part item was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        debitMemoItemId:
          description: |
            The ID of the debit memo item associated with the payment part item.
          type: string
        id:
          description: |
            The ID of the payment part item.
          type: string
        invoiceItemId:
          description: |
            The ID of the invoice item associated with the payment part item.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        taxItemId:
          description: |
            The ID of the taxation item associated with the payment part item.
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment part item.
          type: string
        updatedDate:
          description: >
            The date and time when the payment part item was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    PostRefundType:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the refund.
              maxLength: 255
              minLength: 0
              type: string
            customRates:
              description: >
                It contains Home currency and Reporting currency custom rates
                currencies. The maximum number of items is 2 (you can pass the
                Home currency item, Reporting currency item, or both).


                **Note**:
                  
                - This field is only available if you are on the latest Zuora
                API minor version, or you set the `Zuora-Version` request header
                to `224.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).

                - You cannot set the custom rates, if both the **Automatically
                include additional Currency Conversion information in data
                source exports** option and **Fx data** feature are enabled.
              items:
                $ref: '#/components/schemas/PaymentWithCustomRatesType'
              maxItems: 2
              type: array
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values. The fields supported by gateways vary. For more
                information, see the Overview topic of each gateway integration
                in [Zuora Knowledge
                Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


                Zuora sends all the information that you specified to the
                gateway. If you specify any unsupported gateway option
                parameters, they will be ignored without error prompts.
              properties:
                key:
                  description: |
                    The name of a gateway-specific parameter.
                  type: string
                value:
                  description: |
                    The value of the gateway-specific parameter.
                  type: string
              type: object
            methodType:
              description: >
                How an external refund was issued to a customer. This field is
                required for an external refund and must be left empty for an
                electronic refund. You can issue an external refund on an
                electronic payment.
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              maxLength: 100
              minLength: 0
              type: string
            refundDate:
              description: >
                The date when the refund takes effect, in `yyyy-mm-dd` format.
                The date of the refund cannot be before the payment date.
                Specify this field only for external refunds. Zuora
                automatically generates this field for electronic refunds.
              format: date
              type: string
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              maxLength: 100
              minLength: 0
              type: string
            softDescriptor:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 35
              type: string
            softDescriptorPhone:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 20
              type: string
            totalAmount:
              description: >
                The total amount of the refund. The amount cannot exceed the
                unapplied amount of the associated payment. If the original
                payment was applied to one or more invoices or debit memos, you
                have to unapply a full or partial payment from the invoices or
                debit memos, and then refund the full or partial unapplied
                payment to your customers. 
              format: double
              type: number
            type:
              description: |
                The type of the refund.
              enum:
                - External
                - Electronic
              type: string
            refundTransactionType:
              description: |
                The transaction type of the refund.
              enum:
                - Chargeback
                - PaymentReversal
              type: string
          required:
            - totalAmount
            - type
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
      example:
        type: Electronic
        totalAmount: 10
    GETRefundPaymentType:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with this refund. Zuora
                associates the refund automatically with the account from the
                associated payment.
              type: string
            amount:
              description: |
                The total amount of the refund.
              format: double
              type: number
            cancelledOn:
              description: >
                The date and time when the refund was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format. 
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the refund.
              type: string
            createdById:
              description: |
                The ID of the Zuora user who created the refund.
              type: string
            createdDate:
              description: >
                The date and time when the refund was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10. 
              format: date-time
              type: string
            creditMemoId:
              description: |
                The ID of the credit memo associated with the refund.
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                  nullable: true
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                  nullable: true
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                  nullable: true
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
                  nullable: true
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the refund.
              type: string
            gatewayReconciliationReason:
              description: |
                The reason of gateway reconciliation.
              type: string
              nullable: true
            gatewayReconciliationStatus:
              description: |
                The status of gateway reconciliation.
              type: string
              nullable: true
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the refund.
                This message is gateway-dependent.
              type: string
            gatewayResponseCode:
              description: >
                The code returned from the payment gateway for the refund. This
                code is gateway-dependent.
              type: string
            gatewayState:
              description: |
                The status of the refund in the gateway.
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: |
                The ID of the created refund.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a refund was marked and waiting for batch
                submission to the payment process, in `yyyy-mm-dd hh:mm:ss`
                format.
              format: date-time
              type: string
              nullable: true
            methodType:
              description: |
                How an external refund was issued to a customer.
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            number:
              description: |
                The unique identification number of the refund.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentGatewayNumber:
              description: |
                The natural key for the payment gateway.
              type: string
            paymentId:
              description: |
                The ID of the payment that is refunded.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the refund. 
              type: string
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot, which is a copy of
                the particular payment method used in a transaction.
              type: string
            payoutId:
              description: |
                The payout ID of the refund from the gateway side.
              type: string
              nullable: true
            reasonCode:
              description: |
                A code identifying the reason for the transaction. 
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              type: string
              nullable: true
            refundDate:
              description: |
                The date when the refund takes effect, in `yyyy-mm-dd` format.
              format: date
              type: string
            refundTransactionTime:
              description: >
                The date and time when the refund was issued, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
              nullable: true
            settledOn:
              description: >
                The date and time when the refund was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
              nullable: true
            softDescriptor:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
              nullable: true
            status:
              description: |
                The status of the refund.
              enum:
                - Processed
                - Canceled
                - Error
                - Processing
              type: string
            submittedOn:
              description: >
                The date and time when the refund was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            type:
              description: |
                The type of the refund.
              enum:
                - External
                - Electronic
              type: string
            updatedById:
              description: |
                The ID of the the Zuora user who last updated the refund.
              type: string
            updatedDate:
              description: >
                The date and time when the refund was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
    PostRefundwithAutoUnapplyType:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the refund.
              maxLength: 255
              minLength: 0
              type: string
            debitMemos:
              description: >
                Container for debit memos. The maximum number of debit memos is
                1,000.
              items:
                $ref: >-
                  #/components/schemas/PaymentDebitMemoApplicationApplyRequestType
              type: array
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            gatewayOptions:
              description: >
                The field used to pass gateway-specific parameters and parameter
                values. The fields supported by gateways vary. For more
                information, see the Overview topic of each gateway integration
                in [Zuora Knowledge
                Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


                Zuora sends all the information that you specified to the
                gateway. If you specify any unsupported gateway option
                parameters, they will be ignored without error prompts.
              properties:
                key:
                  description: |
                    The name of a gateway-specific parameter.
                  type: string
                value:
                  description: |
                    The value of the gateway-specific parameter.
                  type: string
              type: object
            invoices:
              description: |
                Container for invoices. The maximum number of invoices is 1,000.
              items:
                $ref: '#/components/schemas/PaymentInvoiceApplicationApplyRequestType'
              type: array
            methodType:
              description: >
                How an external refund was issued to a customer. This field is
                required for an external refund and must be left empty for an
                electronic refund. You can issue an external refund on an
                electronic payment.
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              maxLength: 100
              minLength: 0
              type: string
            refundDate:
              description: >
                The date when the refund takes effect, in `yyyy-mm-dd` format.
                The date of the refund cannot be before the payment date.
                Specify this field only for external refunds. Zuora
                automatically generates this field for electronic refunds.
              format: date
              type: string
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              maxLength: 100
              minLength: 0
              type: string
            softDescriptor:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 35
              type: string
            softDescriptorPhone:
              description: >-
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              maxLength: 20
              type: string
            totalAmount:
              description: >
                The total amount of the refund. If you do not specify a value,
                Zuora initiates a full refund of the payment amount, which is
                the sum of the applied and unapplied payment amounts.

                  - `Full Refund`: If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund.
                  - `Partial Refund`:
                       - If the total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer.
                       - If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers.  
              format: double
              type: number
            type:
              description: |
                The type of the refund.
              enum:
                - External
                - Electronic
              type: string
            refundTransactionType:
              description: |
                The transaction type of the refund.
              enum:
                - Chargeback
                - PaymentReversal
              type: string
            writeOff:
              default: false
              description: |
                Indicates whether to write off a document.
              type: boolean
            writeOffOptions:
              description: |
                Container for the write-off information to create credit memo.
              properties:
                comment:
                  description: >
                    Comments about the credit memo which is created as a result
                    of the write off.
                  maxLength: 100
                  type: string
                memoDate:
                  description: |
                    The date when the credit memo takes effect.
                  format: date
                  type: string
                reasonCode:
                  description: |
                    A code identifying the reason for the credit memo.
                  type: string
                taxAutoCalculation:
                  description: >
                    Specifies whether taxes are automatically recalculated for
                    the credit memo generated during the write-off process.


                    When set to `true`, the system fetches the latest tax rates
                    from the tax vendor instead of copying the tax amounts from
                    the original invoice.


                    The default value is `false`.


                    **Note**: This feature is in the **Early Availability**
                    phase. Contact Zuora Global Support to enable this feature
                    before using it.
                  type: boolean
              type: object
          required:
            - type
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
      example:
        type: Electronic
        totalAmount: 10
    GETRefundPaymentTypeAutoUnapply:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with this refund. Zuora
                associates the refund automatically with the account from the
                associated payment.
              type: string
            amount:
              description: |
                The total amount of the refund.
              format: double
              type: number
            cancelledOn:
              description: >
                The date and time when the refund was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format. 
              format: date-time
              type: string
            comment:
              description: |
                Comments about the refund.
              type: string
            createdById:
              description: |
                The ID of the Zuora user who created the refund.
              type: string
            createdDate:
              description: >
                The date and time when the refund was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10. 
              format: date-time
              type: string
            creditMemoId:
              description: |
                The ID of the credit memo associated with the refund.
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the refund.
              type: string
            gatewayReconciliationReason:
              description: |
                The reason of gateway reconciliation.
              type: string
            gatewayReconciliationStatus:
              description: |
                The status of gateway reconciliation.
              type: string
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the refund.
                This message is gateway-dependent.
              type: string
            gatewayResponseCode:
              description: >
                The code returned from the payment gateway for the refund. This
                code is gateway-dependent.
              type: string
            gatewayState:
              description: |
                The status of the refund in the gateway.
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: |
                The ID of the created refund.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a refund was marked and waiting for batch
                submission to the payment process, in `yyyy-mm-dd hh:mm:ss`
                format.
              format: date-time
              type: string
            methodType:
              description: |
                How an external refund was issued to a customer.
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            number:
              description: |
                The unique identification number of the refund.
              type: string
            paymentGatewayNumber:
              description: |
                The natural key for the payment gateway.
              type: string
            paymentId:
              description: |
                The ID of the payment that is refunded.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the refund. 
              type: string
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot, which is a copy of
                the particular payment method used in a transaction.
              type: string
            payoutId:
              description: |
                The payout ID of the refund from the gateway side.
              type: string
            reasonCode:
              description: |
                A code identifying the reason for the transaction. 
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              type: string
            refundDate:
              description: |
                The date when the refund takes effect, in `yyyy-mm-dd` format.
              format: date
              type: string
            refundTransactionTime:
              description: >
                The date and time when the refund was issued, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
            settledOn:
              description: >
                The date and time when the refund was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
            softDescriptor:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps to Zuora for the
                gateways, Orbital, Vantiv and Verifi.
              type: string
            status:
              description: |
                The status of the refund.
              enum:
                - Processed
                - Canceled
                - Error
                - Processing
              type: string
            submittedOn:
              description: >
                The date and time when the refund was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            type:
              description: |
                The type of the refund.
              enum:
                - External
                - Electronic
              type: string
            updatedById:
              description: |
                The ID of the the Zuora user who last updated the refund.
              type: string
            updatedDate:
              description: >
                The date and time when the refund was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
            writeOffResults:
              description: >
                Container for the write-off information of credit memo and apply
                information.
              properties:
                errorMessage:
                  description: |
                    The error message about write off failed.
                  type: string
                transactions:
                  description: |
                    The credit memo apply information.
                  properties:
                    appliedAmount:
                      description: |
                        The credit memo applied amopunt.
                      format: double
                      type: number
                    creditMemoAmount:
                      description: |
                        The credit memo amount.
                      type: string
                    creditMemoNumber:
                      description: |
                        The unique identification number of the credit memo.
                      type: string
                    creditMemoStatus:
                      description: |
                        The status of the credit memo. 
                      enum:
                        - Draft
                        - Posted
                        - Canceled
                        - Error
                        - PendingForTax
                        - Generating
                        - CancelInProgress
                      type: string
                    invoiceNumber:
                      description: |
                        The unique identification number of the invoice.
                      type: string
                  title: transactions
                  type: object
              type: object
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
    TransferPaymentType:
      example:
        accountId: 4028905f5a87c0ff015a88889fe500a8
      properties:
        accountId:
          description: >
            The ID of the customer account that the payment is transferred to.

            Unassign a payment by setting this field to an empty string. This
            will automatically transfer the payment to a null account.
          type: string
      type: object
    PaymentDebitMemoApplicationItemUnapplyRequestType:
      properties:
        amount:
          description: >
            The amount of the payment that is unapplied from the specific debit
            mem or taxation item.
          format: double
          type: number
        debitMemoItemId:
          description: |
            The ID of the specific debit memo item.
          type: string
        taxItemId:
          description: |
            The ID of the specific taxation item.
          type: string
      required:
        - amount
      title: items
      type: object
    PaymentDebitMemoApplicationUnapplyRequestType:
      properties:
        amount:
          description: |
            The amount of the payment that is unapplied from the debit memo.
          format: double
          type: number
        debitMemoId:
          description: |
            The unique ID of the debit memo that the payment is unapplied from.

            **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter phase.
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        debitMemoNumber:
          description: |
            The number of the debit memo that the payment is unapplied from.

            **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter phase.
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        items:
          description: >
            Container for debit memo items. The maximum number of items is
            1,000.


            **Note:** This field is only available if you have the [Invoice Item
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
            feature enabled. Invoice Item Settlement must be used together with
            other Invoice Settlement features (Unapplied Payments, and Credit
            and Debit memos).  If you wish to enable Invoice Settlement, see
            [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: >-
              #/components/schemas/PaymentDebitMemoApplicationItemUnapplyRequestType
          type: array
      required:
        - amount
      title: debitMemos
      type: object
    PaymentInvoiceApplicationItemUnapplyRequestType:
      properties:
        amount:
          description: >
            The amount of the payment that is unapplied from the specific
            invoice or taxation item.
          format: double
          type: number
        invoiceItemId:
          description: |
            The ID of the specific invoice item.
          type: string
        taxItemId:
          description: |
            The ID of the specific taxation item.
          type: string
      required:
        - amount
      title: items
      type: object
    PaymentInvoiceApplicationUnapplyRequestType:
      properties:
        amount:
          description: |
            The amount of the payment that is unapplied from the invoice.
          format: double
          type: number
        invoiceId:
          description: |
            The unique ID of the invoice that the payment is unapplied from.

            **Note:**
              - The Payment Cross Account (PCA) feature is in the Early Adopter phase.
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        invoiceNumber:
          description: >
            The number of the invoice that the payment is unapplied from. For
            example, `INV00000001`. 


            **Note:** When both the `invoiceNumber` and `invoiceId` fields are
            specified, the two fields must match with each other.

              - The Payment Cross Account (PCA) feature is in the Early Adopter phase.
              - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body.
          type: string
        items:
          description: >
            Container for invoice items. The maximum number of items is 1,000.


            **Note:** This field is only available if you have the [Invoice Item
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
            feature enabled. Invoice Item Settlement must be used together with
            other Invoice Settlement features (Unapplied Payments, and Credit
            and Debit memos).  If you wish to enable Invoice Settlement, see
            [Invoice Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          items:
            $ref: >-
              #/components/schemas/PaymentInvoiceApplicationItemUnapplyRequestType
          type: array
      required:
        - amount
      title: invoices
      type: object
    UnapplyPaymentType:
      example:
        invoices:
          - invoiceId: 8ad097b490c4e5aa0190c9b931817cef
            amount: 12
      properties:
        debitMemos:
          description: >
            Container for debit memos. The maximum number of debit memos is
            1,000.
          items:
            $ref: '#/components/schemas/PaymentDebitMemoApplicationUnapplyRequestType'
          type: array
        effectiveDate:
          description: >
            The date when the payment is unapplied, in `yyyy-mm-dd` format. The
            effective date must be later than or equal to the maximum effective
            date of the payment.
          format: date
          type: string
        invoices:
          description: |
            Container for invoices. The maximum number of invoice is 1,000.
          items:
            $ref: '#/components/schemas/PaymentInvoiceApplicationUnapplyRequestType'
          type: array
      type: object
    ProxyGetPaymentTransactionLog:
      properties:
        AVSResponseCode:
          description: >
            The response code returned by the payment gateway referring to the
            AVS international response of the payment transaction.
          type: string
        BatchId:
          description: >
            The ID of the batch used to send the transaction if the request was
            sent in a batch.
          type: string
        CVVResponseCode:
          description: >
            The response code returned by the payment gateway referring to the
            CVV international response of the payment transaction.
          type: string
        Gateway:
          description: >
            The name of the payment gateway used to transact the current payment
            transaction log.
          type: string
        GatewayReasonCode:
          description: >
            The code returned by the payment gateway for the payment. This code
            is gateway-dependent.
          type: string
        GatewayReasonCodeDescription:
          description: >
            The message returned by the payment gateway for the payment. This
            message is gateway-dependent. 
          type: string
        GatewayState:
          description: |
            The state of the transaction at the payment gateway.
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        GatewayTransactionType:
          description: >
            The type of the transaction, either making a payment, or canceling a
            payment. 
          enum:
            - Authorization
            - Sale
            - Void
            - Inquiry
            - VoidAuth
          type: string
        Id:
          description: |
            The ID of the payment transaction log.
          type: string
        PaymentId:
          description: >
            The ID of the payment wherein the payment transaction log was
            recorded. 
          type: string
        RequestString:
          description: |
            The payment transaction request string sent to the payment gateway. 
          type: string
        ResponseString:
          description: >
            The payment transaction response string returned by the payment
            gateway. 
          type: string
        TransactionDate:
          description: |
            The transaction date when the payment was performed. 
          format: date-time
          type: string
        TransactionId:
          description: >
            The transaction ID returned by the payment gateway. This field is
            used to reconcile payment transactions between the payment gateway
            and records in Zuora.
          type: string
      type: object
    GETPaymentRunType:
      properties:
        accountId:
          description: |
            The ID of the customer account associated with the payment run.
          type: string
        applyCreditBalance:
          description: >
            **Note:** This field is only available if you have the Credit
            Balance feature enabled and the Invoice Settlement feature disabled.


            Whether to apply credit balances in the payment run. This field is
            only available when you have Invoice Settlement feature disabled.
          type: boolean
        autoApplyCreditMemo:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            Whether to automatically apply a posted credit memo to one or more
            receivables in the payment run.
          type: boolean
        autoApplyUnappliedPayment:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            Whether to automatically apply unapplied payments to  one or more
            receivables in the payment run.
          type: boolean
        batch:
          description: |
            The alias name given to a batch.
          example: Batch1
          type: string
        billCycleDay:
          description: >
            The billing cycle day (BCD), the day of the month when a bill run
            generates invoices for the account. 
          example: 1
          type: string
        billingRunId:
          description: |
            The ID of the bill run.
          format: uuid
          type: string
        collectPayment:
          description: >
            Whether to process electronic payments during the execution of
            payment runs. 
          type: boolean
        completedOn:
          description: >
            The date and time when the payment run is completed, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2017-03-01 11:39:58.
          format: date-time
          type: string
          nullable: true
        consolidatedPayment:
          description: >
            **Note:** The **Process Electronic Payment** permission also needs
            to be allowed for a Manage Payment Runs role to work. See [Payments
            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)
            for more information. 


            Whether to process a single payment for all receivables that are due
            on an account.
          type: boolean
        createdById:
          description: |
            The ID of the Zuora user who created the payment run.
          type: string
        createdDate:
          description: >
            The date and time when the payment run was created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        currency:
          description: |
            A currency defined in the web-based UI administrative settings.
          example: USD
          type: string
        executedOn:
          description: >
            The date and time when the payment run is executed, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2017-03-01 11:30:37.
          format: date-time
          type: string
          nullable: true
        id:
          description: |
            The ID of the payment run.
          type: string
        number:
          description: |
            The identification number of the payment run.
          type: string
        organizationLabels:
          description: >
            The organization(s) that the object belongs to. 


            Note: This field is available only when the Multi-Org feature is
            enabled.
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        paymentGatewayId:
          description: |
            The ID of the gateway instance that processes the payment.
          format: uuid
          type: string
          nullable: true
        processPaymentWithClosedPM:
          description: >
            **Note:** The **Process Electronic Payment** permission also needs
            to be allowed for a Manage Payment Runs role to work. See [Payments
            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)
            for more information. 


            Whether to process payments even if the default payment method is
            closed.
          type: boolean
        runDate:
          description: >
            The date and time when the scheduled payment run is to be executed
            for collecting payments.
          format: date-time
          type: string
        status:
          description: |
            The status of the created payment run.
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Canceled
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        targetDate:
          description: >
            The target date used to determine which receivables to be collected
            in the payment run. 
          format: date
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the payment run.
          type: string
        updatedDate:
          description: >
            The date and time when the payment run was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
        useCustomPaymentMethods:
          description: |
            Whether to enable payment profiles for a payment run.
          type: boolean
      title: paymentRuns
      type: object
    GETPaymentRunCollectionType:
      properties:
        nextPage:
          description: >
            The URL for requesting the next page of the response, if it exists;
            otherwise absent.
          type: string
        paymentRuns:
          description: |
            Container for payment runs.
          items:
            $ref: '#/components/schemas/GETPaymentRunType'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTPaymentRunDataElementRequest:
      allOf:
        - properties:
            accountId:
              description: >
                A valid account ID associated with the payment run.


                If `consolidatedPayment` is set to `true`, this field is used in
                processing a single payment for invoices/debit memos due on an
                account.
              type: string
            accountNumber:
              description: >
                The number of the customer account associated with the payment
                run, such as `A00000001`.


                You can specify either `accountNumber` or `accountId` for a
                customer account, but not both of them.


                If `consolidatedPayment` is set to `true`, this field is used in
                processing a single payment for invoices, debit memos, and
                standalone payments due on an account.
              type: string
            amount:
              description: >
                The amount to be collected for the specified invoice/debit memo.
                `amount` must be a positive numeric value no more than the
                balance of the specified invoice/debit memo.


                This field is only available when `documentId` is specified. If
                `amount` is not specified, whole balance of the invoice/debit
                memo is collected.
              type: number
            comment:
              description: |
                Additional comments.
              type: string
            currency:
              description: >
                Note: This field is only available if support for standalone
                payments is enabled.


                The currency of the standalone payment. Specify this field only
                if the `standalone` field is `true`. The currency of the
                standalone payment can be different from the payment currency
                defined in the customer account settings.
              type: string
            dataItems:
              description: >
                The array of data for each Invoice if you want to collect
                payment for particular items through one payment method. The
                grouped items are sent as one data record.  This field is
                available if the [Invoice Item
                Settlement](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Invoice_Item_Settlement/Overview_of_Invoice_Item_Settlement)
                permission is enabled.


                Here is another example for a data item:
                  ```
                  {
                    "accountId": "60c81b5bc51649e8a7d1b48303194790",
                    "documentId": "2c9081a03c63c94c013c6894af5602dd",
                    "documentType": "Invoice",
                    "dataItems": [
                      {
                          "documentItemId": "8a92ab0e8ab14c53018ac746961c10d1",
                          "amount": 40
                      },
                      {
                          "taxItemId": "8a92ab0e8ab14c53018ac746961c10d2",
                          "amount": 40
                      }
                  ],
                    "amount": 80,
                    "paymentMethodId": "2c9081a03c6d7b51013c6d7e4ada0a1c",
                    "paymentGatewayId": "d2abe8342e1811ea80e774b9452e17ea",
                    "comment": "Payment Comments",
                    "customField1__c": "cf_value1",
                    "customField2__c": "cf_value2"
                  },
                  ```
              properties:
                amount:
                  description: >
                    The total amount to be collected for the specified
                    invoice/debit memo item. The sum of the item amount should
                    be equal to document amount.
                  type: number
                documentItemId:
                  description: >
                    The ID of a billing document of the invoice item or debit
                    memo item.
                  type: string
                taxItemId:
                  description: |
                    The tax ID of the invoice item or debit memo item.
                  type: string
              title: dataItems
              type: object
            documentId:
              description: >
                The ID of a billing document associated with the payment run.
                `documentId` must be valid and match with `documentType`.


                You must either specify both `documentId` and `documentType`, or
                specify neither of them.


                If neither of `documentType` and `documentId` is specified, all
                invoices/debit memos with open balance of the account are
                collected.
              type: string
            documentNumber:
              description: >
                The number of a billing document associated with the payment
                run. `documentNumber` must be valid and match with
                `documentType`.


                You must either specify both `documentNumber` and
                `documentType`, or specify neither of them.


                If neither of `documentType` and `documentNumber` is specified,
                all invoices/debit memos with open balance of the account are
                collected.
              type: string
            documentType:
              description: >
                The type of a billing document associated with the payment run.
                The value can be `Invoice` or `DebitMemo`, but `DebitMemo` is
                only supported if the Invoice Settlement feature is enabled.


                You must either specify both `documentType` and `documentId`, or
                specify neither of them.


                If neither of `documentType` and `documentId` is specified, all
                invoices/debit memos with open balance of the account are
                collected.
              enum:
                - Invoice
                - DebitMemo
              type: string
            paymentGatewayId:
              description: >
                The ID of the payment gateway for collecting invoices/debit
                memos. The specified payment gateway must be valid and active.


                If <a
                href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_gateway_integrations/Payment_Gateway_Routing"
                target="_blank">Payment Gateway Routing</a> is enabled: 
                  - If this field is not specified, gateway routing rules will be invoked.
                  - If this field is specified, the specified gateway will be used to process the payment.

                If Payment Gateway Routing is disabled:
                  - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant.
                  - If this field is specified, the specified gateway will be used to process the payment.

                If `consolidatedPayment` is set to `true`, this field is used in
                processing a single payment for invoices/debit memos due on an
                account.
              type: string
            paymentMethodId:
              description: >
                The ID of the payment method for collecting invoices/debit
                memos. The specified payment method must be a valid non-system
                payment method. If it is not specified, the default payment
                method of the account is used regardless of the `autoPay` value
                of the account.


                If `processPaymentWithClosedPM` is set to `false`, the payment
                method cannot be closed.


                If the payment retry rules are enabled, the payment method must
                meet the rules.


                If `consolidatedPayment` is set to `true`, this field is used in
                processing a single payment for invoices/debit memos due on an
                account.
              type: string
            standalone:
              default: false
              description: >
                Note: This field is only available if support for standalone
                payments is enabled.


                Specify `true` to indicate that this is a standalone payment
                that will be created and processed in Zuora through Zuora
                gateway integration but will be settled outside of Zuora. When
                `standalone` is set to `true`:
                  - `accountId` or `accountNumber` is required.
                  - `amount` is required. 
                  - The amount will not be summed up into the account balance and key metrics regardless of the payment currency.
                  - No settlement data will be created.
                  - Either the applied amount or the unapplied amount of the payment is zero.
                  - The standalone payment cannot be applied, unapplied, or transferred.
              type: boolean
          type: object
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
    POSTPaymentRunRequest:
      example:
        accountId: 8ad09be48db5aba7018db604776d4854
        targetDate: '2024-07-24'
      properties:
        accountId:
          description: >
            The ID of the customer account associated with the payment run.


            This field conflicts with each of the `batch`, `billCycleDay`,
            `currency`, `paymentGatewayId`, and `billingRunId` fields. If there
            are such conflicts, an error occurs and an error message is
            returned.
          format: uuid
          type: string
        applyCreditBalance:
          description: >
            If `applyCreditBalance` is true, the credit memo or unapplied
            payment on the order account will be automatically applied to the
            invoices generated by this order. The credit memo generated by this
            order will not be automatically applied to any invoices.
          type: boolean
        autoApplyCreditMemo:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            Whether to automatically apply a posted credit memo to one or more
            receivables in the payment run.
          type: boolean
        autoApplyUnappliedPayment:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            Whether to automatically apply unapplied payments to  one or more
            receivables in the payment run.
          type: boolean
        batch:
          description: >
            The alias name given to a batch. The batch name is a string of 50
            characters or less.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned. 


            **Note**: By default, you have 50 configurable account batches. To
            increase the limit to 200 batches, you must have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite"
            target="_blank">Performance Booster Elite</a> package.
          type: string
        billCycleDay:
          description: >
            The billing cycle day (BCD), the day of the month when a bill run
            generates invoices for the account. The value must be equal to or
            less then 31, and 31 is mean the EOM.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          type: string
        billingRunId:
          description: >
            The ID of a bill run.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          format: uuid
          type: string
        collectPayment:
          description: >
            Whether to process electronic payments during the execution of
            payment runs. 


            If the Payment user permission "Process Electronic Payment" is
            disabled, this field will be ignored.
          type: boolean
        consolidatedPayment:
          description: >
            **Note:** The **Process Electronic Payment** permission also needs
            to be allowed for a Manage Payment Runs role to work. See [Payments
            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)
            for more information. 


            Whether to process a single payment for all receivables that are due
            on an account.
          type: boolean
        currency:
          description: >
            A currency defined in the web-based UI administrative settings.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          type: string
        data:
          description: >

            The array of data for specifying records of accounts and
            invoices/debit memos that will be collected and processed by a
            payment run.


            When you specify the data array, ensure that at least one record is
            passed in. If an empty array is specified, `accountId`, `batch`,
            `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId`
            fields will be used to define the billing documents to be collected.
            If the [Multiple
            Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies)
            feature is enabled, you can filter the accounts by `currency` based
            on the customer's billing document.


            A maximum of 50K records are allowed to be passed into the `data`
            array.


            Here is an example:

            ```
              {
                "accountId": "60c81b5bc51649e8a7d1b48303194790",
                "documentId": "2c9081a03c63c94c013c6894af5602dd",
                "documentType": "Invoice",
                "amount": 80,
                "paymentMethodId": "2c9081a03c6d7b51013c6d7e4ada0a1c",
                "paymentGatewayId": "d2abe8342e1811ea80e774b9452e17ea",
                "comment": "Payment Comments",
                "customField1__c": "cf_value1",
                "customField2__c": "cf_value2"
              }
            ```


            Here is another example for a standalone payment:

            ```
              {
                "accountId": "account2",
                "amount": 100,
                "currency": "GBP",
                "standalone": true
              }
            ```
          items:
            $ref: '#/components/schemas/POSTPaymentRunDataElementRequest'
          title: payment run data
          type: array
        organizationLabels:
          description: >
            The organizations that the run is created for. 


            For each item in the array, either the `organizationId` or the
            `organizationName` field is required.


            This field is only required when you have already turned on
            Multi-Org feature.
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        paymentGatewayId:
          description: >
            The ID of the gateway instance that processes the payment.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          format: uuid
          type: string
        processPaymentWithClosedPM:
          description: >
            **Note:** The **Process Electronic Payment** permission also needs
            to be allowed for a Manage Payment Runs role to work. See [Payments
            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)
            for more information. 


            Whether to process payments even if the default payment method is
            closed.
          type: boolean
        runDate:
          description: >
            The date and time when the scheduled payment run is to be executed,
            in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and
            seconds in the field value. For example, if you specify `2017-03-01
            11:30:37` for this value, this payment run will be run at 2017-03-01
            11:00:00.


            You must specify either the `runDate` field or the `targetDate`
            field in the request body. If you specify the `runDate` field, the
            scheduced payment run is to be executed on the run date. If you
            specify the `targetDate` field, the payment run is executed
            immediately after it is created. 
          format: date-time
          type: string
        targetDate:
          description: >
            The target date used to determine which receivables to be paid in
            the payment run. The payments are collected for all receivables with
            the due date no later than the target date.


            You must specify either the `runDate` field or the `targetDate`
            field in the request body. If you specify the `runDate` field, the
            scheduced payment run is to be executed on the run date. If you
            specify the `targetDate` field, the payment run is executed
            immediately after it is created. 
          format: date
          type: string
        useCustomPaymentMethods:
          description: |
            Whether to enable payment profiles for a payment run.
          type: boolean
      type: object
    PUTPaymentRunRequest:
      example:
        autoApplyUnappliedPayment: true
      properties:
        accountId:
          description: >
            The ID of the customer account associated with the payment run.


            This field conflicts with each of the `batch`, `billCycleDay`,
            `currency`, `paymentGatewayId`, and `billingRunId` fields. If there
            are such conflicts, an error occurs and an error message is
            returned.
          format: uuid
          type: string
        applyCreditBalance:
          description: >
            **Note:** This field is only available if you have the Credit
            Balance feature enabled and the Invoice Settlement feature disabled.


            Whether to apply credit balances in the payment run. This field is
            only available when you have Invoice Settlement feature disabled.
          type: boolean
        autoApplyCreditMemo:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            Whether to automatically apply a posted credit memo to one or more
            receivables in the payment run.
          type: boolean
        autoApplyUnappliedPayment:
          description: >
            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.


            Whether to automatically apply unapplied payments to  one or more
            receivables in the payment run.
          type: boolean
        batch:
          description: >
            The alias name given to a batch. The batch name is a string of 50
            characters or less.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned. 


            **Note**: By default, you have 50 configurable account batches. To
            increase the limit to 200 batches, you must have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Performance_Booster_Elite"
            target="_blank">Performance Booster Elite</a> package.
          type: string
        billCycleDay:
          description: >
            The billing cycle day (BCD), the day of the month when a bill run
            generates invoices for the account. The value must be equal to or
            less then 31, and 31 is mean the EOM.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          type: string
        billingRunId:
          description: >
            The ID of a bill run.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          format: uuid
          type: string
        collectPayment:
          description: >
            Whether to process electronic payments during the execution of
            payment runs. 


            If the Payment user permission "Process Electronic Payment" is
            disabled, this field will be ignored.
          type: boolean
        consolidatedPayment:
          description: >
            **Note:** The **Process Electronic Payment** permission also needs
            to be allowed for a Manage Payment Runs role to work. See [Payments
            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)
            for more information. 


            Whether to process a single payment for all receivables that are due
            on an account.
          type: boolean
        currency:
          description: >
            A currency defined in the web-based UI administrative settings.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          type: string
        organizationLabels:
          description: >
            The organizations that the run is created for. 


            For each item in the array, either the `organizationId` or the
            `organizationName` field is required.


            This field is only required when you have already turned on
            Multi-Org feature.
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        paymentGatewayId:
          description: >
            The ID of the gateway instance that processes the payment.


            This field conflicts with the `accountId` field. If they are both
            specified in the request body, an error occurs and an error message
            is returned.
          format: uuid
          type: string
          nullable: true
        processPaymentWithClosedPM:
          description: >
            **Note:** The **Process Electronic Payment** permission also needs
            to be allowed for a Manage Payment Runs role to work. See [Payments
            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)
            for more information. 


            Whether to process payments even if the default payment method is
            closed.
          type: boolean
        runDate:
          description: >
            The date and time when the scheduled payment run is to be executed,
            in `yyyy-mm-dd hh:mm:ss` format. The backend will ignore mintues and
            seconds in the field value. For example, if you specify `2017-03-01
            11:30:37` for this value, this payment run will be run at 2017-03-01
            11:00:00.
          format: date-time
          type: string
        targetDate:
          description: >
            The target date used to determine which receivables to be paid in
            the payment run. The payments are collected for all receivables with
            the due date no later than the target date.
          format: date
          type: string
      type: object
    GETPaymentRunDataTransactionElementResponse:
      properties:
        amount:
          description: |
            The total amount of the newly generated payment.

            **Note:** This field is only available if `type` is `Payment`.
          type: number
        appliedAmount:
          description: |
            The amount allocated to this data record.
          type: number
        errorCode:
          description: |
            The error code of the response.

            **Note:** This field is only available if `type` is `Payment`.
          type: string
        errorMessage:
          description: |
            The detailed information of the error response.

            **Note:** This field is only available if `type` is `Payment`.
          type: string
        id:
          description: |
            The ID of the current transaction.
          type: string
        status:
          description: |
            The status of the newly generated payment.

            **Note:** This field is only available if `type` is `Payment`.
          enum:
            - Processed
            - Processing
            - Error
          type: string
        type:
          description: |
            The type of the current transaction.
          enum:
            - Payment
            - CreditMemo
            - UnappliedPayment
            - CreditBalanceAdjustment
          type: string
      title: payment run transaction
      type: object
    GETPaymentRunDataElementResponse:
      allOf:
        - properties:
            accountId:
              description: >
                The customer account ID specified in the `data` field when
                creating the payment run.
              type: string
            accountNumber:
              description: >
                The customer account number specified in the `data` field when
                creating the payment run.
              type: string
            amount:
              description: >
                The amount specified in the `data` field when creating the
                payment run. `null` is returned if it was not specified.
              type: number
            amountCollected:
              description: |
                The amount that is collected.
              type: number
            amountToCollect:
              description: |
                The amount to be collected.
              type: number
            comment:
              description: >
                The comment specified in the `data` field when creating the
                payment run. `null` is returned if it was not specified.
              type: string
              nullable: true
            currency:
              description: >
                This field is only available if support for standalone payments
                is enabled.


                The currency of the standalone payment. The currency of the
                standalone payment can be different from the payment currency
                defined in the customer account settings.
              type: string
            documentId:
              description: >
                The billing document ID specified in the `data` field when
                creating the payment run. `null` is returned if it was not
                specified.
              type: string
            documentNumber:
              description: >
                The billing document number specified in the `data` field when
                creating the payment run. `null` is returned if it was not
                specified.
              type: string
            documentType:
              description: >
                The billing document type specified in the `data` field when
                creating the payment run. `null` is returned if it was not
                specified.
              enum:
                - Invoice
                - DebitMemo
              type: string
            errorCode:
              description: |
                The error code of the response.
              type: string
            errorMessage:
              description: |
                The detailed information of the error response.
              type: string
            paymentGatewayId:
              description: >
                The payment gateway ID specified in the `data` field when
                creating the payment run. `null` is returned if it was not
                specified.
              type: string
              nullable: true
            paymentMethodId:
              description: >
                The payment method ID specified in the `data` field when
                creating the payment run. `null` is returned if it was not
                specified.
              type: string
            result:
              description: |
                Indicates whether the data is processed successfully or not.
              enum:
                - Processed
                - Error
              type: string
            standalone:
              description: >
                This field is only available if the support for standalone
                payment is enabled.


                The value `true` indicates this is a standalone payment that is
                created and processed in Zuora through Zuora gateway integration
                but will be settled outside of Zuora. No settlement data will be
                created. The standalone payment cannot be applied, unapplied, or
                transferred.
              type: boolean
            transactions:
              description: >
                Container for transactions that apply to the current request.
                Each element contains an array of the settlement/payment applied
                to the record.
              items:
                $ref: >-
                  #/components/schemas/GETPaymentRunDataTransactionElementResponse
              type: array
          title: payment run data
          type: object
        - $ref: '#/components/schemas/PaymentObjectCustomFields'
    GETPaymentRunDataArrayResponse:
      properties:
        data:
          description: >
            Container for payment run data. Each element in the array is a
            record processed by the payment run.
          items:
            $ref: '#/components/schemas/GETPaymentRunDataElementResponse'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETPaymentRunSummaryTotalValues:
      properties:
        totalValueOfCreditBalance:
          description: >
            **Note:** This field is only available if you have the Credit
            Balance feature enabled.


            The total amount of credit balance after the payment run is
            completed.
          type: string
        totalValueOfCreditMemos:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total amount of credit memos that are successfully processed in
            the payment run.
          type: string
        totalValueOfDebitMemos:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total amount of debit memos that are picked up for processing in
            the payment run.
          type: string
        totalValueOfErrors:
          description: >
            The total amount of receivables associated with the payments with
            the status of `Error` and `Processing`.
          type: string
        totalValueOfInvoices:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total amount of invoices that are picked up for processing in
            the payment run.
          type: string
        totalValueOfPayments:
          description: >
            The total amount of payments that are successfully processed in the
            payment run.
          type: string
        totalValueOfReceivables:
          description: >
            The total amount of receivables associated with the payment run.


            The value of this field is the sum of the value of the
            `totalValueOfInvoices` field and that of the
            `totalValueOfDebitMemos` field.
          type: string
        totalValueOfUnappliedPayments:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total amount of unapplied payments that are successfully
            processed in the payment run.
          type: integer
        totalValueOfUnprocessedDebitMemos:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total amount of debit memos with remaining positive balances
            after the payment run is completed.
          type: string
        totalValueOfUnprocessedInvoices:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total amount of invoices with remaining positive balances after
            the payment run is completed.
          type: string
        totalValueOfUnprocessedReceivables:
          description: >
            The total amount of receivables with remaining positive balances
            after the payment run is completed.
          type: string
      title: totalValues
      type: object
    GETPaymentRunSummaryResponse:
      properties:
        numberOfCreditBalanceAdjustments:
          description: >
            **Note:** This field is only available if you have the Credit
            Balance feature enabled.


            The number of credit balance adjustments that are successfully
            processed in the payment run.
          type: integer
        numberOfCreditMemos:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total number of credit memos that are successfully processed in
            the payment run.
          type: integer
        numberOfDebitMemos:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total number of debit memos that are picked up for processing in
            the payment run.
          type: integer
        numberOfErrorInputData:
          description: |
            The number of input data that are processed with errors.
          type: integer
        numberOfErrors:
          description: |
            The number of payments with the status of `Error` and `Processing`.
          type: integer
        numberOfInputData:
          description: |
            The total number of input data.
          type: integer
        numberOfInvoices:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total number of invoices that are picked up for processing in
            the payment run.
          type: integer
        numberOfPayments:
          description: >
            The number of payments that are successfully processed in the
            payment run.
          type: integer
        numberOfProcessedInputData:
          description: |
            The number of input data that are successfully processed.
          type: integer
        numberOfReceivables:
          description: >
            The total number of receivables that are picked up for processing in
            the payment run.


            The value of this field is the sum of the value of the
            `numberOfInvoices` field and that of the `numberOfDebitMemos` field.
          type: integer
        numberOfUnappliedPayments:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The number of unapplied payments that are successfully processed in
            the payment run.
          type: integer
        numberOfUnprocessedDebitMemos:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The number of debit memos with remaining positive balances after the
            payment run is completed.
          type: integer
        numberOfUnprocessedInvoices:
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The number of invoices with remaining positive balances after the
            payment run is completed.
          type: integer
        numberOfUnprocessedReceivables:
          description: >
            The number of receivables with remaining positive balances after the
            payment run is completed.
          type: integer
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        totalValues:
          description: |
            Container for total values.
          items:
            $ref: '#/components/schemas/GETPaymentRunSummaryTotalValues'
          type: array
      type: object
    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
    POSTRetryPaymentScheduleItemRequest:
      example:
        items:
          - id: 402882e97f24bc36017f2986654f0253
          - id: 402882e97f24bc36017f298665570254
            paymentGatewayId: 402883827d097a28017d09b41f690261
            paymentMethodId: 402882e97f24bc36017f258c2ff20076
      properties:
        items:
          description: |
            The maximum number of items allowable to pass is 10.
          items:
            $ref: '#/components/schemas/POSTRetryPaymentScheduleItemInfo'
          title: Payment schedule items to be retried.
          type: array
      type: object
    LinkedPaymentID:
      properties:
        paymentId:
          description: |
            ID of the payment.
          type: string
      title: PaymentID
      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 <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Payment Schedule Item object.
      title: paymentScheduleItemFieldsCustom
      type: object
    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
              nullable: true
            paymentMethodId:
              description: |
                ID of the payment method of the payment schedule item.
              type: string
              nullable: true
            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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/PaymentScheduleItemCustomFields'
    POSTRetryPaymentScheduleItemResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PaymentScheduleItemCommonResponse'
          type: array
        success:
          description: |
            Returns `true` if the request was processed successfully. 
          type: boolean
      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.         
              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.  
              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
              nullable: true
            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
              nullable: true
            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: '#/components/schemas/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: '#/components/schemas/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. 
              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: '#/components/schemas/PaymentScheduleItemCustomFields'
    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.            
              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
              nullable: true
            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: '#/components/schemas/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: '#/components/schemas/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. 
              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: '#/components/schemas/PaymentScheduleItemCustomFields'
    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.
              nullable: true
              type: string
            cancelledById:
              description: |
                The ID of the user who canceled this payment schedule item.
              nullable: true
              type: string
            cancelledOn:
              description: |
                The date when the payment schedule item was canceled.
              nullable: true
              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
              nullable: true
            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: '#/components/schemas/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: '#/components/schemas/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. 
              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: '#/components/schemas/PaymentScheduleItemCustomFields'
    PUTPaymentScheduleItemRequest:
      example:
        paymentMethodId: 8a90b44890c9bb0d0190d960b9191eea
      allOf:
        - properties:
            amount:
              description: |
                The amount of the payment.
              format: decimal
              type: number
            currency:
              description: >
                The currency of the payment.   


                **Note:**


                - For custom payments, if Multi-currency is enabled, the payment
                currency can be different from the account currency for custom
                payment.


                - For recurring payments, if Multi-currency is enabled, the
                payment currency can be different from the account currency but
                should be the same as billing currency for a recurring 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.
              type: array
              items:
                type: string
            paymentGatewayId:
              description: |
                ID of the payment gateway of the payment schedule item.
              type: string
              nullable: true
            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.


                Here is an example:

                ```

                "paymentOption": [
                  {
                    "type": "GatewayOptions",
                    "detail": {
                      "SecCode":"WEB"
                    }
                  }
                ]

                ```


                `paymentOption` of the payment schedule takes precedence over
                `paymentOption` of the payment schedule item.
              items:
                $ref: '#/components/schemas/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.
              type: array
              items:
                type: string
          type: object
        - $ref: '#/components/schemas/PaymentScheduleItemCustomFields'
    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 <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> 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
    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
            billingDocuments:
              description: >
                Container array of the multiple billing documents associated
                with the payment schedule.
              items:
                allOf:
                  - properties:
                      id:
                        description: |
                          ID of the billing document.
                        type: string
                      number:
                        description: >
                          Number of the billing document. If the billing
                          document is a debit memo, it contains the debit memo
                          number. If the billing document is an invoice, it
                          contains the invoice number.
                        type: string
                      type:
                        description: >
                          Denotes if the billing document is of the type invoice
                          or debit memo.
                        enum:
                          - Invoice
                          - DebitMemo
                        type: string
              type: array
            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: '#/components/schemas/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: '#/components/schemas/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.            
              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: '#/components/schemas/PaymentScheduleCustomFields'
    GETPaymentSchedulesResponse:
      description: |
        Container for payment schedules.
      items:
        $ref: '#/components/schemas/PaymentScheduleCommonResponse'
      type: array
    POSTPaymentScheduleRequest:
      allOf:
        - properties:
            accountId:
              description: >
                ID of the customer account the payment schedule belongs to.


                **Note:**

                `accountId` and `accountNumber` cannot both be `null`. When both
                fields are specified, the two values must match each
                other.          
              type: string
            accountNumber:
              description: >
                Account number of the customer account the payment schedule
                belongs to.


                **Note:**

                `accountId` and `accountNumber` cannot both be `null`. When both
                fields are specified, the two values must match each
                other.          
              type: string
            amount:
              description: >
                The amount of each payment schedule item in the payment
                schedule.


                **Note:**

                - This field is required when `items` is not specified.

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

                - When creating recurring payment schedules, there are 2 options
                to specify amounts:  
                  - Specify `totalAmount` and `occurrences`, `amount` will be calculated.
                  - Specify `amount` and `occurrences`, `totalAmount` will be calculated.
                  You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed.
              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.

                - This field is available only if you are on the latest Zuora
                API version, or you set the `Zuora-Version` request header to
                `330.0` or [a later available
                version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).
              properties:
                id:
                  description: |
                    ID of the billing document.

                    **Note:**
                     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.
                  type: string
                number:
                  description: |
                    Number of the billing document.

                    **Note:**
                     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.
                  type: string
                type:
                  description: |
                    The type of the billing document. 
                  enum:
                    - Invoice
                    - DebitMemo
                  default: Invoice
                  type: string
              required:
                - type
              type: object
            billingDocuments:
              description: >
                Container array of the multiple billing documents associated
                with the payment schedule.


                If multiple billing documents are associated to a payment
                schedule, when collecting the payment schedule item, the payment
                belongs to the payment schedule item will be applied to billing
                documents based on the due date of the billing document, in the
                ascending order.
              items:
                type: object
                properties:
                  id:
                    description: >
                      ID of the billing document.


                      **Note:** 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.
                    type: string
                  number:
                    description: >
                      Number of the billing document. If the billing document is
                      a debit memo, it contains the debit memo number. If the
                      billing document is an invoice, it contains the invoice
                      number.


                      **Note:** 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.
                    type: string
                  type:
                    description: >
                      Denotes if the billing document is of the type invoice or
                      debit memo.
                    enum:
                      - Invoice
                      - DebitMemo
                    type: string
                required:
                  - type
              type: array
            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.

                - For custom payments, if Multi-currency is enabled, the payment
                currency can be different from the account currency for custom
                payment.

                - For recurring payments, if Multi-currency is enabled, the
                payment currency can be different from the account currency but
                should be the same as billing currency for a recurring payment.
              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. 

                          **Note:** You must specify the same billing document
                          for all the payment schedule items in one payment
                          schedule.
                        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.

                          - For custom payments, if Multi-currency is enabled,
                          the payment currency can be different from the account
                          currency for custom payment.

                          - For recurring payments, if Multi-currency is
                          enabled, the payment currency can be different from
                          the account currency but should be the same as billing
                          currency for a recurring payment.
                        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.


                          Here is an example:

                          ```

                          "paymentOption": [
                            {
                              "type": "GatewayOptions",
                              "detail": {
                                "SecCode":"WEB"
                              }
                            }
                          ]

                          ```


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


                          To 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](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
                        items:
                          $ref: >-
                            #/components/schemas/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: '#/components/schemas/PaymentScheduleItemCustomFields'
              type: array
            occurrences:
              description: >
                The number of payment schedule item to be created. Maximum value
                is 1000.


                **Note:**

                - This field is required when `items` is not specified.

                - This field will be ignored when `items` is specified. 
              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.


                **Note:**

                - This field is optional. The default value is the account's
                default payment method ID.

                - This field will be ignored when `items` is specified.  
              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.



                Here is an example:

                ```

                "paymentOption": [
                  {
                    "type": "GatewayOptions",
                    "detail": {
                      "SecCode":"WEB"
                    }
                  }
                ]

                ```


                `paymentOption` of the payment schedule takes precedence over
                `paymentOption` of the payment schedule item.
              items:
                $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields'
              type: array
            paymentScheduleNumber:
              description: >
                You can use this field to specify the number of the payment
                schedule.

                Only characters from the following sets are allowed: A-Z, a-z,
                0-9, and `-`. 

                Payment 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.         
              type: string
            period:
              description: >
                The frequency for the payment collection since the `startDate`.


                **Note:**

                - Thie field is required when `items` is not specified.

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

                - 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. 
              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]`.


                **Note:**

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

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

                - This field is optional. The default value is `0`.

                - This field will be ignored when `items` is
                specified.             
              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.


                **Note**: 

                - This field is only available if the Standalone Payment is
                enabled. Do not include this field if Standalone Payment is not
                enabled.

                - If Standalone Payment is enabled, default value is `true`.
              type: boolean
            startDate:
              description: >
                The date for the first payment collection.


                **Note:**

                - This field is required when `items` is not specified.

                - This field will be ignored when `items` is
                specified.              
              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. 


                **Note**:

                - When creating recurring payment schedules, there are 2 options
                to specify amounts:
                  
                  - Specify `totalAmount` and `occurrences`, `amount` will be calculated.
                  - Specify `amount` and `occurrences`, `totalAmount` will be calculated.
                  
                  You must specify either `totalAmount` or `amount`. Specifying both fields at the same time is not allowed.
                - If the Standalone Payments feature is enabled and `standalone`
                is set to `true` for the payment schedule, `totalAmount` will be
                ignored.
              type: number
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
      example:
        accountId: 8a90b4488e7d5c0f018e7db3892400b2
        amount: 14.99
        billingDocument:
          id: 8a90b44890c9bb0d0190d8c048a90da6
          type: Invoice
        items:
          - scheduledDate: '2024-07-31'
            amount: 14.99
    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
            billingDocuments:
              description: >
                Container array of the multiple billing documents associated
                with the payment schedule.
              items:
                type: object
                properties:
                  id:
                    description: |
                      ID of the billing document.
                    type: string
                  number:
                    description: >
                      Number of the billing document. If the billing document is
                      a debit memo, it contains the debit memo number. If the
                      billing document is an invoice, it contains the invoice
                      number.
                    type: string
                  type:
                    description: >
                      Denotes if the billing document is of the type invoice or
                      debit memo.
                    enum:
                      - Invoice
                      - DebitMemo
                    type: string
              type: array
            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: '#/components/schemas/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: '#/components/schemas/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
              nullable: true
            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
              nullable: true
            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.        
              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: '#/components/schemas/PaymentScheduleCustomFields'
    POSTPaymentSchedulesRequest:
      properties:
        paymentSchedules:
          description: |
            Container of the payment schedules to be created.
          items:
            $ref: '#/components/schemas/POSTPaymentScheduleRequest'
          type: array
      type: object
    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
    POSTPaymentSchedulesResponse:
      description: |
        Container of the payment schedules that are created.
      properties:
        paymentSchedules:
          description: |
            Container for payment parts.
          items:
            $ref: '#/components/schemas/POSTPaymentSchedulesEach'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    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
          nullable: true
        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
    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: '#/components/schemas/PaymentRunStatistic'
          title: PaymentRunStatistic
          type: array
        paymentScheduleItems:
          properties:
            error:
              description: |
                The number of errored payment schedule items.              
              type: integer
            pending:
              description: |
                The number of pending payment schedule items.
              type: integer
            processed:
              description: |
                The number of processed payment schedule items. 
              type: integer
          type: object
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    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
            billingDocuments:
              description: >
                Container array of the multiple billing documents associated
                with the payment schedule.
              items:
                type: object
                properties:
                  id:
                    description: |
                      ID of the billing document.
                    type: string
                  number:
                    description: >
                      Number of the billing document. If the billing document is
                      a debit memo, it contains the debit memo number. If the
                      billing document is an invoice, it contains the invoice
                      number.
                    type: string
                  type:
                    description: >
                      Denotes if the billing document is of the type invoice or
                      debit memo.
                    enum:
                      - Invoice
                      - DebitMemo
                    type: string
              type: array
            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
            cancellationReason:
              description: |
                The reason for the cancellation of the payment schedule item.
              nullable: true
              type: string
            cancelledById:
              description: |
                The ID of the user who canceled this payment schedule.
              type: string
              nullable: true
            cancelledOn:
              description: |
                The date when the payment schedule was canceled.
              type: string
              nullable: true
            cancelDate:
              description: >
                Specifies the effective date by when the payment schedule will
                be canceled.
              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: '#/components/schemas/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: '#/components/schemas/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.        
              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: '#/components/schemas/PaymentScheduleCustomFields'
    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.   

                **Note:**

                - For custom payments, if Multi-currency is enabled, the payment
                currency can be different from the account currency for custom
                payment.

                - For recurring payments, if Multi-currency is enabled, the
                payment currency can be different from the account currency but
                should be the same as billing currency for a recurring payment.
                  
              type: string
            description:
              description: |
                Description of the payment schedule.
              maxLength: 255
              type: string
            occurrences:
              description: >
                Indicates the updated number of payment schedule items that are
                created by the payment schedule.


                **Note:**
                  - If "updated `occurrences` > existing `occurrences`", the following number of pending payment schedule item will be added to the payment schedule: “updated `occurrences` - existing `occurrences`”.
                  - 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`".
                  - If "updated `occurrences` < the number of `processed`/`erroed`/`canceled` payment schedule items", a validation error will be returned.
              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. 
              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.


                Here is an example:

                ```

                "paymentOption": [
                  {
                    "type": "GatewayOptions",
                    "detail": {
                      "SecCode":"WEB"
                    }
                  }
                ]

                ```


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

                 **Note:** To enable this field, submit a request at [Zuora Global Support](https://support.zuora.com/).
              items:
                $ref: '#/components/schemas/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]`.
                  
                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. If the payment
                `runHour` and `scheduledDate` are backdated, the system will
                collect the payment when the next runHour occurs.
              format: date
              type: integer
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
      example:
        description: Details of this payment schedule
    PUTCancelPaymentScheduleRequest:
      properties:
        cancelDate:
          description: >
            Specifies when the payment schedule will be canceled.


            **Note**: If there is no legitimate payment schedule item to cancel,
            the payment schedule cancel operation will be rejected.
          format: date
          type: string
      required:
        - cancelDate
      type: object
    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.

                - For custom payments, if Multi-currency is enabled, the payment
                currency can be different from the account currency for custom
                payment.

                - For recurring payments, if Multi-currency is enabled, the
                payment currency can be different from the account currency but
                should be the same as billing currency for a recurring payment.
              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.


                Here is an example:

                ```

                "paymentOption": [
                  {
                    "type": "GatewayOptions",
                    "detail": {
                      "SecCode":"WEB"
                    }
                  }
                ]

                ```


                `paymentOption` of the payment schedule takes precedence over
                `paymentOption` of the payment schedule item.
              items:
                $ref: '#/components/schemas/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: '#/components/schemas/PaymentScheduleItemCustomFields'
    POSTAddItemsToPaymentScheduleRequest:
      example:
        items:
          - amount: 50
            scheduledDate: '2024-11-22'
      description: >
        Container for the payment schedule items to be added to the payment
        schedule.
      properties:
        items:
          items:
            $ref: '#/components/schemas/PaymentScheduleItemCommon'
          title: paymentScheduleItem
          type: array
      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.      
              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. 
              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.


                Here is an example:

                ```

                "paymentOption": [
                  {
                    "type": "GatewayOptions",
                    "detail": {
                      "SecCode":"WEB"
                    }
                  }
                ]

                ```


                `paymentOption` of the payment schedule takes precedence over
                `paymentOption` of the payment schedule item.
              items:
                $ref: '#/components/schemas/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]`.
                  
                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. If the payment
                `runHour` and `scheduledDate` are backdated, the system will
                collect the payment when the next runHour occurs.
              format: date
              type: integer
          type: object
        - $ref: '#/components/schemas/PaymentScheduleCustomFields'
      example:
        occurrences: 5
    GETRefundTypewithSuccess:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with this refund. Zuora
                associates the refund automatically with the account from the
                associated payment or credit memo.
              type: string
            amount:
              description: |
                The total amount of the refund.
              format: double
              type: number
            cancelledOn:
              description: >
                The date and time when the refund was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            comment:
              description: |
                Comments about the refund.
              type: string
            createdById:
              description: |
                The ID of the Zuora user who created the refund.
              type: string
            createdDate:
              description: >
                The date and time when the refund was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, 2017-03-01 15:31:10.
              format: date-time
              type: string
            creditMemoId:
              description: |
                The ID of the credit memo that is refunded.
              type: string
              nullable: true
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                  nullable: true
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                  nullable: true
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                  nullable: true
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
                  nullable: true
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the refund.
              type: string
              nullable: true
            gatewayReconciliationReason:
              description: |
                The reason of gateway reconciliation.
              type: string
              nullable: true
            gatewayReconciliationStatus:
              description: |
                The status of gateway reconciliation.
              type: string
              nullable: true
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the refund.
                This message is gateway-dependent.
              type: string
              nullable: true
            gatewayResponseCode:
              description: >
                The code returned from the payment gateway for the refund. This
                code is gateway-dependent.
              type: string
              nullable: true
            gatewayState:
              description: |
                The status of the refund in the gateway. 
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: |
                The ID of the refund.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a refund was marked and waiting for batch
                submission to the payment process, in `yyyy-mm-dd hh:mm:ss`
                format.
              format: date-time
              type: string
              nullable: true
            methodType:
              description: |
                How an external refund was issued to a customer. 
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            number:
              description: |
                The unique identification number of the refund.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentId:
              description: |
                The ID of the payment that is refunded.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the refund.
              type: string
              nullable: true
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot, which is a copy of
                the particular payment method used in a transaction.
              type: string
              nullable: true
            payoutId:
              description: |
                The payout ID of the refund from the gateway side.
              type: string
              nullable: true
            reasonCode:
              description: |
                A code identifying the reason for the transaction.
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              type: string
              nullable: true
            refundDate:
              description: >
                The date when the refund takes effect, in `yyyy-mm-dd` format.
                For example, 2017-03-01.
              format: date
              type: string
            refundTransactionTime:
              description: >
                The date and time when the refund was issued, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
              nullable: true
            settledOn:
              description: >
                The date and time when the refund was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
              nullable: true
            softDescriptor:
              description: >
                A payment gateway-specific field that maps Zuora to other
                gateways.
              type: string
              nullable: true
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps Zuora to other
                gateways.
              type: string
              nullable: true
            status:
              description: |
                The status of the refund. 
              enum:
                - Processed
                - Canceled
                - Error
                - Processing
              type: string
            submittedOn:
              description: >
                The date and time when the refund was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
              nullable: true
            type:
              description: |
                The type of the refund. 
              enum:
                - External
                - Electronic
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the refund.
              type: string
            updatedDate:
              description: >
                The date and time when the refund was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
      title: refunds
    GETRefundCollectionType:
      properties:
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        refunds:
          description: |
            Container for refunds.
          items:
            $ref: '#/components/schemas/GETRefundTypewithSuccess'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETRefundType:
      allOf:
        - properties:
            accountId:
              description: >
                The ID of the account associated with this refund. Zuora
                associates the refund automatically with the account from the
                associated payment or credit memo.
              type: string
            amount:
              description: |
                The total amount of the refund.
              format: double
              type: number
            cancelledOn:
              description: >
                The date and time when the refund was cancelled, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            comment:
              description: |
                Comments about the refund.
              type: string
              nullable: true
            createdById:
              description: |
                The ID of the Zuora user who created the refund.
              type: string
            createdDate:
              description: >
                The date and time when the refund was created, in `yyyy-mm-dd
                hh:mm:ss` format. For example, `2017-03-01 15:31:10`.
              format: date-time
              type: string
            creditMemoId:
              description: |
                The ID of the credit memo that is refunded.
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  type: string
                bankAccountAccountingCodeType:
                  description: >
                    The type of the accounting code that maps to a bank account
                    in your accounting system.
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the refund was transferred to an external accounting
                    system. Use this field for integration with accounting
                    systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  type: string
                unappliedPaymentAccountingCodeType:
                  description: |
                    The type of the accounting code for the unapplied payment.
                  type: string
              type: object
            gatewayId:
              description: |
                The ID of the gateway instance that processes the refund.
              type: string
            gatewayReconciliationReason:
              description: |
                The reason of gateway reconciliation.
              type: string
            gatewayReconciliationStatus:
              description: |
                The status of gateway reconciliation.
              type: string
            gatewayResponse:
              description: >
                The message returned from the payment gateway for the refund.
                This message is gateway-dependent.
              type: string
            gatewayResponseCode:
              description: >
                The code returned from the payment gateway for the refund. This
                code is gateway-dependent.
              type: string
            gatewayState:
              description: |
                The status of the refund in the gateway.
              enum:
                - MarkedForSubmission
                - Submitted
                - Settled
                - NotSubmitted
                - FailedToSettle
              type: string
            id:
              description: |
                The ID of the refund.
              type: string
            markedForSubmissionOn:
              description: >
                The date and time when a refund was marked and waiting for batch
                submission to the payment process, in `yyyy-mm-dd hh:mm:ss`
                format. 
              format: date-time
              type: string
            methodType:
              description: |
                How an external refund was issued to a customer. 
              enum:
                - ACH
                - Cash
                - Check
                - CreditCard
                - PayPal
                - WireTransfer
                - DebitCard
                - CreditCardReferenceTransaction
                - BankTransfer
                - Other
              type: string
            number:
              description: |
                The unique identification number of the refund.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            paymentId:
              description: |
                The ID of the payment that is refunded.
              type: string
            paymentMethodId:
              description: >
                The unique ID of the payment method that the customer used to
                make the refund.
              type: string
            paymentMethodSnapshotId:
              description: >
                The unique ID of the payment method snapshot, which is a copy of
                the particular payment method used in a transaction.
              type: string
            payoutId:
              description: |
                The payout ID of the refund from the gateway side.
              type: string
            reasonCode:
              description: |
                A code identifying the reason for the transaction.
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway for an
                electronic refund. Use this field to reconcile refunds between
                your gateway and Zuora Payments.
              type: string
            refundDate:
              description: >
                The date when the refund takes effect, in `yyyy-mm-dd` format.
                For example, `2017-03-01`.
              format: date
              type: string
            refundTransactionTime:
              description: >
                The date and time when the refund was issued, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            secondRefundReferenceId:
              description: >
                The transaction ID returned by the payment gateway if there is
                an additional transaction for the refund. Use this field to
                reconcile payments between your gateway and Zuora Payments.
              type: string
            settledOn:
              description: >
                The date and time when the refund was settled in the payment
                processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used
                by the Spectrum gateway only and not applicable to other
                gateways.
              format: date-time
              type: string
            softDescriptor:
              description: >
                A payment gateway-specific field that maps Zuora to other
                gateways.
              type: string
            softDescriptorPhone:
              description: >
                A payment gateway-specific field that maps Zuora to other
                gateways.
              type: string
            status:
              description: |
                The status of the refund. 
              enum:
                - Processed
                - Canceled
                - Error
                - Processing
              type: string
            submittedOn:
              description: >
                The date and time when the refund was submitted, in `yyyy-mm-dd
                hh:mm:ss` format.
              format: date-time
              type: string
            success:
              description: Returns `true` if the request was processed successfully.
              type: boolean
            type:
              description: |
                The type of the refund. 
              enum:
                - External
                - Electronic
              type: string
            updatedById:
              description: |
                The ID of the Zuora user who last updated the refund.
              type: string
            updatedDate:
              description: >
                The date and time when the refund was last updated, in
                `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
              type: string
              example: '2017-03-02 15:36:10'
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
    PUTRefundType:
      allOf:
        - properties:
            comment:
              description: |
                Comments about the refund.
              maxLength: 255
              minLength: 0
              type: string
            financeInformation:
              description: |
                Container for the finance information related to the refund.
              properties:
                bankAccountAccountingCode:
                  description: >
                    The accounting code that maps to a bank account in your
                    accounting system.
                  maxLength: 100
                  minLength: 0
                  type: string
                transferredToAccounting:
                  description: >
                    Whether the payment was transferred to an external
                    accounting system. Use this field for integration with
                    accounting systems, such as NetSuite. 
                  enum:
                    - Processing
                    - 'Yes'
                    - 'No'
                    - Error
                    - Ignore
                  type: string
                unappliedPaymentAccountingCode:
                  description: |
                    The accounting code for the unapplied payment.
                  maxLength: 100
                  minLength: 0
                  type: string
              type: object
            reasonCode:
              description: >
                A code identifying the reason for the transaction. The value
                must be an existing reason code or empty. If you do not specify
                a value, Zuora uses the default reason code.
              type: string
            referenceId:
              description: >
                The transaction ID returned by the payment gateway. Use this
                field to reconcile refunds between your gateway and Zuora
                Payments.


                You can only update the reference ID for external refunds.
              maxLength: 100
              minLength: 0
              type: string
          type: object
        - $ref: '#/components/schemas/RefundObjectNSFields'
        - $ref: '#/components/schemas/RefundObjectCustomFields'
      example:
        reasonCode: Other
    RefundPartResponseTypewithSuccess:
      properties:
        amount:
          description: |
            The amount of the refund part.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the refund part.
          type: string
        createdDate:
          description: >
            The date and time when the refund part was created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        creditMemoId:
          description: |
            The ID of the credit memo associated with the refund part.
          type: string
        id:
          description: |
            The ID of the refund part.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        paymentId:
          description: |
            The ID of the payment associated with the refund part.
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the refund part.
          type: string
        updatedDate:
          description: >
            The date and time when the refund part was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      title: parts
      type: object
    GETRefundPartCollectionType:
      properties:
        parts:
          description: |
            Container for refund parts.
          items:
            $ref: '#/components/schemas/RefundPartResponseTypewithSuccess'
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    RefundPartResponseType:
      properties:
        amount:
          description: |
            The amount of the refund part.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the refund part.
          type: string
        createdDate:
          description: >
            The date and time when the refund part was created, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        creditMemoId:
          description: |
            The ID of the credit memo associated with the refund part.
          type: string
        id:
          description: |
            The ID of the refund part.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        paymentId:
          description: |
            The ID of the payment associated with the refund part.
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        updatedById:
          description: |
            The ID of the Zuora user who last updated the refund part.
          type: string
        updatedDate:
          description: >
            The date and time when the refund part was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    GETRefundItemPartTypewithSuccess:
      properties:
        amount:
          description: |
            The amount of the refund part item.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the refund part item.
          type: string
        createdDate:
          description: >
            The date and time when the refund part item was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        creditMemoItemId:
          description: |
            The ID of the credit memo item associated with the refund part item.
          type: string
        creditTaxItemId:
          description: >
            The ID of the credit memo taxation item associated with the refund
            part item.
          type: string
        id:
          description: |
            The ID of the refund part item.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        updatedById:
          description: |
            The ID of the Zuora user who last updated the refund part item.
          type: string
        updatedDate:
          description: >
            The date and time when the refund part item was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      title: itemParts
      type: object
    GETRefundItemPartCollectionType:
      properties:
        itemParts:
          description: |
            Container for refund part items.
          items:
            $ref: '#/components/schemas/GETRefundItemPartTypewithSuccess'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETRefundItemPartType:
      properties:
        amount:
          description: |
            The amount of the refund part item.
          format: double
          type: number
        createdById:
          description: |
            The ID of the Zuora user who created the refund part item.
          type: string
        createdDate:
          description: >
            The date and time when the refund part item was created, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.
          format: date-time
          type: string
        creditMemoItemId:
          description: |
            The ID of the credit memo item associated with the refund part item.
          type: string
        creditTaxItemId:
          description: >
            The ID of the credit memo taxation item associated with the refund
            part item.
          type: string
        id:
          description: |
            The ID of the refund part item.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        updatedById:
          description: |
            The ID of the Zuora user who last updated the refund part item.
          type: string
        updatedDate:
          description: >
            The date and time when the refund part item was last updated, in
            `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.
          format: date-time
          type: string
      type: object
    GETCycleElementAttemptResponse:
      type: object
      title: RetryAttempt
      properties:
        attempt_number:
          type: number
          description: |
            The number of the retry attempt.
        zuora_payment_id:
          type: string
          description: |
            The ID of the payment in Zuora Payments.
        time_of_execution:
          type: string
          format: date-time
          description: >
            The date and time when the retry attempt was made, in `yyyy-mm-dd
            hh:mm:ss` format.
        source:
          type: string
          description: |
            The number of the failed payment run.
        cpr_generated:
          type: boolean
          description: >
            Indicates whether the first retry attempt was generated by
            Configurable Payment Retry. 


            `true` for the cases of the first retry attempt generated by CPR and
            the second or later attempt.


            `false` for the cases that the retry attempt was made by the payment
            run or an external source during retry cycles.
        success:
          type: boolean
          description: |
            Indicates whether the retry attempt is successful.
        amount_collected:
          type: number
          description: |
            The amount collected in this retry attempt.
        action_info:
          type: object
          description: |
            Information about the action of the retry attempt.
          properties:
            action:
              type: string
              description: |
                The action taken in the retry attempt.
        retry_info:
          type: object
          description: |
            Information about the next retry attempt.
          properties:
            next:
              type: string
              format: date-time
              description: >
                The date and time of the next retry attempt as determined by
                `criteria`, in `yyyy-mm-dd hh:mm:ss` format.
            criteria:
              type: string
              description: >
                The criteria defined in the retry configuration in the CPR UI,
                to specify whether the next retry will occur in an incremental
                time or at a specific time or day.
        mapping_info:
          type: object
          description: |
            Information about the response code mapping for the retry attempt.
          properties:
            label:
              type: string
              description: >
                The response code label, can be `Hard Decline`, `Soft Decline`,
                `System Error`, or custom labels.
            level:
              type: string
              description: >
                The response code level for the payment gateway, can be `Code`
                or `Description`.
            customer_group_id:
              type: number
              description: |
                The ID of the customer group.
        gateway_info:
          type: object
          description: |
            Information about the payment gateway.
          properties:
            id:
              type: string
              description: |
                The ID of the payment gateway.
            code:
              type: string
              description: |
                The response code from the gateway.
            response:
              type: string
              description: |
                The response message from the gateway.
    GETInvoiceCycleElementResponse:
      type: object
      title: RetryCycle
      properties:
        account_id:
          type: string
          description: |
            The ID of the customer account.
        invoice_id:
          type: string
          description: |
            The ID of the invoice.
        payment_method_id:
          type: string
          description: |
            The ID of the payment method.
        currency:
          type: string
          description: |
            The type of the currency used.
        status:
          type: string
          description: |
            The status of the retry cycle.
        current_attempt_number:
          type: number
          description: |
            The number of the current retry attempt.
        next_attempt:
          type: string
          format: date-time
          description: >
            The date and time of the next retry attempt, in `yyyy-mm-dd
            hh:mm:ss` format.
        customer_group:
          type: string
          description: |
            The name of the customer group.
        attempts:
          type: array
          description: >
            An array containing information of the retry attempts that have been
            made. See the schema and example for details.
          items:
            $ref: '#/components/schemas/GETCycleElementAttemptResponse'
    GETActiveInvoiceCycleResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETInvoiceCycleElementResponse'
          description: >
            An array containing information of all active retry cycles for an
            invoice. See the schema and example for details.
      example:
        cycles:
          - account_id: 2c92c0f96bd69165016bdccdd6ce2f29
            invoice_id: 2c92c0f8778bf8cd017798168cb50e0b
            payment_method_id: 2c92c0f9774f2b3e01775f6f06d87b61
            currency: USD
            status: Cycle Incomplete
            current_attempt_number: 2
            next_attempt: '2021-04-01T19:27:34.648Z'
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c0867849d42301784bc9ca076c21
                time_of_execution: '2021-03-19T18:42:20.103Z'
                source: PR-00000371
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-04-01T19:27:34.648-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
              - attempt_number: 2
                zuora_payment_id: 2c92c09c7849d3c101784bce0d0a06d5
                time_of_execution: '2021-03-19T18:52:24.137Z'
                source: PR-00000372
                cpr_generated: true
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-19T09:53:39.845-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
    GETDebitMemoCycleElementResponse:
      type: object
      title: RetryCycle
      properties:
        account_id:
          type: string
          description: |
            The ID of the customer account.
        debit_memo_id:
          type: string
          description: |
            The ID of the debit memo.
        payment_method_id:
          type: string
          description: |
            The ID of the payment method.
        currency:
          type: string
          description: |
            The type of the currency used.
        status:
          type: string
          description: |
            The status of the retry cycle.
        current_attempt_number:
          type: number
          description: |
            The number of the current retry attempt.
        next_attempt:
          type: string
          format: date-time
          description: >
            The date and time of the next retry attempt, in `yyyy-mm-dd
            hh:mm:ss` format.
        customer_group:
          type: string
          description: |
            The name of the customer group.
        attempts:
          type: array
          description: >
            An array containing information of the retry attempts that have been
            made. See the schema and example for details.
          items:
            $ref: '#/components/schemas/GETCycleElementAttemptResponse'
    GETActiveDebitMemoCycleResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETDebitMemoCycleElementResponse'
          description: >
            An array containing information of all active retry cycles for a
            debit memo. See the schema and example for details.
      example:
        cycles:
          - account_id: 2c92c0f868e161e70168e25eb51d755f
            debit_memo_id: 2c92c0fa7853052701785a38f3bb267f
            payment_method_id: 2c92c0f8774f1afe01775f6e533c4c06
            currency: USD
            status: Cycle Incomplete
            current_attempt_number: 2
            next_attempt: '2021-04-01T10:22:57.464Z'
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c085785305e201785a51af791979
                time_of_execution: '2021-03-23T16:50:18.878Z'
                source: PR-00000376
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-23T07:51:30.380-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
              - attempt_number: 2
                zuora_payment_id: 2c92c0857881cf3e01788ee263b0331c
                time_of_execution: '2021-04-01T19:21:55.207Z'
                source: PR-00000380
                cpr_generated: true
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-04-01T10:22:57.464-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
    GETAccountCycleElementResponse:
      type: object
      title: RetryCycle
      properties:
        account_id:
          type: string
          description: |
            The ID of the customer account.
        invoice_id:
          type: string
          description: |
            The ID of the invoice.
        debit_memo_id:
          type: string
          description: |
            The ID of the debit memo.
        payment_method_id:
          type: string
          description: |
            The ID of the payment method.
        currency:
          type: string
          description: |
            The type of the currency used.
        status:
          type: string
          description: |
            The status of the retry cycle.
        current_attempt_number:
          type: number
          description: |
            The number of the current retry attempt.
        next_attempt:
          type: string
          format: date-time
          description: >
            The date and time of the next retry attempt, in `yyyy-mm-dd
            hh:mm:ss` format.
        customer_group:
          type: string
          description: |
            The name of the customer group.
        attempts:
          type: array
          description: >
            An array containing information of the retry attempts that have been
            made. See the schema and example for details.
          items:
            $ref: '#/components/schemas/GETCycleElementAttemptResponse'
    GETActiveAccountCycleResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETAccountCycleElementResponse'
          description: >
            An array containing information of all active retry cycles for an
            account. See the schema and example for details.
      example:
        cycles:
          - account_id: 2c92c0f96bd69165016bdccdd6ce2f29
            debit_memo_id: 2c92c0fb78532b0001785a38f6427976
            payment_method_id: 2c92c0f9774f2b3e01775f6f06d87b61
            currency: USD
            status: Cycle Incomplete
            current_attempt_number: 1
            next_attempt: '2021-04-01T19:27:34.473Z'
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c085785305e201785a5199a6192d
                time_of_execution: '2021-03-23T16:50:18.878Z'
                source: PR-00000376
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-23T07:51:27.521-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
          - account_id: 2c92c0f96bd69165016bdccdd6ce2f29
            invoice_id: 2c92c0fa7853052701785a38c6622473
            payment_method_id: 2c92c0f9774f2b3e01775f6f06d87b61
            currency: USD
            status: Cycle Incomplete
            current_attempt_number: 1
            next_attempt: '2021-04-01T19:27:34.436Z'
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c085785305e201785a519d85193b
                time_of_execution: '2021-03-23T16:50:18.878Z'
                source: PR-00000376
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-23T07:51:28.161-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
    GETInvoiceCycleHistoryResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETInvoiceCycleElementResponse'
          description: >
            An array containing information of all completed retry cycles for an
            invoice. See the example for details.
      example:
        cycles:
          - account_id: 2c92c0f96bd69165016bdcbf55ad5e62
            invoice_id: 2c92c0fa7849b3ff01784bc5e8ee18b5
            payment_method_id: 2c92c0f9774f2b3e01775f6cf2fb726a
            currency: USD
            status: Cycle Complete
            current_attempt_number: 1
            next_attempt: null
            customer_group: Testing Group
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c0867849d42301784bc9ce806c31
                time_of_execution: '2021-04-01T19:11:21.639Z'
                source: PR-00000370
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Stop
                retry_info: {}
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 5
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
          - account_id: 2c92c0f96bd69165016bdcbf55ad5e62
            invoice_id: 2c92c0fa7849b3ff01784bc5e8ee18b5
            payment_method_id: 2c92c0f9774f2b3e01775f6cf2fb726a
            currency: USD
            status: Cycle Complete
            current_attempt_number: 2
            next_attempt: null
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c0867849d42301784bc9ce806c31
                time_of_execution: '2021-03-19T18:42:20.103Z'
                source: PR-00000371
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-19T09:43:28.670-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
              - attempt_number: 2
                zuora_payment_id: 2c92c09c7849d3c101784bcdfc010671
                time_of_execution: '2021-03-19T18:52:24.137Z'
                source: PR-00000372
                cpr_generated: true
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Stop
                retry_info: {}
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
    GETDebitMemoCycleHistoryResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETDebitMemoCycleElementResponse'
          description: >
            An array containing information of all completed retry cycles for a
            debit memo. See the example for details.
      example:
        cycles:
          - account_id: 2c92c0f868e161e70168e25eb51d755f
            debit_memo_id: 2c92c0fa7853052701785a38f3bb267f
            payment_method_id: 2c92c0f8774f1afe01775f6e533c4c06
            currency: USD
            status: Cycle Complete
            current_attempt_number: 2
            next_attempt: null
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c085785305e201785a51af791979
                time_of_execution: '2021-03-23T16:50:18.878Z'
                source: PR-00000376
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-23T07:51:30.380-09:00'
                  criteria: incremental_time
                  api_updated_retry_time: '2021-03-26T14:27:21.107-04:00'
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
              - attempt_number: 2
                zuora_payment_id: 2c92c0857881cf3e01788ee263b0331c
                time_of_execution: '2021-04-01T19:21:55.207Z'
                source: PR-00000378
                cpr_generated: true
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Stop
                retry_info: {}
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
    GETAccountCycleHistoryResponse:
      type: object
      properties:
        cycles:
          type: array
          items:
            $ref: '#/components/schemas/GETAccountCycleElementResponse'
          description: >
            An array containing information of all completed retry cycles for an
            account. See the example for details.
      example:
        cycles:
          - account_id: 2c92c0f96bd69165016bdcbf55ad5e62
            invoice_id: 2c92c0fa7849b3ff01784bc5e8ee18b5
            payment_method_id: 2c92c0f9774f2b3e01775f6cf2fb726a
            currency: USD
            status: Cycle Complete
            current_attempt_number: 3
            next_attempt: '2021-03-19T18:53:39.641Z'
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c0867849d42301784bc9ce806c31
                time_of_execution: '2021-03-19T18:42:20.103Z'
                source: PR-00000371
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-19T09:43:28.670-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
              - attempt_number: 2
                zuora_payment_id: 2c92c09c7849d3c101784bcdfc010671
                time_of_execution: '2021-03-19T18:52:24.137Z'
                source: PR-00000372
                cpr_generated: true
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Stop
                retry_info: {}
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
          - account_id: 2c92c0f96bd69165016bdcbf55ad5e62
            invoice_id: 2c92c0fb78532b0f01785a38cede190a
            payment_method_id: 2c92c0f9774f2b3e01775f6cf2fb726a
            currency: USD
            status: Cycle Incomplete
            current_attempt_number: 1
            next_attempt: '2021-03-24T19:34:20.254Z'
            customer_group: All Remaining Customers
            attempts:
              - attempt_number: 1
                zuora_payment_id: 2c92c085785305e201785a51aae41969
                time_of_execution: '2021-03-23T16:50:18.878Z'
                source: PR-00000376
                cpr_generated: false
                success: false
                amount_collected: '0.0'
                action_info:
                  action: Retry
                retry_info:
                  next: '2021-03-23T07:51:30.316-09:00'
                  criteria: incremental_time
                mapping_info:
                  label: Hard Decline
                  level: code
                  customer_group_id: 1
                gateway_info:
                  id: 2c92c0f85e2d19af015e3a61d8947e5d
                  code: insufficient_funds
                  response: Your card has insufficient funds.
    GETBaselineMetricsResponse:
      type: object
      properties:
        retry_success_rate:
          type: number
          description: >
            The percentage of successful payment attempts for all customer
            groups on this Configurable Payment Retry instance so far.


            Retry Success Rate = Number of successful retry payment attempts /
            Total number of retry payments attempted


            Payment attempts here are any payment attempts executed by
            Configurable Payment Retry, excluding the initial payment run.
        retry_success_rate_trend:
          type: string
          description: |
            The trend of change in Retry Success Rate over the last 30 days.
        document_success_rate:
          type: number
          description: >
            The percentage of billing documents that are successfully collected,
            for all customer groups on this Configurable Payment Retry instance
            so far.


            Document Success Rate = Number of billing documents collected /
            Total number of billing documents attempted


            Billing documents collected are any invoices and debit memos that
            were paid through the payment attempt initiated by Configurable
            Payment Retry.
        document_success_rate_trend:
          type: string
          description: |
            The trend of change in Document Success Rate over the last 30 days.
        average_days_outstanding:
          type: number
          description: >
            The average number of days invoices and debit memos are unpaid
            before collection, for all customer groups on this Configurable
            Payment Retry instance so far.
        average_days_outstanding_trend:
          type: string
          description: >
            The trend of change in Average Days Outstanding over the last 30
            days.
        success:
          type: boolean
          description: >
            Indicates whether the metrics are retrieved successfully.


            If no data is loaded yet, a 200 response code will be returned with
            the success field set to `true`. All expected fields will be present
            but the value will be `null`.
      example:
        retry_success_rate: '11.90'
        retry_success_rate_trend: down
        document_success_rate: '13.54'
        document_success_rate_trend: neutral
        average_days_outstanding: '4.76'
        average_days_outstanding_trend: up
        success: true
    GETAmountRecoveredResponse:
      type: object
      properties:
        currency:
          type: array
          items:
            type: object
          description: >
            An array containing the following information for each available
            currency.

            If no payment of a given currency has been processed over the last
            30 days, the currency will not appear in the array.
              - The total amount recovered to date
              - The amount recovered over the last 30 days
        success:
          type: boolean
          description: >
            Indicates whether the metrics are retrieved successfully.


            If no data is loaded yet, a 200 response code will be returned with
            the success field set to `true`. All expected fields will be present
            but the value will be `null`.
      example:
        currency:
          USD:
            total_amount: '77515.21'
            last_30_days: '1100.01'
          EUR:
            total_amount: '337.19'
            last_30_days: '17.17'
          CAD:
            total_amount: '123954.10'
            last_30_days: '5132.87'
        success: true
    GETDocumentSuccessRateByCustomerGroupResponse:
      type: object
      properties:
        customer_groups:
          type: array
          items:
            type: object
          description: >
            An array containing the Document Success Rate timeseries for each
            customer group represented by the customer group ID.

            A timeseries over the past 6 months is present in the format of
            `<month_year>: <document_success_rate>`. The data of the current
            month is not included. For example, if it is April 15th today, the
            data for April will not be included. Data for March and earlier will
            be shown.
        success:
          type: boolean
          description: >
            Indicates whether the metrics are retrieved successfully.


            If no data is loaded yet, a 200 response code will be returned with
            the success field set to `true`. All expected fields will be present
            but the value will be `null`.
      example:
        customer_groups:
          '1':
            '05_21': '17.53'
            '04_21': '13.21'
            '03_21': '14.92'
            '02_21': '8.99'
            '01_21': '34.25'
            '12_20': '12.30'
          '2':
            '05_21': '11.11'
            '04_21': '7.87'
            '03_21': '26.00'
            '02_21': '11.06'
            '01_21': '13.43'
            '12_20': '17.92'
          '4':
            '05_21': '11.13'
            '04_21': '9.17'
            '03_21': '17.20'
            '02_21': '19.06'
            '01_21': '12.43'
            '12_20': '15.92'
        success: true
    GETCustomerGroupMetricsResponse:
      type: object
      properties:
        customer_groups:
          type: array
          items:
            type: object
          description: >
            An array containing the following information for each customer
            group.
              - Customer group ID
              - Customer group name
              - Whether Smart Retry is enabled for this customer group
              - Document Success Rate indicating the percentage of billing documents that are successfully collected
              - The trend of change in Document Success Rate over the last 30 days
              - Retry Success Rate indicating the percentage of the successful payment attempts
              - Average Attempts indicating the average number of attempts required to recover funds
        success:
          type: boolean
          description: >
            Indicates whether the metrics are retrieved successfully.


            If no data is loaded yet, a 200 response code will be returned with
            the success field set to `true`. All expected fields will be present
            but the value will be `null`.
      example:
        customer_groups:
          - id: 1
            name: batch22
            smart_retry: false
            document_success_rate: '17.17'
            document_success_rate_trend: up
            retry_success_rate: '21.76'
            average_attempts: '4.11'
          - id: 2
            name: Smart Retry
            smart_retry: true
            document_success_rate: '74.17'
            document_success_rate_trend: down
            retry_success_rate: '81.21'
            average_attempts: '1.32'
          - id: 4
            name: All Remaining Customers
            smart_retry: false
            document_success_rate: '16.35'
            document_success_rate_trend: up
            retry_success_rate: '15.21'
            average_attempts: '3.32'
        success: true
    SummaryStatementRunRequestType:
      type: object
      properties:
        runType:
          description: >
            The scheduled type of the run which can either be AdHoc or
            Scheduled. Currently, only `AdHoc` is supported.
          enum:
            - AdHoc
          type: string
        targetAccountCategory:
          description: >
            Specifies the type of account filter.


            If the filter type is set to `AllAccounts`,
            `AccountsWithOpenInvoices`, `AccountsWithOpenBalances`,
            `AccountsWithoutInvoices`, or
            `AccountsWithoutInvoicesAndOpenBalances`, you can further refine the
            filter using `batchName` and `billCycleDay`. 

            However, these criteria are not applicable when the filter type is
            `SingleAccount`.
          enum:
            - SingleAccount
            - AllAccounts
            - AccountsWithOpenInvoices
            - AccountsWithOpenBalances
            - AccountsWithoutInvoices
            - AccountsWithoutInvoicesAndOpenBalances
          type: string
        accountKey:
          description: >
            The related account ID or account number when the filter type is
            `SingleAccount`.
          nullable: true
          type: string
        batchName:
          description: |
            The batch name used for filtering accounts, for example, Batch1.
          type: string
        billCycleDay:
          description: >
            The bill cycle day for filtering accounts, with values ranging from
            '01' to '31'.
          nullable: true
          type: string
        dateRangeType:
          description: >
            The date range for the statement.


            If `PreviousThreeCalendarMonth` or `PreviousOneCalendarMonth` is
            selected, the start and end dates are automatically calculated.

            For example, if `PreviousThreeCalendarMonth` is chosen today
            (2024-08-20), the dates would be 2024-05-01 to 2024-07-31.
          enum:
            - Custom
            - PreviousThreeCalendarMonth
            - PreviousOneCalendarMonth
          type: string
        startDate:
          description: >
            Required when `Custom` is selected for the date range. The start
            date can be set to a maximum of 5 years in the past and must follow
            the format YYYY-MM-DD.
          format: date
          type: string
        endDate:
          description: >
            When creating a statement run, this field cannot be manually
            entered. If `Custom` is selected, the end date automatically
            defaults to today’s date in the tenant’s timezone.
          format: date
          type: string
        autoEmailEnabled:
          description: >
            Indicates whether to send an email after a statement is generated.
            Acceptable values are `true` or `false`. If unspecified, the default
            value is `false`.
          type: boolean
        description:
          description: |
            A text description of the statement run.
          type: string
      required:
        - runType
        - targetAccountCategory
        - dateRangeType
    SummaryStatementRunResponse:
      properties:
        id:
          description: |
            The unique identifier for the statement run.
          type: string
        statementRunNumber:
          description: |
            The number of the statement run.
          type: string
        runType:
          description: >
            The scheduled type of the run which can either be AdHoc or
            Scheduled. Currently, only `AdHoc` is supported.
          enum:
            - AdHoc
          type: string
        targetAccountCategory:
          description: >
            Specifies the type of account filter. 


            If the filter type is set to `AllAccounts`,
            `AccountsWithOpenInvoices`, `AccountsWithOpenBalances`,
            `AccountsWithoutInvoices`, or
            `AccountsWithoutInvoicesAndOpenBalances`, you can further refine the
            filter using `batchName` and `billCycleDay`. 

            However, these criteria are not applicable when the filter type is
            `SingleAccount`.
          enum:
            - SingleAccount
            - AllAccounts
            - AccountsWithOpenInvoices
            - AccountsWithOpenBalances
            - AccountsWithoutInvoices
            - AccountsWithoutInvoicesAndOpenBalances
          type: string
        accountKey:
          description: >
            When the filter type is `SingleAccount`, this field contains the
            related account ID.
          type: string
          nullable: true
        batchName:
          description: |
            The name of the batch used for filtering accounts.
          type: string
        billCycleDay:
          description: >
            The bill cycle day for filtering accounts, with values ranging from
            '01' to '31'.
          type: string
          nullable: true
        dateRangeType:
          description: |
            The date range for the statement.
          enum:
            - PreviousThreeCalendarMonth
            - PreviousOneCalendarMonth
            - PreviousOneCalendarMonth
          type: string
        startDate:
          description: |
            The start date.
          format: date
          type: string
        endDate:
          description: >
            The end date, which defaults to today’s date when `Custom` is
            selected. This field cannot be manually entered.
          format: date
          type: string
        autoEmailEnabled:
          description: |
            Indicates whether to send an email after a statement is generated. 
          type: boolean
        description:
          description: |
            A text description of the statement run.
          type: string
        status:
          description: |
            The status of the run.
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Terminated
          type: string
        createdById:
          description: |
            The ID of the user who created the statement run.
          type: string
        createdDate:
          description: |
            The date and time the statement run was created.
          type: string
          format: dateTime
        success:
          description: |
            Indicates whether the operation was successful.
          type: boolean
        updatedById:
          description: |
            The ID of the user who last updated the statement run.
          type: string
        updatedDate:
          description: |
            The date the statement run was last updated.
          type: string
          format: dateTime
      type: object
    SegmentConstantValuesCustomFields:
      description: >
        Segment constant values. The field is available only if you have GL
        Segmentation 2.0 enabled.


        This field is additional property.
      title: segmentConstantValues
      type: object
    AccountingCodeObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Accounting Code object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Accounting Code object.
      title: accountingCodeFieldsCustom
      type: object
    GETAccountingCodeItemWithoutSuccessType:
      allOf:
        - properties:
            category:
              description: |
                The category associated with the accounting code.
              enum:
                - Assets
                - Liabilities
                - Equity
                - Revenue
                - Expenses
              type: string
            createdBy:
              description: |
                The ID of the user who created the accounting code.
              type: string
            createdOn:
              description: |
                Date and time when the accounting code was created.
              format: date-time
              type: string
            glAccountName:
              description: |
                Name of the account in your general ledger.

                Field only available if you have Zuora Finance enabled.
              type: string
            glAccountNumber:
              description: |
                Account number in your general ledger.

                Field only available if you have Zuora Finance enabled.
              type: string
            id:
              description: |
                ID of the accounting code.
              type: string
            name:
              description: |
                Name of the accounting code.
              type: string
            notes:
              description: |
                Any optional notes for the accounting code.
              type: string
            status:
              description: |
                The accounting code status.
              enum:
                - Active
                - Inactive
              type: string
            type:
              description: >
                Accounting code type. 


                Note that `On-Account Receivable` is only available if you
                enable the Invoice Settlement feature. 
              enum:
                - AccountsReceivable
                - On-Account Receivable
                - Cash
                - OtherAssets
                - CustomerCashOnAccount
                - DeferredRevenue
                - SalesTaxPayable
                - OtherLiabilities
                - SalesRevenue
                - SalesDiscounts
                - OtherRevenue
                - OtherEquity
                - BadDebt
                - OtherExpenses
              type: string
            updatedBy:
              description: |
                The ID of the user who last updated the accounting code.
              type: string
            updatedOn:
              description: |
                Date and time when the accounting code was last updated.
              format: date-time
              type: string
            segmentConstantValues:
              $ref: '#/components/schemas/SegmentConstantValuesCustomFields'
          type: object
        - $ref: '#/components/schemas/AccountingCodeObjectCustomFields'
      title: accountingCodes
    GETAccountingCodesType:
      properties:
        accountingCodes:
          description: >
            An array of all the accounting codes in your chart of accounts. Each
            accounting code has the following fields.
          items:
            $ref: '#/components/schemas/GETAccountingCodeItemWithoutSuccessType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTAccountingCodeType:
      allOf:
        - properties:
            glAccountName:
              description: >
                Name of the account in your general ledger.


                Field only available if you have Zuora Finance enabled. Maximum
                of 255 characters.
              type: string
            glAccountNumber:
              description: >
                Account number in your general ledger.


                Field only available if you have Zuora Finance enabled. Maximum
                of 255 characters.
              type: string
            name:
              description: |
                Name of the accounting code.

                Accounting code name must be unique. Maximum of 100 characters.
              type: string
            notes:
              description: |
                Maximum of 2,000 characters.
              type: string
            type:
              description: >
                If you want to create multiple accounting codes of the type
                `AccountsReceivable`, you need to have [Invoice Item
                Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement)
                enabled and contact [Zuora Global
                Support](http://support.zuora.com) to access the Multiple AR
                Accounting Codes feature. 


                Note that `On-Account Receivable` is only available if you
                enable the Invoice Settlement feature. 
              enum:
                - AccountsReceivable
                - On-Account Receivable
                - Cash
                - OtherAssets
                - CustomerCashOnAccount
                - DeferredRevenue
                - SalesTaxPayable
                - OtherLiabilities
                - SalesRevenue
                - SalesDiscounts
                - OtherRevenue
                - OtherEquity
                - BadDebt
                - OtherExpenses
              type: string
            segmentConstantValues:
              $ref: '#/components/schemas/SegmentConstantValuesCustomFields'
          required:
            - name
            - type
          type: object
        - $ref: '#/components/schemas/AccountingCodeObjectCustomFields'
      example:
        name: CASH
        type: Cash
    POSTAccountingCodeResponseType:
      properties:
        id:
          description: |
            ID of the newly created accounting code.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETAccountingCodeItemType:
      allOf:
        - properties:
            category:
              description: |
                The category associated with the accounting code.
              enum:
                - Assets
                - Liabilities
                - Equity
                - Revenue
                - Expenses
              type: string
            createdBy:
              description: |
                The ID of the user who created the accounting code.
              type: string
            createdOn:
              description: |
                Date and time when the accounting code was created.
              format: date-time
              type: string
            glAccountName:
              description: |
                Name of the account in your general ledger.

                Field only available if you have Zuora Finance enabled.
              type: string
            glAccountNumber:
              description: |
                Account number in your general ledger.

                Field only available if you have Zuora Finance enabled.
              type: string
            id:
              description: |
                ID of the accounting code.
              type: string
            name:
              description: |
                Name of the accounting code.
              type: string
            notes:
              description: |
                Any optional notes for the accounting code.
              type: string
            status:
              description: |
                The accounting code status.
              enum:
                - Active
                - Inactive
              type: string
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
            type:
              description: >
                Accounting code type. 


                Note that `On-Account Receivable` is only available if you
                enable the Invoice Settlement feature. 
              enum:
                - AccountsReceivable
                - On-Account Receivable
                - Cash
                - OtherAssets
                - CustomerCashOnAccount
                - DeferredRevenue
                - SalesTaxPayable
                - OtherLiabilities
                - SalesRevenue
                - SalesDiscounts
                - OtherRevenue
                - OtherEquity
                - BadDebt
                - OtherExpenses
              type: string
            updatedBy:
              description: |
                The ID of the user who last updated the accounting code.
              type: string
            updatedOn:
              description: |
                Date and time when the accounting code was last updated.
              format: date-time
              type: string
            segmentConstantValues:
              $ref: '#/components/schemas/SegmentConstantValuesCustomFields'
          type: object
        - $ref: '#/components/schemas/AccountingCodeObjectCustomFields'
    PUTAccountingCodeType:
      allOf:
        - properties:
            glAccountName:
              description: >
                Name of the account in your general ledger.


                Field only available if you have Zuora Finance enabled. Maximum
                of 255 characters.
              type: string
            glAccountNumber:
              description: >
                Account number in your general ledger.


                Field only available if you have Zuora Finance enabled. Maximum
                of 255 characters.
              type: string
            name:
              description: |
                Name of the accounting code.

                Accounting code name must be unique. Maximum of 100 characters.
              type: string
            notes:
              description: |
                Maximum of 2,000 characters.
              type: string
            type:
              description: >
                Accounting code type. You cannot change the type of an
                accounting code from `AccountsReceivable` to a different type. 


                Note that `On-Account Receivable` is only available if you
                enable the Invoice Settlement feature. 
              enum:
                - AccountsReceivable
                - On-Account Receivable
                - Cash
                - OtherAssets
                - CustomerCashOnAccount
                - DeferredRevenue
                - SalesTaxPayable
                - OtherLiabilities
                - SalesRevenue
                - SalesDiscounts
                - OtherRevenue
                - OtherEquity
                - BadDebt
                - OtherExpenses
              type: string
            segmentConstantValues:
              $ref: '#/components/schemas/SegmentConstantValuesCustomFields'
          type: object
        - $ref: '#/components/schemas/AccountingCodeObjectCustomFields'
      example:
        notes: Details of the accounting code
    AccountingPeriodObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Accounting Period object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of an Accounting Period object.
      title: accountingPeriodFieldsCustom
      type: object
    GETAccountingPeriodWithoutSuccessType:
      allOf:
        - properties:
            createdBy:
              description: |
                ID of the user who created the accounting period.
              type: string
            createdOn:
              description: |
                Date and time when the accounting period was created.
              format: date-time
              type: string
            endDate:
              description: |
                The end date of the accounting period.
              format: date
              type: string
            fileIds:
              description: >
                File IDs of the reports available for the accounting period. You
                can retrieve the reports by specifying the file ID in a [Get
                Files](https://developer.zuora.com/api-references/api/operation/GET_Files)
                REST API call.
              properties:
                accountsReceivableAccountAgingDetailExportFileId:
                  description: >
                    File ID of the Accounts Receivable Aging Account Detail
                    report.
                  type: string
                accountsReceivableInvoiceAgingDetailExportFileId:
                  description: >
                    File ID of the Accounts Receivable Aging Invoice Detail
                    report.
                  type: string
                arRollForwardDetailExportFileId:
                  description: |
                    File ID of the Accounts Receivable Detail report.
                  type: string
                fxRealizedGainAndLossDetailExportFileId:
                  description: >
                    File ID of the Realized Gain and Loss Detail report.


                    Returned only if you have Foreign Currency Conversion
                    enabled.
                  type: string
                fxUnrealizedGainAndLossDetailExportFileId:
                  description: >
                    File ID of the Unrealized Gain and Loss Detail report.


                    Returned only if you have Foreign Currency Conversion
                    enabled
                  type: string
                revenueDetailCsvFileId:
                  description: |
                    File ID of the Revenue Detail report in CSV format.
                  type: string
                revenueDetailExcelFileId:
                  description: |
                    File ID of the Revenue Detail report in XLSX format.
                  type: string
                unprocessedChargesFileId:
                  description: >
                    File ID of a report containing all unprocessed charges for
                    the accounting period.
                  type: string
              type: object
            fiscalYear:
              description: |
                Fiscal year of the accounting period.
              type: integer
            fiscalQuarter:
              description: Fiscal quarter of the accounting period.
              type: integer
            id:
              description: |
                ID of the accounting period.
              type: string
            name:
              description: |
                Name of the accounting period.
              type: string
            notes:
              description: |
                Any optional notes about the accounting period.
              type: string
            organizationLabels:
              description: >
                The organization(s) that the object belongs to. 


                Note: This field is available only when the Multi-Org feature is
                enabled.            
              items:
                properties:
                  organizationId:
                    description: |
                      The organization ID.
                    type: string
                  organizationName:
                    description: |
                      The organization name.
                    type: string
                type: object
              type: array
            runTrialBalanceEnd:
              description: >
                Date and time that the trial balance was completed. If the trial
                balance status is `Pending`, `Processing`, or `Error`, this
                field is `null`.
              format: date-time
              type: string
            runTrialBalanceErrorMessage:
              description: >
                If trial balance status is Error, an error message is returned
                in this field.
              type: string
            runTrialBalanceStart:
              description: >
                Date and time that the trial balance was run. If the trial
                balance status is `Pending`, this field is `null`.
              format: date-time
              type: string
            runTrialBalanceStatus:
              description: >
                Status of the trial balance for the accounting period. Possible
                values:


                * `Pending`

                * `Processing`

                * `Completed`

                * `Error`
              type: string
            startDate:
              description: |
                The start date of the accounting period.
              format: date
              type: string
            status:
              description: |
                Status of the accounting period. Possible values:

                * `Open`
                * `PendingClose`
                * `Closed`
              type: string
            updatedBy:
              description: |
                D of the user who last updated the accounting period.
              type: string
            updatedOn:
              description: |
                Date and time when the accounting period was last updated.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields'
      title: accountingPeriods
    GETAccountingPeriodsType:
      properties:
        accountingPeriods:
          description: >
            An array of all accounting periods on your tenant. The accounting
            periods are returned in ascending order of start date; that is, the
            latest period is returned first.
          items:
            $ref: '#/components/schemas/GETAccountingPeriodWithoutSuccessType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTAccountingPeriodType:
      allOf:
        - properties:
            endDate:
              description: >
                The end date of the accounting period in yyyy-mm-dd format, for
                example, "2016-02-19".
              format: date
              type: string
            fiscalYear:
              description: >
                Fiscal year of the accounting period in yyyy format, for
                example, "2016".
              type: integer
            fiscalQuarter:
              description: >-
                Fiscal quarter of the accounting period. One number between 1
                and 4.
              type: integer
              minimum: 1
              maximum: 4
            name:
              description: >
                Name of the accounting period.


                Accounting period name must be unique. Maximum of 100
                characters.
              type: string
            notes:
              description: |
                Notes about the accounting period.

                Maximum of 255 characters.
              type: string
            organizationLabels:
              description: >
                The organization that the accounting period belongs to. 


                For each item in the array, either the `organizationId` or the
                `organizationName` field is required.


                This field is only required when you have already turned on
                Multi-Org feature.
              items:
                properties:
                  organizationId:
                    description: |
                      The organization ID.
                    type: string
                  organizationName:
                    description: |
                      The organization name.
                    type: string
                type: object
              type: array
            startDate:
              description: >
                The start date of the accounting period in yyyy-mm-dd format,
                for example, "2016-02-19".
              format: date
              type: string
          required:
            - name
            - startDate
            - endDate
            - fiscalYear
          type: object
        - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields'
      example:
        name: Jun 2016
        fiscalYear: 2016
        startDate: '2016-06-01'
        endDate: '2016-06-30'
    POSTAccountingPeriodResponseType:
      properties:
        id:
          description: |
            ID of the newly-created accounting period.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETAccountingPeriodType:
      allOf:
        - properties:
            createdBy:
              description: |
                ID of the user who created the accounting period.
              type: string
            createdOn:
              description: |
                Date and time when the accounting period was created.
              format: date-time
              type: string
            endDate:
              description: |
                The end date of the accounting period.
              format: date
              type: string
            fileIds:
              description: >
                File IDs of the reports available for the accounting period. You
                can retrieve the reports by specifying the file ID in a [Get
                Files](https://developer.zuora.com/api-references/api/operation/GET_Files)
                REST API call.
              properties:
                accountsReceivableAccountAgingDetailExportFileId:
                  description: >
                    File ID of the Accounts Receivable Aging Account Detail
                    report.
                  type: string
                accountsReceivableInvoiceAgingDetailExportFileId:
                  description: >
                    File ID of the Accounts Receivable Aging Invoice Detail
                    report.
                  type: string
                accountsReceivableDebitMemoAgingDetailExportFileId:
                  description: >
                    File ID of the Accounts Receivable Aging Debit Memo Detail
                    report.
                  type: string
                arRollForwardDetailExportFileId:
                  description: |
                    File ID of the Accounts Receivable Detail report.
                  type: string
                fxRealizedGainAndLossDetailExportFileId:
                  description: >
                    File ID of the Realized Gain and Loss Detail report.


                    Returned only if you have Foreign Currency Conversion
                    enabled.
                  type: string
                fxUnrealizedGainAndLossDetailExportFileId:
                  description: >
                    File ID of the Unrealized Gain and Loss Detail report.


                    Returned only if you have Foreign Currency Conversion
                    enabled
                  type: string
                revenueDetailCsvFileId:
                  description: |
                    File ID of the Revenue Detail report in CSV format.
                  type: string
                revenueDetailExcelFileId:
                  description: |
                    File ID of the Revenue Detail report in XLSX format.
                  type: string
                unprocessedChargesFileId:
                  description: >
                    File ID of a report containing all unprocessed charges for
                    the accounting period.
                  type: string
              type: object
            fiscalYear:
              description: |
                Fiscal year of the accounting period.
              type: integer
            fiscalQuarter:
              description: Fiscal quarter of the accounting period.
              type: integer
            id:
              description: |
                ID of the accounting period.
              type: string
            name:
              description: |
                Name of the accounting period.
              type: string
            notes:
              description: |
                Any optional notes about the accounting period.
              type: string
            organizationLabels:
              description: >
                The organization(s) that the object belongs to. 


                Note: This field is available only when the Multi-Org feature is
                enabled.            
              items:
                properties:
                  organizationId:
                    description: |
                      The organization ID.
                    type: string
                  organizationName:
                    description: |
                      The organization name.
                    type: string
                type: object
              type: array
            runTrialBalanceEnd:
              description: >
                Date and time that the trial balance was completed. If the trial
                balance status is `Pending`, `Processing`, or `Error`, this
                field is `null`.
              format: date-time
              type: string
            runTrialBalanceErrorMessage:
              description: >
                If trial balance status is Error, an error message is returned
                in this field.
              type: string
            runTrialBalanceStart:
              description: >
                Date and time that the trial balance was run. If the trial
                balance status is Pending, this field is null.
              format: date-time
              type: string
            runTrialBalanceStatus:
              description: >
                Status of the trial balance for the accounting period. Possible
                values:


                * `Pending`

                * `Processing`

                * `Completed`

                * `Error`
              type: string
            startDate:
              description: |
                The start date of the accounting period.
              format: date
              type: string
            status:
              description: |
                Status of the accounting period. Possible values:
                * `Open`
                * `PendingClose`
                * `Closed`
              type: string
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
            updatedBy:
              description: |
                ID of the user who last updated the accounting period.
              type: string
            updatedOn:
              description: |
                Date and time when the accounting period was last updated.
              format: date-time
              type: string
          type: object
        - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields'
    PUTAccountingPeriodType:
      allOf:
        - properties:
            endDate:
              description: >
                The end date of the accounting period in yyyy-mm-dd format, for
                example, "2016-02-19".
              format: date
              type: string
            fiscalYear:
              description: >
                Fiscal year of the accounting period in yyyy format, for
                example, "2016".
              type: integer
            fiscalQuarter:
              description: >-
                Fiscal quarter of the accounting period. One number between 1
                and 4.
              type: integer
              minimum: 1
              maximum: 4
            name:
              description: >
                Name of the accounting period.


                Accounting period name must be unique. Maximum of 100
                characters.
              type: string
            notes:
              description: |
                Notes about the accounting period.

                Maximum of 255 characters.
              type: string
            startDate:
              description: >
                The start date of the accounting period in yyyy-mm-dd format,
                for example, "2016-02-19".
              format: date
              type: string
          type: object
        - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields'
      example:
        notes: Details of the accounting period
    JournalEntryItemObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Journal Entry Item object. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Journal Entry Item object.
      title: journalEntryItemFieldsCustom
      type: object
    POSTJournalEntryItemType:
      allOf:
        - properties:
            accountingCodeName:
              description: |
                Name of the accounting code.
              type: string
            accountingCodeType:
              description: >
                Accounting code type. This field is required if
                `accountingCodeName` is not unique.


                Note that `On-Account Receivable` is only available if you
                enable the Invoice Settlement feature. 
              enum:
                - AccountsReceivable
                - On-Account Receivable
                - Cash
                - OtherAssets
                - CustomerCashOnAccount
                - DeferredRevenue
                - SalesTaxPayable
                - OtherLiabilities
                - SalesRevenue
                - SalesDiscounts
                - OtherRevenue
                - OtherEquity
                - BadDebt
                - OtherExpenses
              type: string
            amount:
              description: |
                Journal entry item amount in transaction currency.
              format: decimal
              type: string
            homeCurrencyAmount:
              description: >
                Journal entry item amount in home currency.


                This field is required if you have set your home currency for
                foreign currency conversion. Otherwise, do not pass this field.
              format: decimal
              type: string
            type:
              description: 'Type of journal entry item. '
              enum:
                - Credit
                - Debit
              type: string
          required:
            - accountingCodeName
            - type
            - amount
          type: object
        - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields'
      title: journalEntryItems
    POSTJournalEntrySegmentType:
      properties:
        segmentName:
          description: >-
            Name of segment. You must use the segment name that has already been
            specified in the default segment rule. In addition, segments need to
            be passed in the order where they were defined in the segmentation
            rule. If multiple segments are configured in the default rule, you
            need to specify all of them in order. 
          type: string
        segmentValue:
          description: |
            Value of segment in this summary journal entry.
          type: string
      required:
        - segmentName
        - segmentValue
      title: segments
      type: object
    JournalEntryObjectCustomFields:
      additionalProperties:
        description: >
          Custom fields of the Journal Entry object. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      description: |
        Container for custom fields of a Journal Entry object.
      title: journalEntryFieldsCustom
      type: object
    POSTJournalEntryType:
      allOf:
        - properties:
            accountingPeriodName:
              description: >
                Name of the accounting period. The open-ended accounting period
                is named `Open-Ended`.
              type: string
            currency:
              description: |
                The type of currency used. Currency must be active.
              type: string
            journalEntryDate:
              description: |
                Date of the journal entry.
              format: date
              type: string
            journalEntryItems:
              description: |
                Key name that represents the list of journal entry items.
              items:
                $ref: '#/components/schemas/POSTJournalEntryItemType'
              type: array
            notes:
              description: |
                The number associated with the revenue event.

                Character limit: 2,000
              type: string
            organizationLabel:
              description: >
                Name of the organization that the journal entry belongs to.  


                This field is only required when you have already turned on
                Multi-Org feature.    
              type: string
            segments:
              description: |
                List of segments that apply to the summary journal entry.
              items:
                $ref: '#/components/schemas/POSTJournalEntrySegmentType'
              type: array
            transferredToAccounting:
              description: >
                Status shows whether the journal entry has been transferred to
                an accounting system.
              enum:
                - 'No'
                - Processing
                - 'Yes'
                - Error
                - Ignore
              type: string
          required:
            - journalEntryDate
            - accountingPeriodName
            - currency
            - journalEntryItems
          type: object
        - $ref: '#/components/schemas/JournalEntryObjectCustomFields'
      example:
        accountingPeriodName: 2020/02
        currency: USD
        journalEntryDate: '2020-01-20'
        journalEntryItems:
          - accountingCodeName: Accounts Receivable
            amount: 400.9
            homeCurrencyAmount: 400.9
            type: Credit
          - accountingCodeName: Subscription Revenue
            amount: 400.9
            homeCurrencyAmount: 400.9
            type: Debit
    POSTJournalEntryResponseType:
      properties:
        journalEntryNumber:
          description: |
            Journal entry number in the format JE-00000001.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETJournalEntryItemType:
      allOf:
        - properties:
            accountingCodeName:
              description: |
                Name of the accounting code.
              type: string
            accountingCodeType:
              description: >
                Accounting code type.


                Note that `On-Account Receivable` is only available if you
                enable the Invoice Settlement feature. 
              enum:
                - AccountsReceivable
                - On-Account Receivable
                - Cash
                - OtherAssets
                - CustomerCashOnAccount
                - DeferredRevenue
                - SalesTaxPayable
                - OtherLiabilities
                - SalesRevenue
                - SalesDiscounts
                - OtherRevenue
                - OtherEquity
                - BadDebt
                - OtherExpenses
              type: string
            amount:
              description: |
                Journal entry item amount in transaction currency.
              format: decimal
              type: string
            glAccountName:
              description: >
                The account number in the general ledger (GL) that corresponds
                to the accounting code.
              type: string
            glAccountNumber:
              description: >
                The account name in the general ledger (GL) that corresponds to
                the accounting code.
              type: string
            homeCurrencyAmount:
              description: |
                Journal entry item amount in home currency.
              format: decimal
              type: string
            type:
              description: 'Type of journal entry item. '
              enum:
                - Credit
                - Debit
              type: string
          type: object
        - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields'
      title: journalEntryItems
    GETJournalEntrySegmentType:
      properties:
        segmentName:
          description: |
            Name of segment.
          type: string
        segmentValue:
          description: |
            Value of segment in this summary journal entry.
          type: string
      title: segments
      type: object
    GETJournalEntryDetailTypeWithoutSuccess:
      allOf:
        - properties:
            accountingPeriodName:
              description: |
                Name of the accounting period that the journal entry belongs to.
              type: string
            aggregateCurrency:
              description: >
                Returns true if the journal entry is aggregating currencies.
                That is, if the journal entry was created when the `Aggregate
                transactions with different currencies during a JournalRun`
                setting was configured to "Yes". Otherwise, returns `false`.
              type: boolean
            currency:
              description: |
                Currency used.
              type: string
            homeCurrency:
              description: |
                Home currency used.
              type: string
            journalEntryDate:
              description: |
                Date of the journal entry.
              format: date
              type: string
            journalEntryItems:
              description: |
                Key name that represents the list of journal entry items.
              items:
                $ref: '#/components/schemas/GETJournalEntryItemType'
              type: array
            notes:
              description: |
                Additional information about this record.
                Character limit: 2,000
              type: string
            number:
              description: |
                Journal entry number in the format JE-00000001.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            segments:
              description: |
                List of segments that apply to the summary journal entry.
              items:
                $ref: '#/components/schemas/GETJournalEntrySegmentType'
              type: array
            status:
              description: 'Status of journal entry. '
              enum:
                - Created
                - Cancelled
              type: string
            timePeriodEnd:
              description: |
                End date of time period included in the journal entry.
              format: date
              type: string
            timePeriodStart:
              description: |
                Start date of time period included in the journal entry.
              format: date
              type: string
            transactionType:
              description: >
                Transaction type of the transactions included in the summary
                journal entry.
              type: string
            transferDateTime:
              description: >
                Date and time that transferredToAccounting was changed to `Yes`.
                This field is returned only when transferredToAccounting is
                `Yes`. Otherwise, this field is `null`.
              format: date-time
              type: string
            transferredBy:
              description: >
                User ID of the person who changed transferredToAccounting to
                `Yes`. This field is returned only when transferredToAccounting
                is `Yes`. Otherwise, this field is `null`.
              type: string
            transferredToAccounting:
              description: >-
                Status shows whether the journal entry has been transferred to
                an accounting system. 
              enum:
                - 'No'
                - Processing
                - 'Yes'
                - Error
                - Ignore
              type: string
          type: object
        - $ref: '#/components/schemas/JournalEntryObjectCustomFields'
      title: journalEntries
    GETJournalEntriesInJournalRunType:
      properties:
        journalEntries:
          description: |
            Key name that represents the list of journal entries.
          items:
            $ref: '#/components/schemas/GETJournalEntryDetailTypeWithoutSuccess'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETJournalEntryDetailType:
      allOf:
        - properties:
            accountingPeriodName:
              description: |
                Name of the accounting period that the journal entry belongs to.
              type: string
            aggregateCurrency:
              description: >
                Returns true if the journal entry is aggregating currencies.
                That is, if the journal entry was created when the `Aggregate
                transactions with different currencies during a Journal Run`
                setting was configured to `Yes`. Otherwise, returns `false`.
              type: boolean
            currency:
              description: |
                Currency used.
              type: string
            homeCurrency:
              description: |
                Home currency used.
              type: string
            journalEntryDate:
              description: |
                Date of the journal entry.
              format: date
              type: string
            journalEntryItems:
              description: |
                Key name that represents the list of journal entry items.
              items:
                $ref: '#/components/schemas/GETJournalEntryItemType'
              type: array
            notes:
              description: |

                Additional information about this record.
                Character limit: 2,000
              type: string
            number:
              description: |
                Journal entry number in the format JE-00000001.
              type: string
            organizationLabel:
              description: >
                The organization that this object belongs to.


                Note: This field is available only when the Multi-Org feature is
                enabled.
              type: string
            segments:
              description: |
                List of segments that apply to the summary journal entry.
              items:
                $ref: '#/components/schemas/GETJournalEntrySegmentType'
              type: array
            status:
              description: |
                Status of journal entry.
              enum:
                - Created
                - Cancelled
              type: string
            success:
              description: |
                Returns `true` if the request was processed successfully.
              type: boolean
            timePeriodEnd:
              description: |
                End date of time period included in the journal entry.
              format: date
              type: string
            timePeriodStart:
              description: |
                Start date of time period included in the journal entry.
              format: date
              type: string
            transactionType:
              description: >
                Transaction type of the transactions included in the summary
                journal entry.
              type: string
            transferDateTime:
              description: >
                Date and time that transferredToAccounting was changed to `Yes`.
                This field is returned only when transferredToAccounting is
                `Yes`. Otherwise, this field is `null`.
              format: date-time
              type: string
            transferredBy:
              description: >
                User ID of the person who changed transferredToAccounting to
                `Yes`. This field is returned only when transferredToAccounting
                is `Yes`. Otherwise, this field is `null`.
              type: string
            transferredToAccounting:
              description: >-
                Status shows whether the journal entry has been transferred to
                an accounting system. 
              enum:
                - 'No'
                - Processing
                - 'Yes'
                - Error
                - Ignore
              type: string
          type: object
        - $ref: '#/components/schemas/JournalEntryObjectCustomFields'
    PUTJournalEntryItemType:
      allOf:
        - properties:
            accountingCodeName:
              description: >
                Name of the accounting code.


                If the Journal Entry Item has a blank accounting code, enter the
                empty string.
              type: string
            accountingCodeType:
              description: >
                Accounting code type.


                Note that `On-Account Receivable` is only available if you
                enable the Invoice Settlement feature. 
              enum:
                - AccountsReceivable
                - On-Account Receivable
                - Cash
                - OtherAssets
                - CustomerCashOnAccount
                - DeferredRevenue
                - SalesTaxPayable
                - OtherLiabilities
                - SalesRevenue
                - SalesDiscounts
                - OtherRevenue
                - OtherEquity
                - BadDebt
                - OtherExpenses
              type: string
            type:
              description: 'Type of journal entry item. '
              enum:
                - Credit
                - Debit
              type: string
          required:
            - accountingCodeName
            - type
          type: object
        - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields'
      title: journalEntryItems
    PUTBasicSummaryJournalEntryType:
      allOf:
        - properties:
            journalEntryItems:
              description: |
                Key name that represents the list of journal entry items.
              items:
                $ref: '#/components/schemas/PUTJournalEntryItemType'
              type: array
            notes:
              description: |
                Additional information about this record.

                ***Character limit:*** 2,000
              type: string
            transferredToAccounting:
              description: >
                Status shows whether the journal entry has been transferred to
                an accounting system. 


                This field cannot be changed after the summary journal entry has
                been canceled.


                **Note:** The Zuora Finance ***Override Transferred to
                Accounting*** permission is required to change
                `transferredToAccounting` from `Yes` to any other value.
              enum:
                - 'No'
                - Processing
                - 'Yes'
                - Error
                - Ignore
              type: string
          type: object
        - $ref: '#/components/schemas/JournalEntryObjectCustomFields'
      example:
        transferredToAccounting: 'Yes'
    POSTJournalRunTransactionType:
      properties:
        type:
          description: >
            Transaction type. Invoice Adjustment is deprecated on Production.
            Zuora recommends that you use the Invoice Item Adjustment instead.


            If you enable the Invoice Settlement feature, Debit Memo Item,
            Credit Memo Item, and Credit Memo Application Item are available,
            Payment and Refund will be replaced by Payment Application and
            Refund Application. 


            If you enable both the Invoice Settlement feature and the Invoice
            Item Settlement feature, Payment and Refund will be replaced by
            Payment Application Item and Refund Application Item. 
          enum:
            - Invoice Item
            - Taxation Item
            - Invoice Item Adjustment (Invoice)
            - Invoice Item Adjustment (Tax)
            - Invoice Adjustment
            - Electronic Payment
            - External Payment
            - Electronic Refund
            - External Refund
            - Electronic Credit Balance Payment
            - External Credit Balance Payment
            - Electronic Credit Balance Refund
            - External Credit Balance Refund
            - Credit Balance Adjustment (Applied from Credit Balance)
            - Credit Balance Adjustment (Transferred to Credit Balance)
            - Revenue Event Item
            - Debit Memo Item (Charge)
            - Debit Memo Item (Tax)
            - Credit Memo Item (Charge)
            - Credit Memo Item (Tax)
            - Credit Memo Application Item
            - Electronic Payment Application
            - External Payment Application
            - Electronic Refund Application
            - External Refund Application
            - Electronic Payment Application Item
            - External Payment Application Item
            - Electronic Refund Application Item
            - External Refund Application Item
          type: string
      required:
        - type
      title: transactionTypes
      type: object
    POSTJournalRunType:
      example:
        accountingPeriodName: Nov-2014
        journalEntryDate: '2014-11-04'
        transactionTypes:
          - type: Invoice Item
          - type: Revenue Event Item
      properties:
        accountingPeriodName:
          description: >
            Name of the accounting period.


            This field determines the target start and end dates of the journal
            run.


            Required if you do not include `targetStartDate` and
            `targetEndDate`.
          type: string
        journalEntryDate:
          description: |
            Date of the journal entry.
          format: date
          type: string
        organizationLabels:
          description: >
            The organization that this run is created for. 



            For each item in the array, either the `organizationId` or the

            `organizationName` field is required.



            This field is only required when you have already turned on
            Multi-Org

            feature.
          properties:
            organizationId:
              description: |
                The organization ID.
              type: string
            organizationName:
              description: |
                The organization name.
              type: string
          type: object
        targetEndDate:
          description: >
            The target end date of the journal run.


            If you include `accountingPeriodName`, the `targetEndDate` must be
            empty or the same as the end date of the accounting period specified
            in `accountingPeriodName`.
          format: date
          type: string
        targetStartDate:
          description: >
            The target start date of the journal run.


            Required if you include targetEndDate.


            If you include `accountingPeriodName`, the `targetStartDate` must be
            empty or the same as the start date of the accounting period
            specified in `accountingPeriodName`.
          format: date
          type: string
        transactionTypes:
          description: |
            Transaction types included in the journal run.

            You can include one or more transaction types.
          items:
            $ref: '#/components/schemas/POSTJournalRunTransactionType'
          type: array
      required:
        - transactionTypes
        - journalEntryDate
      type: object
    POSTJournalRunResponseType:
      properties:
        journalRunNumber:
          description: |
            Journal run number.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETJournalRunTransactionType:
      properties:
        type:
          description: >
            Transaction type. Invoice Adjustment is deprecated on Production.
            Zuora recommends that you use the Invoice Item Adjustment instead.


            If you enable the Invoice Settlement feature, Debit Memo Item,
            Credit Memo Item, and Credit Memo Application Item are available,
            Payment and Refund will be replaced by Payment Application and
            Refund Application. 


            If you enable both the Invoice Settlement feature and the Invoice
            Item Settlement feature, Payment and Refund will be replaced by
            Payment Application Item and Refund Application Item. 
          enum:
            - Invoice Item
            - Taxation Item
            - Invoice Item Adjustment (Invoice)
            - Invoice Item Adjustment (Tax)
            - Invoice Adjustment
            - Electronic Payment
            - External Payment
            - Electronic Refund
            - External Refund
            - Electronic Credit Balance Payment
            - External Credit Balance Payment
            - Electronic Credit Balance Refund
            - External Credit Balance Refund
            - Credit Balance Adjustment (Applied from Credit Balance)
            - Credit Balance Adjustment (Transferred to Credit Balance)
            - Revenue Event Item
            - Debit Memo Item (Charge)
            - Debit Memo Item (Tax)
            - Credit Memo Item (Charge)
            - Credit Memo Item (Tax)
            - Credit Memo Application Item
            - Electronic Payment Application
            - External Payment Application
            - Electronic Refund Application
            - External Refund Application
            - Electronic Payment Application Item
            - External Payment Application Item
            - Electronic Refund Application Item
            - External Refund Application Item
          type: string
      title: transactionTypes
      type: object
    GETJournalRunType:
      properties:
        aggregateCurrency:
          description: ''
          type: boolean
        executedOn:
          description: |
            Date and time the journal run was executed.
          format: date-time
          type: string
        journalEntryDate:
          description: |
            Date of the journal entry.
          format: date
          type: string
        number:
          description: |
            Journal run number.
          type: string
        organizationLabels:
          description: >
            The organization(s) that the object belongs to. 


            Note: This field is available only when the Multi-Org feature is
            enabled.
          items:
            properties:
              organizationId:
                description: |
                  The organization ID.
                type: string
              organizationName:
                description: |
                  The organization name.
                type: string
            type: object
          type: array
        segmentationRuleName:
          description: |
            Name of GL segmentation rule used in the journal run.
          type: string
        status:
          description: |
            Status of the journal run. 
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - CancelInprogress
            - Cancelled
            - DeleteInprogress
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        targetEndDate:
          description: |
            The target end date of the journal run.
          format: date
          type: string
        targetStartDate:
          description: |
            The target start date of the journal run.
          format: date
          type: string
        totalJournalEntryCount:
          description: |
            Total number of journal entries in the journal run.
          format: int64
          type: integer
        transactionTypes:
          description: |
            Transaction types included in the journal run.
          items:
            $ref: '#/components/schemas/GETJournalRunTransactionType'
          type: array
      type: object
    POSTMassUpdateResponseType:
      properties:
        bulkKey:
          description: >
            String of 32 characters that identifies the mass action. The bulkKey
            is generated before the mass action is processed. You can use the
            bulkKey to Get the Mass Action Result.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETMassUpdateType:
      properties:
        actionType:
          description: |
            Type of mass action.
          type: string
        endedOn:
          description: >
            Date and time that the mass action was completed. The format is
            `yyyy-MM-dd hh:mm:ss`.
          format: date-time
          type: string
        errorCount:
          description: >
            Total number of failed records.


            This field is updated in real time. When the mass action **status**
            is Processing, this field returns the number of records that have
            failed so far. When the mass action **status** is Pending, this
            field is null.
          type: string
        inputSize:
          description: |
            Size of the input file in bytes.
          format: int64
          type: integer
        outputSize:
          description: |
            Size of the response file in bytes.
          format: int64
          type: integer
        outputType:
          description: >
            Type of output for the response file. The following table describes
            the output type.


            | Output Type    | Description                         |

            |----------------|-------------------------------------|

            | (url:.csv.zip) | URL pointing to a zipped .csv file. |
          type: string
        outputURL:
          description: >
            URL to download the response file. The response file is a zipped
            .csv file. 

            The response file is identical to the file you uploaded to perform
            the mass action, with additional columns providing information about
            the outcome of each record. 

            This field only returns a value when the mass action **status** is
            Completed or Stopped. Otherwise, this field is null.
          type: string
        processedCount:
          description: >
            Total number of processed records. This field is equal to the sum of
            `errorCount` and `successCount`.


            This field is updated in real time. When the mass action **status**
            is Processing, this field returns the number of records that have
            been processed so far. When the mass action **status** is Pending,
            this field is null.
          type: string
        startedOn:
          description: >
            Date and time that Zuora started processing the mass action. The
            format is `yyyy-MM-dd hh:mm:ss`.
          format: date-time
          type: string
        status:
          description: >
            Status of the mass action. The following table describes the mass
            action statuses.


            | Status     |
            Description                                                               
            |

            |------------|----------------------------------------------------------------------------|

            | Pending    | Mass action has not yet started being
            processed.                           |

            | Processing | Mass action is in
            progress.                                                |

            | Stopping   | Mass action is in the process of stopping, but has
            not yet stopped.        |

            | Stopped    | Mass action has
            stopped.                                                   |

            | Completed  | Mass action was successfully completed. There may
            still be failed records. |

            | Failed     | Mass action failed. No records are processed. No
            response file is created. |
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        successCount:
          description: >
            Total number of successful records.

            This field is updated in real time. When the mass action **status**
            is Processing, this field returns the number of records that have
            succeeded so far. When the mass action **status** is Pending, this
            field is null.
          type: string
        totalCount:
          description: |
            Total number of records in the uploaded mass action file.
            When the mass action **status** is Pending, this field is null.
          type: string
        uploadedBy:
          description: |
            Email of the person who uploaded the mass action file.
          type: string
        uploadedOn:
          description: >
            Date and time that the mass action file was uploaded. The format is
            `yyyy-MM-dd hh:mm:ss`.
          format: date-time
          type: string
      type: object
    EventType:
      properties:
        description:
          description: The description of the event type.
          maxLength: 1000
          type: string
        displayName:
          description: The display name for the event type.
          maxLength: 500
          minLength: 1
          type: string
        name:
          description: >-
            The name of the event. Should be unique, contain no space, and be in
            the pattern: ^[A-Za-z]{1,}[\\w\\-]*$
          maxLength: 200
          minLength: 1
          type: string
      required:
        - name
        - displayName
      type: object
    EventTrigger:
      properties:
        active:
          description: The status of the trigger.
          type: boolean
        baseObject:
          description: >
            The base object that the trigger rule is defined upon. The format of
            the value in this field depends on the base object type:

            - Standard object: object name, which should follow the pattern
            ^[A-Z][\w\-]*$. For example, `Invoice`.

            - Custom object: `default__<custom_object_api_name>`. For example,
            `default__vehicle`.
          maxLength: 100
          minLength: 1
          type: string
        condition:
          description: >-
            The JEXL expression to be evaluated against object changes. See
            above for more information and an example.
          maxLength: 5000
          minLength: 1
          type: string
        description:
          description: The description of the trigger.
          maxLength: 1000
          type: string
        eventType:
          $ref: '#/components/schemas/EventType'
        id:
          format: uuid
          type: string
      type: object
    PostEventTriggerRequest:
      example:
        active: true
        baseObject: Invoice
        condition: >-
          changeType == 'UPDATE' && Invoice.Status == 'Posted' &&
          Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0
        eventType:
          name: LargeInvoicePosted
          displayName: Large Invoice Posted
      properties:
        active:
          description: The status of the event trigger.
          type: boolean
        baseObject:
          description: >
            The base object that the trigger rule is defined upon. The format of
            the value in this field depends on the base object type:

            - Standard object: object name, which should follow the pattern
            ^[A-Z][\w\-]*$. For example, `Invoice`.

            - Custom object: `default__<custom_object_api_name>`. For example,
            `default__vehicle`.
          maxLength: 100
          minLength: 1
          type: string
        condition:
          description: >-
            The JEXL expression to be evaluated against object changes. See
            above for more information and an example.
          maxLength: 5000
          minLength: 1
          type: string
        description:
          description: The description of the event trigger.
          maxLength: 1000
          type: string
        eventType:
          $ref: '#/components/schemas/EventType'
      required:
        - baseObject
        - condition
        - eventType
        - active
      type: object
    PutEventTriggerRequest:
      example:
        description: Trigger the event when an invoice is posted with amount over 1000
        condition: >-
          changeType == 'UPDATE' && Invoice.Status == 'Posted' &&
          Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0
      properties:
        active:
          description: The status of the trigger.
          type: boolean
        condition:
          description: >-
            The JEXL expression to be evaluated against object changes. See
            above for more information and an example.
          maxLength: 5000
          minLength: 1
          type: string
        description:
          description: The description of the trigger.
          maxLength: 1000
          type: string
        eventType:
          description: The type of events to be triggered.
          properties:
            description:
              description: The description for the event type.
              maxLength: 1000
              type: string
            displayName:
              description: The display name for the event type.
              maxLength: 500
              minLength: 1
              type: string
          type: object
      type: object
    GetScheduledEventResponse:
      example:
        active: true
        apiField: TermEndDate
        apiObject: Subscription
        condition: Subscription.Status == _SUBSCRIPTION_STATUS
        cronExpression: 0 30 10 ? * *
        description: >-
          Trigger a scheduled event at 10:30 AM based on TermEndDate of
          subscription objects.
        displayName: Term End Date Scheduled Event
        id: d306545b74e445e4bffcf1c7609804be
        name: TermEndDateScheduledEvent
        namespace: user.notification
        parameters:
          _SUBSCRIPTION_STATUS:
            description: The status of the subscription
            displayName: Subscription Status
            options:
              - Draft
              - Active
              - Pending
              - Expired
              - Cancelled
            valueType: STRING
      properties:
        active:
          description: Indicate whether the scheduled event is active or inactive
          type: boolean
        apiField:
          description: >-
            The base field of the base object in the `apiObject` field, should
            be in date or timestamp format. The scheduled event notifications
            are triggered based on this date and the event parameters (before or
            after a specified number of days) from notification definitions.
            Should be specified in the pattern: ^[A-Z][\\w\\-]*$
          type: string
        apiObject:
          description: >-
            The base object that the scheduled event is defined upon. The base
            object should contain a date or timestamp format field. Should be
            specified in the pattern: ^[A-Z][\\w\\-]*$
          type: string
        condition:
          description: >
            The filter rule conditions, written in
            [JEXL](http://commons.apache.org/proper/commons-jexl/). The
            scheduled event is triggered only if the condition is evaluated as
            true.

            The rule might contain event context merge fields and data source
            merge fields. Data source merge fields must be from [the base object
            of the event or from the joined objects of the base
            object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).

            Scheduled events with invalid merge fields will fail to evaluate,
            thus will not be triggered. For example, to trigger an invoice due
            date scheduled event to only invoices with an amount over 1000, you
            would define the following condition:


            ```Invoice.Amount > 1000.0```


            `Invoice.Amount` refers to the `Amount` field of the Zuora object
            `Invoice`.
          type: string
        cronExpression:
          description: >-
            The cron expression defines the time when scheduled event
            notifications will be sent.
          type: string
        description:
          description: The description of the scheduled event.
          type: string
        displayName:
          description: The display name of the scheduled event.
          type: string
        id:
          description: Scheduled event ID.
          format: uuid
          type: string
        name:
          description: The name of the scheduled event.
          type: string
        namespace:
          description: The namespace of the scheduled event name in the `name` field.
          type: string
        parameters:
          additionalProperties:
            description: Definition of a filter rule parameter.
            properties:
              description:
                description: The description of the parameter.
                maxLength: 255
                type: string
              displayName:
                description: The display name of the parameter.
                maxLength: 255
                type: string
              options:
                description: The option values of the parameter.
                items:
                  type: string
                type: array
              valueType:
                description: The type of the value.
                type: string
            type: object
          description: >-
            The parameter definitions of the filter rule. The names of the
            parameters must match with the filter rule and can't be duplicated.
            You should specify all the parameters when creating scheduled event
            notifications.
          type: object
      title: ScheduledEvent
      type: object
    PostScheduledEventRequest:
      description: namespace.name pair should be unique universally
      example:
        active: true
        apiField: TermEndDate
        apiObject: Subscription
        condition: Subscription.Status == _SUBSCRIPTION_STATUS
        description: >-
          Trigger a scheduled event at 10:30 AM based on TermEndDate of
          subscription objects.
        displayName: Term End Date Scheduled Event
        hours: 10
        minutes: 30
        name: TermEndDateScheduledEvent
        parameters:
          _SUBSCRIPTION_STATUS:
            description: The status of the subscription
            displayName: Subscription Status
            options:
              - Draft
              - Active
              - Pending
              - Expired
              - Cancelled
            valueType: STRING
      properties:
        active:
          default: true
          description: Indicate whether the scheduled event is active or inactive.
          type: boolean
        apiField:
          description: >
            The base field of the base object in the `apiObject` field, should
            be in date or timestamp format. The scheduled event notifications
            are triggered based on this date and the event parameters (before or
            after a specified number of days) from notification definitions.
            Should be specified in the pattern: ^[A-Z][\\w\\-]*$
             
            See [Custom Scheduled
            Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events)
            for all available base fields.
          type: string
        apiObject:
          description: >
            The base object that the scheduled event is defined upon. The base
            object should contain a date or timestamp format field. Should be
            specified in the pattern: ^[A-Z][\\w\\-]*$
                       
            See [Custom Scheduled
            Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events)
            for all available base objects.
          type: string
        condition:
          description: >
            The filter rule conditions, written in
            [JEXL](http://commons.apache.org/proper/commons-jexl/). The
            scheduled event is triggered only if the condition is evaluated as
            true.

            The rule might contain event context merge fields and data source
            merge fields. Data source merge fields must be from [the base object
            of the event or from the joined objects of the base
            object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).

            Scheduled events with invalid merge fields will fail to evaluate,
            thus will not be triggered. For example, to trigger an invoice due
            date scheduled event to only invoices with an amount over 1000, you
            would define the following condition:


            ```Invoice.Amount > 1000.0```


            `Invoice.Amount` refers to the `Amount` field of the Zuora object
            `Invoice`.
          maxLength: 65535
          type: string
        description:
          description: The description of the scheduled event.
          maxLength: 1000
          type: string
        displayName:
          description: The display name of the scheduled event.
          maxLength: 500
          minLength: 1
          type: string
        hours:
          description: >-
            The scheduled time (hour) that the scheduled event notifications are
            sent. This time is based on the localized timezone of your tenant.
          maximum: 23
          minimum: 0
          type: integer
        minutes:
          description: >-
            The scheduled time (minute) that the scheduled event notifications
            are sent. This time is based on the localized timezone of your
            tenant.
          maximum: 59
          minimum: 0
          type: integer
        name:
          description: >-
            The name of the scheduled event. Should be unique, contain no space,
            and be in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$
          maxLength: 200
          minLength: 1
          type: string
        parameters:
          additionalProperties:
            description: Definition of a filter rule parameter.
            properties:
              description:
                description: The description of the parameter.
                maxLength: 255
                type: string
              displayName:
                description: The display name of the parameter.
                maxLength: 255
                type: string
              options:
                description: The option values of the parameter.
                items:
                  type: string
                type: array
              valueType:
                description: The type of the value.
                enum:
                  - STRING
                  - BYTE
                  - SHORT
                  - CHARACTER
                  - INTEGER
                  - LONG
                  - FLOAT
                  - DOUBLE
                  - BOOLEAN
                  - BIG_INTEGER
                  - BIG_DECIMAL
                  - LOCAL_DATE
                  - LOCAL_DATE_TIME
                  - TIMESTAMP
                  - BYTE_ARRAY
                  - SHORT_ARRAY
                  - CHARACTER_ARRAY
                  - INTEGER_ARRAY
                  - FLOAT_ARRAY
                  - DOUBLE_ARRAY
                  - BOOLEAN_ARRAY
                  - STRING_ARRAY
                  - BIG_INTEGER_ARRAY
                  - BIG_DECIMAL_ARRAY
                  - LOCAL_DATE_ARRAY
                  - LOCAL_DATE_TIME_ARRAY
                  - TIMESTAMP_ARRAY
                type: string
            type: object
          description: >-
            The parameter definitions of the filter rule. The names of the
            parameters must match with the filter rule and can't be duplicated.
            You should specify all the parameters when creating scheduled event
            notifications.
          type: object
      required:
        - name
        - displayName
        - apiObject
        - apiField
        - hours
        - minutes
      type: object
    PutScheduledEventRequest:
      example:
        active: true
        condition: Subscription.Status == _SUBSCRIPTION_STATUS
        description: >-
          Trigger a scheduled event at 10:30 AM based on TermEndDate of
          subscription objects.
        displayName: Term End Date Scheduled Event
        hours: 10
        minutes: 30
        parameters:
          _SUBSCRIPTION_STATUS:
            description: The status of the subscription
            displayName: Subscription Status
            options:
              - Draft
              - Active
              - Pending
              - Expired
              - Cancelled
            valueType: STRING
      properties:
        active:
          description: Indicate whether the scheduled event is active or inactive
          type: boolean
        condition:
          description: >
            The filter rule conditions, written in
            [JEXL](http://commons.apache.org/proper/commons-jexl/). The
            scheduled event is triggered only if the condition is evaluated as
            true.

            The rule might contain event context merge fields and data source
            merge fields. Data source merge fields must be from [the base object
            of the event or from the joined objects of the base
            object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).

            Scheduled events with invalid merge fields will fail to evaluate,
            thus will not be triggered. For example, to trigger an invoice due
            date scheduled event to only invoices with an amount over 1000, you
            would define the following condition:


            ```Invoice.Amount > 1000.0```


            `Invoice.Amount` refers to the `Amount` field of the Zuora object
            `Invoice`.
          maxLength: 65535
          type: string
        description:
          description: The description of the scheduled event.
          maxLength: 1000
          type: string
        displayName:
          description: The display name of the scheduled event.
          maxLength: 500
          minLength: 1
          type: string
        hours:
          description: >-
            The scheduled time (hour) that the scheduled event notifications are
            sent. This time is based on the localized timezone of your tenant.
          maximum: 23
          minimum: 0
          type: integer
        minutes:
          description: >-
            The scheduled time (minute) that the scheduled event notifications
            are sent. This time is based on the localized timezone of your
            tenant.
          maximum: 59
          minimum: 0
          type: integer
        parameters:
          additionalProperties:
            description: Definition of a filter rule parameter.
            properties:
              description:
                description: The description of the parameter.
                maxLength: 255
                type: string
              displayName:
                description: The display name of the parameter.
                maxLength: 255
                type: string
              options:
                description: The option values of the parameter.
                items:
                  type: string
                type: array
              valueType:
                description: The type of the value.
                enum:
                  - STRING
                  - BYTE
                  - SHORT
                  - CHARACTER
                  - INTEGER
                  - LONG
                  - FLOAT
                  - DOUBLE
                  - BOOLEAN
                  - BIG_INTEGER
                  - BIG_DECIMAL
                  - LOCAL_DATE
                  - LOCAL_DATE_TIME
                  - TIMESTAMP
                  - BYTE_ARRAY
                  - SHORT_ARRAY
                  - CHARACTER_ARRAY
                  - INTEGER_ARRAY
                  - FLOAT_ARRAY
                  - DOUBLE_ARRAY
                  - BOOLEAN_ARRAY
                  - STRING_ARRAY
                  - BIG_INTEGER_ARRAY
                  - BIG_DECIMAL_ARRAY
                  - LOCAL_DATE_ARRAY
                  - LOCAL_DATE_TIME_ARRAY
                  - TIMESTAMP_ARRAY
                type: string
            type: object
          description: >-
            The parameters of the filter rule. The names of the parameters must
            match with the filter rule and can't be duplicated.
          type: object
      type: object
    CalloutAuth:
      description: If `requiredAuth` is `true`, this object is required.
      properties:
        domain:
          description: The domain of the callout auth.
          type: string
        password:
          description: The field is required when `requiredAuth` is `true`.
          type: string
        preemptive:
          description: >-
            Set this field to `true` if you want to enable the preemptive
            authentication.
          type: boolean
        username:
          description: The field is required when `requiredAuth` is `true`.
          type: string
      type: object
      nullable: true
    CalloutMergeFields:
      additionalProperties:
        description: >
          The key is the parameter name. The value is a merge field with angle
          brackets.
        type: string
      description: |
        A key-value map of merge fields of this callout.
      title: calloutParams
      type: object
    FilterRuleParameterDefinition:
      description: |
        Definition of a filter rule parameter.
      properties:
        description:
          maxLength: 255
          type: string
        displayName:
          description: |
            The display name of the parameter.
          maxLength: 255
          type: string
        options:
          description: |
            The option values of the parameter.
          items:
            type: string
          type: array
        valueType:
          description: |
            The type of the value.
          enum:
            - STRING
            - BYTE
            - SHORT
            - CHARACTER
            - INTEGER
            - LONG
            - FLOAT
            - DOUBLE
            - BOOLEAN
            - BIG_INTEGER
            - BIG_DECIMAL
            - LOCAL_DATE
            - LOCAL_DATE_TIME
            - TIMESTAMP
            - BYTE_ARRAY
            - SHORT_ARRAY
            - CHARACTER_ARRAY
            - INTEGER_ARRAY
            - FLOAT_ARRAY
            - DOUBLE_ARRAY
            - BOOLEAN_ARRAY
            - STRING_ARRAY
            - BIG_INTEGER_ARRAY
            - BIG_DECIMAL_ARRAY
            - LOCAL_DATE_ARRAY
            - LOCAL_DATE_TIME_ARRAY
            - TIMESTAMP_ARRAY
          type: string
      title: parameter
      type: object
    FilterRuleParameterDefinitions:
      additionalProperties:
        $ref: '#/components/schemas/FilterRuleParameterDefinition'
      description: >
        The parameters of the filter rule and their name must match those in the
        filter rule. And all parameters must be defined in the event type
        payload. The name of parameters can't be duplicate. The following
        reserved keywords should not be used as a parameter name:
        `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`,
        `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY`
      title: parameters
      type: object
    FilterRuleParameterValues:
      additionalProperties:
        description: >
          The following reserved key words should not be used as a parameter
          name: `AttachmentList`, `RecipientList`, `RecipientType`,
          `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY`.
          `Include.Attachment` is a special boolean parameter. By specifying
          this parameter, you can tell a notification whose event type is based
          on Invoice to include attachments while sending emails.
        type: string
      description: |
        The parameter values used to configure the filter rule.
      title: filterRuleParams
      type: object
    GETPublicNotificationDefinitionResponse:
      example:
        id: 838bfafa9b224408809f8ecbdae198ef
        createdBy: 8ad084a67f9c7138017fab8a8b511b5a
        createdOn: 2024-11-11T03:00:03.000 UTC
        updatedBy: 8ad084a67f9c7138017fab8a8b511b5a
        updatedOn: 2024-11-11T03:00:03.000 UTC
        eventTypeNamespace: user.notification
        eventTypeName: AccountEdit
        name: Account Edit Notification
        description: null
        communicationProfileId: 2c92c0f9446cd49501447539d6a72815
        communicationProfileIds:
          - 2c92c0f9446cd49501447539d6a72815
        active: true
        emailTemplateId: f11e498862584a10a05b83ea70119659
        callout: null
        calloutTemplateIds: []
        filterRule:
          id: a1efc8cc717e48208b9f0fd5d7bf2a58
          createdBy: 8ad084a67f9c7138017fab8a8b511b5a
          createdOn: 2024-11-11T03:00:04.000 UTC
          updatedBy: null
          updatedOn: null
          description: Filter rule to test if an account is a VIP account
          condition: >-
            Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status ==
            _ACCOUNT_STATUS
          parameters:
            _ACCOUNT_STATUS:
              displayName: VIP Account Status
              description: The status of the VIP Account
              options:
                - Draft
                - Active
                - Canceled
              valueType: STRING
            _VIP_BALANCE_AMOUNT:
              displayName: VIP Account Balance
              description: The minimum account balance
              options: null
              valueType: BIG_DECIMAL
          scheduled: false
        filterRuleParams:
          _ACCOUNT_STATUS: Active
          _VIP_BALANCE_AMOUNT: '100000.0'
        emailActive: true
        calloutActive: false
        associatedAccount: null
      properties:
        active:
          description: >-
            The status of the notification definition. The default value is
            `true`.
          type: boolean
        associatedAccount:
          description: >
            The account on which the histories of this notification will be
            displayed. The associated account does not enforce where the merge
            fields come from.
          type: string
        callout:
          properties:
            active:
              default: true
              description: The status of the callout. The default value is `true`.
              type: boolean
            calloutAuth:
              $ref: '#/components/schemas/CalloutAuth'
            calloutBaseurl:
              description: The callout URL. It must start with 'https://'
              example: https://***
              format: url
              minLength: 10
              type: string
            calloutParams:
              $ref: '#/components/schemas/CalloutMergeFields'
            calloutRetry:
              default: true
              description: >-
                Specified whether to retry the callout when the callout fails.
                The default value is `true`.
              type: boolean
            description:
              description: Description for the callout.
              maxLength: 255
              type: string
            eventTypeName:
              description: The name of the custom event type.
              minLength: 1
              type: string
            httpMethod:
              description: The HTTP method of the callout.
              enum:
                - POST
                - GET
                - PUT
                - PATCH
                - DELETE
              example: POST
              type: string
            id:
              description: >-
                The ID of the callout. If `calloutActive` is `true`, a callout
                is required. The eventTypeName of the callout MUST be the same
                as the eventTypeName.
              format: uuid
              type: string
            name:
              description: The name of the created callout.
              maxLength: 255
              type: string
            oauth2ProviderId:
              description: >-
                The ID of the OAuth 2.0 provider in your tenant that provides
                access tokens for the callout.
              type: string
            requiredAuth:
              description: >-
                Indicates whether Basic authentication is enabled for the
                callout.
              type: boolean
            requiredOauth2:
              description: >-
                Indicates whether OAuth 2.0 authentication is enabled for the
                callout.
              type: boolean
          type: object
        calloutActive:
          description: The status of the callout action. The default value is `false`.
          type: boolean
        calloutTemplateIds:
          description: >
            List of callout template IDs that the notification definition is
            associated with.
          items:
            type: string
          type: array
        communicationProfileId:
          description: >
            The ID of the communication profile that the notification definition
            is associated with.


            If the notification definition is associated with multiple
            communication profiles, see `communicationProfileIds` for all
            associated communication profile IDs.
          format: uuid
          type: string
        communicationProfileIds:
          description: >
            List of communication profile IDs that the notification definition
            is associated with.
          items:
            type: string
          type: array
        createdBy:
          description: The ID of the user who created the notification definition.
          format: uuid
          type: string
        createdOn:
          description: >-
            The time when the notification definition was created. Specified in
            the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD).
            E.g. 1997-07-16T19:20:30.45+00:00
          format: date-time
          type: string
        description:
          description: Description of the notification definition
          maxLength: 255
          type: string
        emailActive:
          description: The status of the email action. The default value is `false`.
          type: boolean
        emailTemplateId:
          description: >-
            The ID of the email template. In the request, there should be at
            least one email template or callout.
          format: uuid
          type: string
        eventCategory:
          description: >
            The event category code for a standard event, on which the
            notification definition is created.


            This field is available only if the notification definition is based
            on a standard event.


            For the list of supported standard event category codes, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
            target="_blank">Standard event category code for events and
            notifications</a>.
          type: number
        eventId:
          description: >
            The ID of the event that the notification definition is based on.


            This field is available only if the notification definition is based
            on a standard event.    
          type: string
          format: uuid
        eventTypeName:
          description: >
            The name of the event that the notification definition is based on.


            This field is available only if the notification definition is based
            on a Zuora custom event, custom event, or custom scheduled event.
          minLength: 1
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field. It indicates who created
            the event and which namespace the event is assigned to.


            Supported values are as follows:


            - `com.zuora.notification`: events that are created by Zuora. This
            value applies to Zuora custom events.

            - `user.notification`: events that are created by tenant users. This
            value applies to custom events and custom scheduled events.


            This field is available only if the notification definition is based
            on a Zuora custom event, custom event, or custom scheduled
            event.      
          type: string
          enum:
            - user.notification
            - com.zuora.notification
        filterRule:
          description: ''
          properties:
            condition:
              description: >
                The filter rule conditions, written in
                [JEXL](http://commons.apache.org/proper/commons-jexl/).

                The rule might contain event context merge fields and data
                source merge fields. Data source merge fields must be from [the
                base object of the event or from the joined objects of the base
                object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).
                Notifications with invalid merge fields will fail to evaluate,
                thus will not be invoked. For example, to trigger an event when
                an invoice is posted with the amount over 1000, you would define
                the following condition on the `Invoice` object:


                ```changeType == 'UPDATE' && Invoice.Status == 'Posted' &&
                Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0```


                There are conventions and keywords you need to be aware of. For
                example:


                * `changeType` is a keyword to specify what kind of change
                happened to the object. Allowed values are `INSERT`, `UPDATE` or
                `DELETE`.


                * `Invoice.Status` refers to field `Status` of the Zuora object
                `Invoice`.


                * A variable with the `_old` suffix means it’s a previous value
                of the corresponding object field. The "_old" fields are only
                available on the base objects.
              example: >-
                Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status ==
                _ACCOUNT_STATUS
              type: string
            description:
              description: The description of the filter rule.
              maxLength: 255
              type: string
            eventTypeName:
              description: The value is `null`.
              minLength: 1
              type: string
            id:
              description: >-
                The ID of the filter rule. If not specified or null, the
                notification definition is always qualified to process events of
                "eventType".
              format: uuid
              type: string
            parameters:
              $ref: '#/components/schemas/FilterRuleParameterDefinitions'
          type: object
        filterRuleParams:
          $ref: '#/components/schemas/FilterRuleParameterValues'
        id:
          description: The ID associated with this notification definition.
          format: uuid
          type: string
        name:
          description: The name of the notification definition.
          maxLength: 255
          type: string
        updatedBy:
          description: The ID of the user who updated the notification definition.
          format: uuid
          type: string
        updatedOn:
          description: >-
            The time when the notification was updated. Specified in the UTC
            timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g.
            1997-07-16T19:20:30.45+00:00
          format: date-time
          type: string
      type: object
    POSTPublicNotificationDefinitionCalloutCommon:
      title: Callout - without authentication
      description: |
        Common information for callout notifications.
      properties:
        active:
          default: true
          description: The status of the callout. The default is `true`.
          type: boolean
        calloutBaseurl:
          description: >
            The callout URL. It must start with 'https://'.


            Zuora uses port 443 to send callout notifications by default. If you
            want to use other ports, submit a request at <a
            href="http://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          example: https://***
          format: url
          minLength: 10
          type: string
        calloutParams:
          $ref: '#/components/schemas/CalloutMergeFields'
        calloutRetry:
          default: true
          description: >-
            Specified whether to retry the callout when the callout fails. The
            default value is `true`.
          type: boolean
        description:
          description: Description for the callout.
          maxLength: 255
          type: string
        eventTypeName:
          description: >-
            The name of the event type. The value must be the same as the
            parent-level `eventTypeName` field.
          minLength: 1
          type: string
        httpMethod:
          description: The HTTP method of the callout.
          enum:
            - POST
            - GET
            - PUT
            - PATCH
            - DELETE
          example: POST
          type: string
        name:
          description: >-
            The name of the callout template that will be created. It must be
            unique across all callout templates.
          maxLength: 255
          type: string
      required:
        - name
        - calloutBaseurl
        - httpMethod
      type: object
    POSTPublicNotificationDefinitionCalloutBasicAuthentication:
      title: Callout - Base authentication
      allOf:
        - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon'
        - type: object
          description: |
            The Basic Authentication information for callout notifications.
          properties:
            requiredAuth:
              description: >
                Indicates whether Basic authentication is enabled for the
                callout.


                When creating callout notifications with Basic authentication
                enabled, you must set this field to `true` and specify the
                username and password in `calloutAuth`.
              type: boolean
            calloutAuth:
              $ref: '#/components/schemas/CalloutAuth'
          required:
            - requiredAuth
    POSTPublicNotificationDefinitionCalloutOauth2Authentication:
      title: Callout - OAuth 2.0 authentication
      allOf:
        - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon'
        - type: object
          description: |
            The OAuth 2.0 Authentication information for callout notifications.
          properties:
            requiredOauth2:
              description: >
                Indicates whether OAuth 2.0 authentication is enabled for the
                callout.


                When creating callout notifications with OAuth 2.0
                authentication enabled, you must set this field to `true` and
                specify the OAuth 2.0 provider ID in `oauth2ProviderId`.
              type: boolean
            oauth2ProviderId:
              description: >
                The ID of the OAuth 2.0 provider in your tenant that provides
                access tokens for the callout. This field is required if
                `requiredOauth2` is `true`.


                For more information about how to get the ID of an OAuth 2.0
                provider, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Add_an_OAuth_2.0_Provider#Retrieve_the_ID_of_an_OAuth_2.0_provider"
                target="_blank">Retrieve the ID of an OAuth 2.0 provider</a>.
          required:
            - requiredOauth2
    POSTPublicNotificationDefinitionRequest:
      properties:
        active:
          default: true
          description: >-
            The status of the notification definition. The default value is
            `true`.
          type: boolean
        associatedAccount:
          description: >
            The account on which the histories of this notification will be
            displayed. The associated account does not enforce where the merge
            fields come from.

            Available values are as follows:

            * `Account.Id`: ID of the primary customer account related to the
            notification. It is also the default value.

            * `ParentAccount.Id`: this option is available only if you have <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
            target="_blank">Customer Hierarchy</a> enabled for your tenant.

            * `SubscriptionOwnerAccount.Id`: this option is available if the
            base object of the notification is Order Action.


            **Note:** before specifying this field, we recommend that you use
            [Data
            Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference)
            to check the available types of accounts for the current
            notification.  
          type: string
        callout:
          description: >
            If this field is specified, Zuora will create a new callout template
            when creating the notification definition and associate the template
            with the notification definition.


            You cannot specify the `calloutTemplateIds` and `callout` fields at
            the same time.


            For more information about callout templates, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Events_and_Notifications/AF_Manage_email_and_callout_templates/B_Manage_callout_templates"
            target="_blank">Manage callout templates</a>.
          oneOf:
            - $ref: >-
                #/components/schemas/POSTPublicNotificationDefinitionCalloutCommon
            - $ref: >-
                #/components/schemas/POSTPublicNotificationDefinitionCalloutBasicAuthentication
            - $ref: >-
                #/components/schemas/POSTPublicNotificationDefinitionCalloutOauth2Authentication
        calloutActive:
          default: false
          description: The status of the callout action. The default value is `false`.
          type: boolean
        calloutTemplateIds:
          description: >
            List of callout template IDs that the notification definition is
            associated with.


            You cannot specify the `calloutTemplateIds` and `callout` fields at
            the same time.


            For more information about callout templates, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Events_and_Notifications/AF_Manage_email_and_callout_templates/B_Manage_callout_templates"
            target="_blank">Manage callout templates</a>.
          items:
            type: string
          type: array
        communicationProfileId:
          description: >
            The ID of the communication profile that the notification definition
            is associated with.


            You can use the [Query
            Action](https://developer.zuora.com/api-references/api/operation/Action_POSTquery)
            to get the communication profile Id. See the following request
            sample:


            `{
                "queryString": "select Id, ProfileName from CommunicationProfile"
             }`


            If you do not pass the communicationProfileId, notification service
            will be automatically added to the 'Default Profile'.


            If you want to associate the notification definition with multiple
            communication profiles,  use the `communicationProfileIds` field,
            which overrides this field.
          type: string
        communicationProfileIds:
          description: >
            List of communication profile IDs that the notification definition
            is associated with.


            This field overrides the `communicationProfileId` field.
          items:
            type: string
          type: array
        description:
          description: The description of the notification definition.
          maxLength: 255
          type: string
        emailActive:
          default: false
          description: The status of the email action. The default value is `false`.
          type: boolean
        emailTemplateId:
          description: >-
            The ID of the email template. If `emailActive` is `true`, an email
            template is required. And EventType of the email template MUST be
            the same as the eventType.
          format: uuid
          type: string
        eventCategory:
          description: >
            The event category code for a standard event, on which the
            notification definition is created.


            This field is required when creating notification definitions for
            standard events.


            For the list of supported standard event category codes, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
            target="_blank">Standard event category code for events and
            notifications</a>.
          type: number
        eventTypeName:
          description: >
            The name of the event that the notification definition is based on.


            This field is required when creating notification definitions for
            Zuora custom events, custom events, or custom scheduled events.


            If this field is provided, you can specify the event namespace in
            the `eventTypeNamespace` field. 
          minLength: 1
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field. It indicates who created
            the event and which namespace the event is assigned to.


            Supported values are as follows:


            - `com.zuora.notification`: events that are created by Zuora. This
            value applies to Zuora custom events.

            - `user.notification`: events that are created by tenant users. This
            value applies to custom events and custom scheduled events. This is
            the default value. 
                      
            For example, if you want to create a notification definition on the
            `OrderActionProcessed` event, which is a Zuora custom event, you
            must specify `com.zuora.notification` for this field.
          type: string
          enum:
            - user.notification
            - com.zuora.notification
          default: user.notification
        filterRule:
          description: ''
          properties:
            condition:
              description: >
                The filter rule conditions, written in
                [JEXL](http://commons.apache.org/proper/commons-jexl/).

                The rule might contain event context merge fields and data
                source merge fields. Data source merge fields must be from [the
                base object of the event or from the joined objects of the base
                object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).
                Notifications with invalid merge fields will fail to evaluate,
                thus will not be invoked. For example, to filter an invoice
                posted notification to only invoices with an amount over 1000,
                you would define the following condition:


                ```Invoice.Amount > 1000.0```


                There are conventions and keywords you need to be aware of. For
                example:


                * `Invoice.Amount` refers to the `Amount` field of the Zuora
                object `Invoice`.


                * Unlike Event Triggers, there is no access to variables with
                the `_old` suffix. Fields with the `_old` suffix are only
                available on Event Trigger conditions.
              example: >-
                Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status ==
                _ACCOUNT_STATUS
              type: string
            description:
              description: The description of the filter rule.
              maxLength: 255
              type: string
            parameters:
              $ref: '#/components/schemas/FilterRuleParameterDefinitions'
          required:
            - condition
            - parameters
          type: object
        filterRuleParams:
          $ref: '#/components/schemas/FilterRuleParameterValues'
        name:
          description: >-
            The name of the notification definition, unique per communication
            profile.
          maxLength: 255
          type: string
      required:
        - name
      type: object
    PUTPublicNotificationDefinitionCalloutCommon:
      title: Callout - without authentication
      description: |
        Common information for callout notifications.
      properties:
        active:
          default: true
          description: The status of the callout. The default value is `true`.
          type: boolean
        calloutBaseurl:
          description: >
            The callout URL. It must start with 'https://'.


            Zuora uses port 443 to send callout notifications by default. If you
            want to use other ports, submit a request at <a
            href="http://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.
          example: https://***
          format: url
          minLength: 10
          type: string
        calloutParams:
          $ref: '#/components/schemas/CalloutMergeFields'
        calloutRetry:
          default: true
          description: >-
            Specified whether to retry the callout when the callout fails. The
            default value is `true`.
          type: boolean
        description:
          description: Description for the callout.
          maxLength: 255
          type: string
        httpMethod:
          description: The HTTP method of the callout.
          enum:
            - POST
            - GET
            - PUT
            - PATCH
            - DELETE
          example: POST
          type: string
        name:
          description: >-
            The name of the callout template that will be created. It must be
            unique across all callout templates.
          maxLength: 255
          type: string
      type: object
    PUTPublicNotificationDefinitionCalloutBasicAuthentication:
      title: Callout - Base authentication
      allOf:
        - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon'
        - type: object
          description: |
            The Basic Authentication information for callout notifications.
          properties:
            requiredAuth:
              description: >
                Indicates whether Basic authentication is enabled for the
                callout.
              type: boolean
            calloutAuth:
              $ref: '#/components/schemas/CalloutAuth'
    PUTPublicNotificationDefinitionCalloutOauth2Authentication:
      title: Callout - OAuth 2.0 authentication
      allOf:
        - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon'
        - type: object
          description: |
            The OAuth 2.0 Authentication information for callout notifications.
          properties:
            requiredOauth2:
              description: >
                Indicates whether OAuth 2.0 authentication is enabled for the
                callout.
              type: boolean
            oauth2ProviderId:
              description: >
                The ID of the OAuth 2.0 provider in your tenant that provides
                access tokens for the callout.


                For more information about how to get the ID of an OAuth 2.0
                provider, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Add_an_OAuth_2.0_Provider#Retrieve_the_ID_of_an_OAuth_2.0_provider"
                target="_blank">Retrieve the ID of an OAuth 2.0 provider</a>.
    PUTPublicNotificationDefinitionRequest:
      example:
        description: Details of the notification definition
      properties:
        active:
          default: true
          description: >-
            The status of the notification definition. The default value is
            `true`.
          type: boolean
        associatedAccount:
          description: >
            The account on which the histories of this notification will be
            displayed. The associated account does not enforce where the merge
            fields come from.

            Available values are as follows:

            * `Account.Id`: ID of the primary customer account related to the
            notification. It is also the default value.

            * `ParentAccount.Id`: this option is available only if you have <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"
            target="_blank">Customer Hierarchy</a> enabled for your tenant.

            * `SubscriptionOwnerAccount.Id`: this option is available if the
            base object of the notification is Order Action.


            **Note:** before specifying this field, we recommend that you use
            [Data
            Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference)
            to check the available types of accounts for the current
            notification.  
          type: string
        callout:
          description: >
            If this field is specified, Zuora will create a new callout template
            when creating the notification definition and associate the template
            with the notification definition.


            You cannot specify the `calloutTemplateIds` and `callout` fields at
            the same time.


            For more information about callout templates, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Events_and_Notifications/AF_Manage_email_and_callout_templates/B_Manage_callout_templates"
            target="_blank">Manage callout templates</a>.
          oneOf:
            - $ref: >-
                #/components/schemas/PUTPublicNotificationDefinitionCalloutCommon
            - $ref: >-
                #/components/schemas/PUTPublicNotificationDefinitionCalloutBasicAuthentication
            - $ref: >-
                #/components/schemas/PUTPublicNotificationDefinitionCalloutOauth2Authentication
        calloutActive:
          default: false
          description: The status of the callout action. The default value is `false`.
          type: boolean
        calloutTemplateIds:
          description: >
            List of callout template IDs that the notification definition is
            associated with.


            You cannot specify the `calloutTemplateIds` and `callout` fields at
            the same time.


            For more information about callout templates, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Events_and_Notifications/AF_Manage_email_and_callout_templates/B_Manage_callout_templates"
            target="_blank">Manage callout templates</a>.
          items:
            type: string
          type: array
        communicationProfileId:
          description: >
            The profile that notification definition belongs to. 


            If you want to associate the notification definition with multiple
            communication profiles, use the `communicationProfileIds` field,
            which overrides this field.
          format: uuid
          type: string
        communicationProfileIds:
          description: >
            List of communication profile IDs that the notification definition
            is associated with.


            This field overrides the `communicationProfileId` field.
          items:
            type: string
          type: array
        description:
          description: The description of the notification definition.
          maxLength: 255
          type: string
        emailActive:
          default: false
          description: The status of the email action. The default value is `false`.
          type: boolean
        emailTemplateId:
          description: >
            The ID of the email template. If emailActive is updated from

            false to true, an email template is required, and the EventType of

            the email template MUST be the same as the EventType of the
            notification definition.
          format: uuid
          type: string
        filterRule:
          description: ''
          properties:
            condition:
              description: >
                The filter rule conditions, written in
                [JEXL](http://commons.apache.org/proper/commons-jexl/).

                The rule might contain event context merge fields and data
                source merge fields. Data source merge fields must be from [the
                base object of the event or from the joined objects of the base
                object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects).
                Notifications with invalid merge fields will fail to evaluate,
                thus will not be invoked. For example, to trigger an event when
                an invoice is posted with the amount over 1000, you would define
                the following condition on the `Invoice` object:


                ```changeType == 'UPDATE' && Invoice.Status == 'Posted' &&
                Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0```


                There are conventions and keywords you need to be aware of. For
                example:


                * `changeType` is a keyword to specify what kind of change
                happened to the object. Allowed values are `INSERT`, `UPDATE` or
                `DELETE`.


                * `Invoice.Status` refers to field `Status` of the Zuora object
                `Invoice`.


                * A variable with the `_old` suffix means it’s a previous value
                of the corresponding object field. The "_old" fields are only
                available on the base objects.
              example: >-
                Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status ==
                _ACCOUNT_STATUS
              type: string
            description:
              description: The description of the filter rule.
              maxLength: 255
              type: string
            parameters:
              $ref: '#/components/schemas/FilterRuleParameterDefinitions'
          required:
            - eventTypeName
            - condition
            - parameters
          type: object
        filterRuleParams:
          $ref: '#/components/schemas/FilterRuleParameterValues'
        name:
          description: >-
            The name of the notification definition, which is unique in the
            profile.
          maxLength: 255
          type: string
      type: object
    POSTCreateOrUpdateEmailTemplateRequestFormat:
      properties:
        active:
          default: true
          description: The status of the email template. The default value is `true`.
          type: boolean
        bccEmailAddress:
          description: The email bcc address.
          format: email
          type: string
        ccEmailAddress:
          description: The email CC address.
          type: string
        ccEmailType:
          default: SpecificEmails
          description: >
            Email CC type.


            - When the related event is account-level and associated with the
            Subscription object, such as Subscription Created, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
              - InvoiceOwnerBillToContact
              - InvoiceOwnerSoldToContact
              - InvoiceOwnerShipToContact
              - InvoiceOwnerBillToAndSoldToContacts
              - InvoiceOwnerAllContacts
            - When the related event is account-level and not associated with
            the Subscription object, such as Payment Processed, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
            - When the related event is tenant-level, such as Bill Run
            Completion, you can use the following values:
              - TenantAdmin
              - RunOwner
              - SpecificEmails
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
        description:
          description: The description of the email template.
          maxLength: 255
          type: string
        emailBody:
          description: >
            The email body. You can add merge fields in the email body using
            angle brackets or double curly brackets. For more information, see
            <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>. 


            You can also embed HTML tags if `isHtml` is `true`.
          type: string
        emailHeaders:
          type: object
          title: emailHeader
          description: >
            Container for custom email headers. Each custom email header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom email header consists of a name-value pair:


              * Field name: the name of the custom email header.


              * Field value: the value of the custom email header. You can add
              merge fields in the field value. For more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email templates</a>.
        emailSubject:
          description: >
            The email subject. You can add merge fields in the email subject
            using angle brackets or double curly brackets. For more information,
            see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>.
          type: string
        encodingType:
          default: UTF8
          description: The endcode type of the email body.
          enum:
            - UTF8
            - Shift_JIS
            - ISO_2022_JP
            - EUC_JP
            - X_SJIS_0213
          type: string
        eventCategory:
          description: >
            If you specify this field, the email template is created based on a
            standard event. See [Standard Event
            Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API)
            for all standard event category codes.    
          type: number
        eventTypeName:
          description: >
            The name of the custom event or custom scheduled event. If you
            specify this field, the email template is created based on the
            corresponding custom event or custom scheduled event.
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field. The `eventTypeName` has
            the `user.notification` namespace by default. 


            Note that if the `eventTypeName` is a standard event type, you must
            specify the `com.zuora.notification` namespace; otherwise, you will
            get an error.


            For example, if you want to create an email template on the
            `OrderActionProcessed` event, you must specify
            `com.zuora.notification` for this field.         
          type: string
        fromEmailAddress:
          description: If fromEmailType is SpecificEmail, this field is required.
          type: string
        fromEmailType:
          description: The type of the email.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        fromName:
          description: The name of the email sender.
          type: string
        id:
          description: >
            ID of an existing email template. Specify this field if you want to
            update an existing email template.
          type: string
        isHtml:
          default: false
          description: >-
            Indicates whether the style of email body is HTML. The default value
            is `false`.
          type: boolean
        name:
          description: The name of the email template, a unique name in a tenant.
          maxLength: 255
          type: string
        replyToEmailAddress:
          description: If `replyToEmailType` is `SpecificEmail`, this field is required.
          type: string
        replyToEmailType:
          description: Type of the replyTo email.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        toEmailAddress:
          description: If toEmailType is SpecificEmail, this field is required.
          type: string
        toEmailType:
          description: >
            Email receive type.


            - When the related event is account-level and associated with the
            Subscription object, such as Subscription Created, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
              - InvoiceOwnerBillToContact
              - InvoiceOwnerSoldToContact
              - InvoiceOwnerShipToContact
              - InvoiceOwnerBillToAndSoldToContacts
              - InvoiceOwnerAllContacts
            - When the related event is account-level and not associated with
            the Subscription object, such as Payment Processed, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
            - When the related event is tenant-level, such as Bill Run
            Completion, you can use the following values:
              - TenantAdmin
              - RunOwner
              - SpecificEmails
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
      required:
        - name
        - fromEmailType
        - emailSubject
        - emailBody
        - toEmailType
      type: object
    POSTCreateOrUpdateEmailTemplateRequest:
      properties:
        allowPartialSuccess:
          description: >
            When set to `false`, the call will fail if one or multiple instances
            fail to import, and a `200` response is returned if all email
            templates have been successfully updated.

            When set to `true`, a success (`200`) response is returned if one or
            more instances have imported successfully. All failed instances are
            also returned in the response.
          type: boolean
        emailTemplates:
          description: |
            A container for email templates.
          items:
            $ref: '#/components/schemas/POSTCreateOrUpdateEmailTemplateRequestFormat'
          type: array
      type: object
    CreateOrUpdateEmailTemplatesResponse:
      example:
        reasons: []
      properties:
        reasons:
          description: |
            Returns an empty array if the request succeeds.
          items:
            type: string
          type: array
      type: object
    GETPublicEmailTemplateResponse:
      example:
        id: f11e498862584a10a05b83ea70119659
        createdBy: 8ad084a67f9c7138017fab8a8b511b5a
        createdOn: 2024-11-06T09:24:07.000 UTC
        updatedBy: 8ad084a67f9c7138017fab8a8b511b5a
        updatedOn: 2024-11-06T09:24:07.000 UTC
        eventTypeNamespace: user.notification
        eventTypeName: AccountEdit
        name: Account Edit Email
        description: ''
        encodingType: UTF8
        fromName: Company Co. Ltd.
        fromEmailType: TenantEmail
        fromEmailAddress: ''
        replyToEmailType: TenantEmail
        replyToEmailAddress: ''
        ccEmailType: SpecificEmails
        ccEmailAddress: ''
        bccEmailAddress: ''
        toEmailType: BillToContact
        toEmailAddress: ''
        emailHeaders: {}
        emailSubject: Account {{DataSource.Account.AccountNumber}} has been edited
        emailBody: >-
          Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been
          edited. <p>Company Co. Ltd.
        fileId: ''
        active: true
        isHtml: false
        useAdditionalAddresses: false
      properties:
        active:
          description: The status of the email template.
          type: boolean
        bccEmailAddress:
          description: Email BCC address.
          format: email
          type: string
        ccEmailAddress:
          description: Email CC address.
          type: string
        ccEmailType:
          default: SpecificEmails
          description: Email cc type.
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
        createdBy:
          description: The ID of the user who created the email template.
          format: uuid
          type: string
        createdOn:
          description: >-
            The time when the email template was created. Specified in the UTC
            timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g.
            1997-07-16T19:20:30.45+00:00
          format: date-time
          type: string
        description:
          description: The description of the email template.
          maxLength: 255
          type: string
        emailBody:
          description: >
            The email body. You can add merge fields in the email body using
            angle brackets or double curly brackets. For more information, see
            <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>. 


            User can also embed html tags if `isHtml` is `true`.
          type: string
        emailHeaders:
          type: object
          title: emailHeader
          description: >
            Container for custom email headers. Each custom email header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom email header consists of a name-value pair:


              * Field name: the name of the custom email header.


              * Field value: the value of the custom email header. You can add
              merge fields in the field value. For more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email templates</a>.
        emailSubject:
          description: >
            The email subject. You can add merge fields in the email subject
            using angle brackets or double curly brackets. For more information,
            see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>.
          type: string
        encodingType:
          description: The endcode type of the email body.
          enum:
            - UTF8
            - Shift_JIS
            - ISO_2022_JP
            - EUC_JP
            - X_SJIS_0213
          type: string
        eventCategory:
          description: >-
            The event category code for a standard event. See [Standard Event
            Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API)
            for all event category codes.
          type: number
        eventTypeName:
          description: The name of the custom event or custom scheduled event.
          minLength: 1
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field for custom events and
            custom scheduled events. 
          type: string
        fromEmailAddress:
          description: If formEmailType is SpecificEmail, this field is required.
          type: string
        fromEmailType:
          description: The from email type.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        fromName:
          description: The name of email sender.
          maxLength: 50
          type: string
        id:
          description: The email template ID.
          format: uuid
          type: string
        isHtml:
          description: Indicates whether the style of email body is HTML.
          type: boolean
        name:
          description: The name of the email template.
          maxLength: 255
          type: string
        replyToEmailAddress:
          description: If replyToEmailType is SpecificEmail, this field is required
          type: string
        replyToEmailType:
          description: The reply email type.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        toEmailAddress:
          description: If `toEmailType` is `SpecificEmail`, this field is required.
          type: string
        toEmailType:
          description: Email receive type.
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
        updatedBy:
          description: The ID of the user who updated the email template.
          format: uuid
          type: string
        updatedOn:
          description: >-
            The time when the email template was updated. Specified in the UTC
            timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g.
            1997-07-16T19:20:30.45+00:00
          format: date-time
          type: string
      type: object
    POSTPublicEmailTemplateRequest:
      example:
        name: Account Edit Email
        eventTypeName: AccountEdit
        active: true
        fromName: Company Co. Ltd.
        fromEmailType: TenantEmail
        toEmailType: BillToContact
        replyToEmailType: TenantEmail
        emailSubject: Account {{DataSource.Account.AccountNumber}} has been edited
        emailBody: >-
          Dear user,<p>the account {{DataSource.Account.AccountNumber}} has been
          edited. <p>Company Co. Ltd.
      properties:
        active:
          default: true
          description: The status of the email template. The default value is `true`.
          type: boolean
        bccEmailAddress:
          description: The email bcc address.
          format: email
          type: string
        ccEmailAddress:
          description: The email CC address.
          type: string
        ccEmailType:
          default: SpecificEmails
          description: >
            Email CC type.


            - When the related event is account-level and associated with the
            Subscription object, such as Subscription Created, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
              - InvoiceOwnerBillToContact
              - InvoiceOwnerSoldToContact
              - InvoiceOwnerShipToContact
              - InvoiceOwnerBillToAndSoldToContacts
              - InvoiceOwnerAllContacts
            - When the related event is account-level and not associated with
            the Subscription object, such as Payment Processed, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
            - When the related event is tenant-level, such as Bill Run
            Completion, you can use the following values:
              - TenantAdmin
              - RunOwner
              - SpecificEmails
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
        description:
          description: The description of the email template.
          maxLength: 255
          type: string
        emailBody:
          description: >
            The email body. You can add merge fields in the email body using
            angle brackets or double curly brackets. For more information, see
            <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>.


            You can also embed HTML tags if `isHtml` is `true`.
          type: string
        emailHeaders:
          type: object
          title: emailHeader
          description: >
            Container for custom email headers. Each custom email header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom email header consists of a name-value pair:


              * Field name: the name of the custom email header.


              * Field value: the value of the custom email header. You can add
              merge fields in the field value. For more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email templates</a>.
        emailSubject:
          description: >
            The email subject. You can add merge fields in the email subject
            using angle brackets or double curly brackets. For more information,
            see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>.
          type: string
        encodingType:
          default: UTF8
          description: The endcode type of the email body.
          enum:
            - UTF8
            - Shift_JIS
            - ISO_2022_JP
            - EUC_JP
            - X_SJIS_0213
          type: string
        eventCategory:
          description: >
            If you specify this field, the email template is created based on a
            standard event. See [Standard Event
            Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API)
            for all standard event category codes. 
          type: number
        eventTypeName:
          description: >
            The name of the custom event or custom scheduled event. If you
            specify this field, the email template is created based on the
            corresponding custom event or custom scheduled event.
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field. The `eventTypeName` has
            the `user.notification` namespace by default. 


            Note that if the `eventTypeName` is a standard event type, you must
            specify the `com.zuora.notification` namespace; otherwise, you will
            get an error.


            For example, if you want to create an email template on the
            `OrderActionProcessed` event, you must specify
            `com.zuora.notification` for this field.         
          type: string
        fromEmailAddress:
          description: If fromEmailType is SpecificEmail, this field is required.
          type: string
        fromEmailType:
          description: The type of the email.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        fromName:
          description: The name of the email sender.
          type: string
        isHtml:
          default: false
          description: >-
            Indicates whether the style of email body is HTML. The default value
            is `false`.
          type: boolean
        name:
          description: The name of the email template, a unique name in a tenant.
          maxLength: 255
          type: string
        replyToEmailAddress:
          description: If replyToEmailType is SpecificEmail, this field is required.
          type: string
        replyToEmailType:
          description: Type of the replyTo email.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        toEmailAddress:
          description: If toEmailType is SpecificEmail, this field is required.
          type: string
        toEmailType:
          description: >
            Email receive type.


            - When the related event is account-level and associated with the
            Subscription object, such as Subscription Created, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
              - InvoiceOwnerBillToContact
              - InvoiceOwnerSoldToContact
              - InvoiceOwnerShipToContact
              - InvoiceOwnerBillToAndSoldToContacts
              - InvoiceOwnerAllContacts
            - When the related event is account-level and not associated with
            the Subscription object, such as Payment Processed, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
            - When the related event is tenant-level, such as Bill Run
            Completion, you can use the following values:
              - TenantAdmin
              - RunOwner
              - SpecificEmails
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
      required:
        - name
        - fromEmailType
        - emailSubject
        - emailBody
        - toEmailType
      type: object
    PUTPublicEmailTemplateRequest:
      example:
        description: Details of the email template
      properties:
        active:
          description: The status of the email template.
          type: boolean
        bccEmailAddress:
          description: Email bcc address.
          format: email
          type: string
        ccEmailAddress:
          description: Email cc address.
          type: string
        ccEmailType:
          default: SpecificEmails
          description: >
            Email CC type.


            - When the related event is account-level and associated with the
            Subscription object, such as Subscription Created, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
              - InvoiceOwnerBillToContact
              - InvoiceOwnerSoldToContact
              - InvoiceOwnerShipToContact
              - InvoiceOwnerBillToAndSoldToContacts
              - InvoiceOwnerAllContacts
            - When the related event is account-level and not associated with
            the Subscription object, such as Payment Processed, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
            - When the related event is tenant-level, such as Bill Run
            Completion, you can use the following values:
              - TenantAdmin
              - RunOwner
              - SpecificEmails
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
        description:
          description: The description of the email template.
          maxLength: 255
          type: string
        emailBody:
          description: >
            The email body. You can add merge fields in the email body using
            angle brackets or double curly brackets. For more information, see
            <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>. 


            User can also embed html tags if `isHtml` is `true`.
          type: string
        emailHeaders:
          type: object
          title: emailHeader
          description: >
            Container for custom email headers. Each custom email header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom email header consists of a name-value pair:


              * Field name: the name of the custom email header.


              * Field value: the value of the custom email header. You can add
              merge fields in the field value. For more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email templates</a>.
        emailSubject:
          description: >
            The email subject. You can add merge fields in the email subject
            using angle brackets or double curly brackets. For more information,
            see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email templates</a>.
          type: string
        encodingType:
          description: The endcode type of the email body.
          enum:
            - UTF8
            - Shift_JIS
            - ISO_2022_JP
            - EUC_JP
            - X_SJIS_0213
          type: string
        fromEmailAddress:
          description: If fromEmailType is SpecificEmail, this field is required
          type: string
        fromEmailType:
          description: The type of fromEmail.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        fromName:
          description: The name of email sender.
          type: string
        isHtml:
          description: Indicates whether the style of email body is HTML.
          type: boolean
        name:
          description: The name of the email template.
          maxLength: 255
          type: string
        replyToEmailAddress:
          description: If replyToEmailType is SpecificEmail, this field is required.
          type: string
        replyToEmailType:
          description: The type of the reply email.
          enum:
            - TenantEmail
            - RunOwner
            - SpecificEmail
          type: string
        toEmailAddress:
          description: If toEmailType is SpecificEmail, this field is required.
          type: string
        toEmailType:
          description: >-
            Email receive type.

            - When the related event is account-level and associated with the
            Subscription object, such as Subscription Created, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
              - InvoiceOwnerBillToContact
              - InvoiceOwnerSoldToContact
              - InvoiceOwnerShipToContact
              - InvoiceOwnerBillToAndSoldToContacts
              - InvoiceOwnerAllContacts
            - When the related event is account-level and not associated with
            the Subscription object, such as Payment Processed, you can use the
            following values:
              - BillToContact
              - SoldToContact
              - ShipToContact
              - BillToAndSoldToContacts
              - AllContacts
              - SpecificEmails
            - When the related event is tenant-level, such as Bill Run
            Completion, you can use the following values:
              - TenantAdmin
              - RunOwner
              - SpecificEmails
          enum:
            - BillToContact
            - SoldToContact
            - ShipToContact
            - SpecificEmails
            - TenantAdmin
            - BillToAndSoldToContacts
            - RunOwner
            - AllContacts
            - InvoiceOwnerBillToContact
            - InvoiceOwnerSoldToContact
            - InvoiceOwnerShipToContact
            - InvoiceOwnerBillToAndSoldToContacts
            - InvoiceOwnerAllContacts
          type: string
      type: object
    POSTCreateOrUpdateCalloutTemplateRequestCommon:
      title: Callout - without authentication
      description: |
        Common information for callout templates.
      properties:
        active:
          default: true
          description: The status of the callout. The default is `true`.
          type: boolean
        calloutBaseurl:
          description: >
            The callout URL. It must start with `https://`.


            Zuora uses port 443 to send callout notifications by default. If you
            want to use other ports, submit a request at <a
            href="http://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.


            You can add merge fields in the callout URL. For example,
            `https://mywebsite.com/zuora/{{DataSource.Account.Id}}`. For more
            information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.
          example: https://***
          format: url
          minLength: 10
          type: string
        calloutHeaders:
          type: object
          title: calloutHeader
          description: >
            Container for custom callout headers. Each custom callout header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom callout header consists of a key-value pair:


              * Field key: the name of the custom callout header.

              * Field value: the value of the custom callout header.


              You can add merge fields in the field name or value. For more
              information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.
        calloutParams:
          type: object
          title: calloutParameter
          description: >
            Container for callout parameters sent in the request body. Each
            callout parameter consists of a parameter name and a parameter
            value.
          additionalProperties:
            type: string
            description: >
              The callout parameter consists of a key-value pair:


              * Field key: the name of the callout parameter.

              * Field value: the value of the callout parameter.


              You can add merge fields in the field name or value. For example,
              `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For
              more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.


              Alternatively, you can use the `customRequestBody` field for
              JSON-formatted callout parameters sent in the callout body.
        calloutRetry:
          default: true
          description: >-
            Specified whether to retry the callout when the callout fails. The
            default value is `true`.
          type: boolean
        certificate:
          type: string
          description: >
            The SSL certificate for the domain of the callout receiver server
            specified in `calloutBaseurl`.


            The value must be in PEM format, which typically starts with
            `-----BEGIN CERTIFICATE-----` and ends with `-----END
            CERTIFICATE-----`.


            Specifying the SSL certificate can eliminate SSL certificate errors
            (HTTP status code 495) for callout notifications.
        confirmSuccessFromResponseContent:
          type: boolean
          default: false
          description: >
            Indicates how Zuora determines whether callout notifications to your
            system succeed or fail:


            * If `false`, Zuora determines the result based solely on the HTTP
            response status code. This is the default value.


            * If `true`, and the HTTP response status code is 200, Zuora
            evaluates the callout response and considers the notification
            successful only if the `Content-Type` header is set to
            `application/json`, and the response body contains a `success` field
            set to `true`.
        customRequestBody:
          type: string
          description: >
            Customized request body. This field is available only for callouts
            whose Content-Type in the request body is `application/json`. The
            value must be in JSON format and double quotes in the value must be
            escaped.


            You can add merge fields to the request body. For example,
            `{\"AccountNumber\":
            \"{{DataSource.Account.AccountNumber}}\",\"AccountId\":
            \"{{DataSource.Account.Id}}\"}`. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.


            You must set `useCustomRequestBody` to `true` if you want to
            customize the callout request body with this field. Alternatively,
            you can use the `calloutParams` field.
        description:
          description: Description for the callout template.
          maxLength: 255
          type: string
        eventCategory:
          description: >
            The event category code for a standard event that the callout
            template relates to.


            This field is required when creating callout templates for standard
            events.


            For the list of supported standard event category codes, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
            target="_blank">Standard event category code for events and
            notifications</a>.
          type: number
        eventTypeName:
          description: >
            The name of a custom event that the callout template relates to.


            This field is required when creating callout templates for Zuora
            custom events, custom events, or custom scheduled events.


            If this field is provided, you can specify the event namespace in
            the `eventTypeNamespace` field. 
          minLength: 1
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field. It indicates who created
            the event and which namespace the event is assigned to.


            Supported values are as follows:


            - `com.zuora.notification`: events that are created by Zuora. This
            value applies to Zuora custom events.

            - `user.notification`: events that are created by tenant users. This
            value applies to custom events and custom scheduled events. This is
            the default value. 
                      
            For example, if you want to create a callout template that relates
            to the `OrderActionProcessed` event, which is a Zuora custom event,
            you must specify `com.zuora.notification` for this field.
          type: string
          enum:
            - user.notification
            - com.zuora.notification
          default: user.notification
        hmacAlgorithm:
          type: string
          description: >
            The hash function Zuora uses to generate the signed data for HMAC
            authentication.
          enum:
            - MD5
            - SHA-1
            - SHA-224
            - SHA-256
            - SHA-384
            - SHA-512
        hmacData:
          type: string
          description: >
            The message to be authenticated for HMAC authentication.


            You can use merge fields in this value:


            - `{{Request.Headers.<header_name>}}`: Refers to the value of a
            particular request header. For example, `{{Request.Headers.Date}}`
            refers to the value of the request header called `Date`.

            - `{{Request.Body}}`: Refers to the request body.

            - Other merge fields: See <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Extensibility/Events_and_Notifications/AF_Manage_email_and_callout_templates/C_Merge_field_syntax_for_email_and_callout_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.
        hmacKey:
          type: string
          description: >
            The header key that Zuora uses to send the header value for HMAC
            authentication. The header value is specified in the `hmacValue`
            field and typically contains the signed data.
        hmacOutputFormat:
          type: string
          description: |
            The format of the signed data for HMAC authentication.
          enum:
            - BASE64
            - HEX
        hmacSecret:
          type: string
          description: >
            The shared secret key that Zuora uses to generate the signed data
            for HMAC authentication.
        hmacValue:
          type: string
          description: >
            The header value for HMAC authentication. The header key is
            specified in the `hmacKey` field.


            You can use merge fields in this value:


            - `{{Request.HMAC.Signed}}`: Refers to the signed data.

            - Other merge fields: See <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Extensibility/Events_and_Notifications/AF_Manage_email_and_callout_templates/C_Merge_field_syntax_for_email_and_callout_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.


            The following is a header value example: `The algorithm is SHA-256
            and the signed data is {{Request.HMAC.Signed}}`.
        httpMethod:
          description: The HTTP method of the callout.
          enum:
            - POST
            - GET
            - PUT
            - PATCH
            - DELETE
          example: POST
          type: string
        id:
          description: >
            ID of an existing callout template. Specify this field if you want
            to update an existing callout template.
          type: string
        name:
          description: >-
            The name of the callout template. It must be unique across all
            callout templates.
          maxLength: 255
          type: string
        useCustomRequestBody:
          type: boolean
          description: >
            Indicates whether to enable the customized request body configured
            in the `customRequestBody` field.
      required:
        - name
        - calloutBaseurl
        - httpMethod
      type: object
    POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication:
      title: Callout - Base authentication
      allOf:
        - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon'
        - type: object
          description: |
            The Basic Authentication information for callout notifications.
          properties:
            requiredAuth:
              description: >
                Indicates whether Basic authentication is enabled for the
                callout.


                When creating callout notifications with Basic authentication
                enabled, you must set this field to `true` and specify the
                username and password in `calloutAuth`.
              type: boolean
            calloutAuth:
              $ref: '#/components/schemas/CalloutAuth'
    POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication:
      title: Callout - OAuth 2.0 authentication
      allOf:
        - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon'
        - type: object
          description: |
            The OAuth 2.0 Authentication information for callout notifications.
          properties:
            requiredOauth2:
              description: >
                Indicates whether OAuth 2.0 authentication is enabled for the
                callout.


                When creating callout notifications with OAuth 2.0
                authentication enabled, you must set this field to `true` and
                specify the OAuth 2.0 provider ID in `oauth2ProviderId`.
              type: boolean
            oauth2ProviderId:
              description: >
                The ID of the OAuth 2.0 provider in your tenant that provides
                access tokens for the callout. This field is required if
                `requiredOauth2` is `true`.


                For more information about how to get the ID of an OAuth 2.0
                provider, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Add_an_OAuth_2.0_Provider#Retrieve_the_ID_of_an_OAuth_2.0_provider"
                target="_blank">Retrieve the ID of an OAuth 2.0 provider</a>.
    POSTCreateOrUpdateCalloutTemplateRequest:
      example:
        allowPartialSuccess: true
        calloutTemplates:
          - name: Account Edit
            eventTypeName: AccountEdit
            calloutBaseurl: https://www.example.com/callout/AccountEdit
            httpMethod: POST
          - name: Account Delete
            eventTypeName: AccountDelete
            calloutBaseurl: https://www.example.com/callout/AccountDelete
            httpMethod: POST
      properties:
        allowPartialSuccess:
          description: >
            When set to `false`, the call will fail if one or multiple instances
            fail to import, and a `200` response is returned if all callout
            templates have been successfully updated.

            When set to `true`, a success (`200`) response is returned if one or
            more instances have imported successfully. All failed instances are
            also returned in the response.
          type: boolean
        calloutTemplates:
          description: |
            A container for callout templates.
          items:
            oneOf:
              - $ref: >-
                  #/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon
              - $ref: >-
                  #/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication
              - $ref: >-
                  #/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication
          type: array
      type: object
    GETPublicCalloutTemplateResponse:
      properties:
        active:
          description: The status of the callout template.
          type: boolean
        calloutAuth:
          $ref: '#/components/schemas/CalloutAuth'
        calloutBaseurl:
          description: The callout URL.
          example: https://***
          format: url
          minLength: 10
          type: string
        calloutHeaders:
          type: object
          title: calloutHeader
          description: >
            Container for custom callout headers. Each custom callout header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom callout header consists of a key-value pair:


              * Field name: the name of the custom callout header.

              * Field value: the value of the custom callout header.


              You can add merge fields in the field name or value. For more
              information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.
          nullable: true
        calloutParams:
          type: object
          title: calloutParameter
          description: >
            Container for callout parameters sent in the request body. Each
            callout parameter consists of a parameter name and a parameter
            value.
          additionalProperties:
            type: string
            description: >
              The callout parameter consists of a key-value pair:


              * Field key: the name of the callout parameter.

              * Field value: the value of the callout parameter.


              You can add merge fields in the field name or value. For example,
              `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For
              more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.
          nullable: true
        calloutRetry:
          description: Indicates whether to retry the callout when the callout fails.
          type: boolean
        certificate:
          type: string
          nullable: true
          description: >
            The SSL certificate for the domain of the callout receiver server
            specified in `calloutBaseurl`.
        confirmSuccessFromResponseContent:
          type: boolean
          description: >
            Indicates how Zuora determines whether callout notifications to your
            system succeed or fail:


            * If `false`, Zuora determines the result based solely on the HTTP
            response status code. This is the default value.


            * If `true`, and the HTTP response status code is 200, Zuora
            evaluates the callout response and considers the notification
            successful only if the `Content-Type` header is set to
            `application/json`, and the response body contains a `success` field
            set to `true`.
        contentType:
          type: string
          description: The callout body format.
        createdBy:
          description: The ID of the user who created the callout template.
          format: uuid
          type: string
        createdOn:
          description: >-
            The time when the callout template was created. Specified in the UTC
            timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g.
            1997-07-16T19:20:30.45+00:00
          format: date-time
          type: string
        customRequestBody:
          type: string
          description: |
            Customized request body.
          nullable: true
        description:
          description: Description for the callout template.
          maxLength: 255
          type: string
        eventCategory:
          description: >
            The event category code for the standard event that the callout
            template relates to.


            This field is available only if the related event of this callout
            template is a standard event.


            For the list of supported standard event category codes, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
            target="_blank">Standard event category code for events and
            notifications</a>.
          type: number
        eventTypeName:
          description: >
            The name of the custom event that the callout template relates to.


            This field is available only if the related event of this callout
            template is a Zuora custom event, custom event, or custom scheduled
            event.
          minLength: 1
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field. It indicates who created
            the event and which namespace the event is assigned to.


            Supported values are as follows:


            - `com.zuora.notification`: events that are created by Zuora. This
            value applies to Zuora custom events.

            - `user.notification`: events that are created by tenant users. This
            value applies to custom events and custom scheduled events. This is
            the default value. 
                      
            This field is available only if the related event of this callout
            template is a Zuora custom event, custom event, or custom scheduled
            event.
          type: string
          enum:
            - user.notification
            - com.zuora.notification
        hmacAlgorithm:
          type: string
          nullable: true
          description: >
            The hash function Zuora uses to generate the signed data for HMAC
            authentication.
          enum:
            - MD5
            - SHA-1
            - SHA-224
            - SHA-256
            - SHA-384
            - SHA-512
            - null
        hmacData:
          type: string
          nullable: true
          description: |
            The message to be authenticated for HMAC authentication.
        hmacKey:
          type: string
          nullable: true
          description: >
            The header key that Zuora uses to send the header value for HMAC
            authentication. The header value is specified in the `hmacValue`
            field and typically contains the signed data.
        hmacOutputFormat:
          type: string
          nullable: true
          description: |
            The format of the signed data for HMAC authentication.
          enum:
            - BASE64
            - HEX
            - null
        hmacSecret:
          type: string
          nullable: true
          description: >
            The shared secret key that Zuora uses to generate the signed data
            for HMAC authentication.
        hmacValue:
          type: string
          nullable: true
          description: >
            The header value for HMAC authentication. The header key is
            specified in the `hmacKey` field.
        httpMethod:
          description: The HTTP method of the callout.
          enum:
            - POST
            - GET
            - PUT
            - PATCH
            - DELETE
          example: POST
          type: string
        id:
          description: |
            The ID of the callout template.
          format: uuid
          type: string
        name:
          description: The name of the callout template.
          maxLength: 255
          type: string
        oauth2ProviderId:
          description: >-
            The ID of the OAuth 2.0 provider in your tenant that provides access
            tokens for the callout.
          type: string
          nullable: true
        requiredAuth:
          description: Indicates whether Basic authentication is enabled for the callout.
          type: boolean
        requiredOauth2:
          description: >-
            Indicates whether OAuth 2.0 authentication is enabled for the
            callout.
          type: boolean
        updatedBy:
          description: The ID of the user who updated the callout template.
          format: uuid
          type: string
        updatedOn:
          description: >-
            The time when the callout template was updated. Specified in the UTC
            timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g.
            1997-07-16T19:20:30.45+00:00
          format: date-time
          type: string
        useCustomRequestBody:
          type: boolean
          description: >
            Indicates whether to enable the customized request body configured
            in the `customRequestBody` field.
      type: object
    POSTPublicCalloutTemplateRequestCommon:
      title: Callout - without authentication
      description: |
        Common information for callout templates.
      properties:
        active:
          default: true
          description: The status of the callout. The default is `true`.
          type: boolean
        calloutBaseurl:
          description: >
            The callout URL. It must start with `https://`.


            Zuora uses port 443 to send callout notifications by default. If you
            want to use other ports, submit a request at <a
            href="http://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.


            You can add merge fields in the callout URL. For example,
            `https://mywebsite.com/zuora/{{DataSource.Account.Id}}`. For more
            information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.
          example: https://***
          format: url
          minLength: 10
          type: string
        calloutHeaders:
          type: object
          title: calloutHeader
          description: >
            Container for custom callout headers. Each custom callout header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom callout header consists of a key-value pair:


              * Field key: the name of the custom callout header.

              * Field value: the value of the custom callout header.


              You can add merge fields in the field name or value. For more
              information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.
        calloutParams:
          type: object
          title: calloutParameter
          description: >
            Container for callout parameters sent in the request body. Each
            callout parameter consists of a parameter name and a parameter
            value.
          additionalProperties:
            type: string
            description: >
              The callout parameter consists of a key-value pair:


              * Field key: the name of the callout parameter.

              * Field value: the value of the callout parameter.


              You can add merge fields in the field name or value. For example,
              `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For
              more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.


              Alternatively, you can use the `customRequestBody` field for
              JSON-formatted callout parameters sent in the callout body.
        calloutRetry:
          default: true
          description: >-
            Specified whether to retry the callout when the callout fails. The
            default value is `true`.
          type: boolean
        certificate:
          type: string
          description: >
            The SSL certificate for the domain of the callout receiver server
            specified in `calloutBaseurl`.


            The value must be in PEM format, which typically starts with
            `-----BEGIN CERTIFICATE-----` and ends with `-----END
            CERTIFICATE-----`.


            Specifying the SSL certificate can eliminate SSL certificate errors
            (HTTP status code 495) for callout notifications.
        confirmSuccessFromResponseContent:
          type: boolean
          default: false
          description: >
            Indicates how Zuora determines whether callout notifications to your
            system succeed or fail:


            * If `false`, Zuora determines the result based solely on the HTTP
            response status code. This is the default value.


            * If `true`, and the HTTP response status code is 200, Zuora
            evaluates the callout response and considers the notification
            successful only if the `Content-Type` header is set to
            `application/json`, and the response body contains a `success` field
            set to `true`.
        customRequestBody:
          type: string
          description: >
            Customized request body. This field is available only for callouts
            whose Content-Type in the request body is `application/json`. The
            value must be in JSON format and double quotes in the value must be
            escaped.


            You can add merge fields to the request body. For example,
            `{\"AccountNumber\":
            \"{{DataSource.Account.AccountNumber}}\",\"AccountId\":
            \"{{DataSource.Account.Id}}\"}`. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.


            You must set `useCustomRequestBody` to `true` if you want to
            customize the callout request body with this field. Alternatively,
            you can use the `calloutParams` field.
        description:
          description: Description for the callout template.
          maxLength: 255
          type: string
        eventCategory:
          description: >
            The event category code for a standard event that the callout
            template relates to.


            This field is required when creating callout templates for standard
            events.


            For the list of supported standard event category codes, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Events_and_Notifications"
            target="_blank">Standard event category code for events and
            notifications</a>.
          type: number
        eventTypeName:
          description: >
            The name of a custom event that the callout template relates to.


            This field is required when creating callout templates for Zuora
            custom events, custom events, or custom scheduled events.


            If this field is provided, you can specify the event namespace in
            the `eventTypeNamespace` field. 
          minLength: 1
          type: string
        eventTypeNamespace:
          description: >
            The namespace of the `eventTypeName` field. It indicates who created
            the event and which namespace the event is assigned to.


            Supported values are as follows:


            - `com.zuora.notification`: events that are created by Zuora. This
            value applies to Zuora custom events.

            - `user.notification`: events that are created by tenant users. This
            value applies to custom events and custom scheduled events. This is
            the default value. 
                      
            For example, if you want to create a callout template that relates
            to the `OrderActionProcessed` event, which is a Zuora custom event,
            you must specify `com.zuora.notification` for this field.
          type: string
          enum:
            - user.notification
            - com.zuora.notification
          default: user.notification
        hmacAlgorithm:
          type: string
          description: >
            The hash function Zuora uses to generate the signed data for HMAC
            authentication.
          enum:
            - MD5
            - SHA-1
            - SHA-224
            - SHA-256
            - SHA-384
            - SHA-512
        hmacData:
          type: string
          description: >
            The message to be authenticated for HMAC authentication.


            You can use merge fields in this value:


            - `{{Request.Headers.<header_name>}}`: Refers to the value of a
            particular request header. For example, `{{Request.Headers.Date}}`
            refers to the value of the request header called `Date`.

            - `{{Request.Body}}`: Refers to the request body.

            - Other merge fields: See <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Extensibility/Events_and_Notifications/AF_Manage_email_and_callout_templates/C_Merge_field_syntax_for_email_and_callout_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.
        hmacKey:
          type: string
          description: >
            The header key that Zuora uses to send the header value for HMAC
            authentication. The header value is specified in the `hmacValue`
            field and typically contains the signed data.
        hmacOutputFormat:
          type: string
          description: |
            The format of the signed data for HMAC authentication.
          enum:
            - BASE64
            - HEX
        hmacSecret:
          type: string
          description: >
            The shared secret key that Zuora uses to generate the signed data
            for HMAC authentication.
        hmacValue:
          type: string
          description: >
            The header value for HMAC authentication. The header key is
            specified in the `hmacKey` field.


            You can use merge fields in this value:


            - `{{Request.HMAC.Signed}}`: Refers to the signed data.

            - Other merge fields: See <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Extensibility/Events_and_Notifications/AF_Manage_email_and_callout_templates/C_Merge_field_syntax_for_email_and_callout_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.


            The following is a header value example: `The algorithm is SHA-256
            and the signed data is {{Request.HMAC.Signed}}`.
        httpMethod:
          description: The HTTP method of the callout.
          enum:
            - POST
            - GET
            - PUT
            - PATCH
            - DELETE
          example: POST
          type: string
        name:
          description: >-
            The name of the callout template. It must be unique across all
            callout templates.
          maxLength: 255
          type: string
        useCustomRequestBody:
          type: boolean
          description: >
            Indicates whether to enable the customized request body configured
            in the `customRequestBody` field.
      required:
        - name
        - calloutBaseurl
        - httpMethod
      type: object
    POSTPublicCalloutTemplateRequestBasicAuthentication:
      title: Callout - Base authentication
      allOf:
        - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon'
        - type: object
          description: |
            The Basic Authentication information for callout templates.
          properties:
            requiredAuth:
              description: >
                Indicates whether Basic authentication is enabled for the
                callout.


                When creating callout templates with Basic authentication
                enabled, you must set this field to `true` and specify the
                username and password in `calloutAuth`.
              type: boolean
            calloutAuth:
              $ref: '#/components/schemas/CalloutAuth'
          required:
            - requiredAuth
    POSTPublicCalloutTemplateRequestOauth2Authentication:
      title: Callout - OAuth 2.0 authentication
      allOf:
        - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon'
        - type: object
          description: |
            The OAuth 2.0 Authentication information for callout templates.
          properties:
            requiredOauth2:
              description: >
                Indicates whether OAuth 2.0 authentication is enabled for the
                callout.


                When creating callout templates with OAuth 2.0 authentication
                enabled, you must set this field to `true` and specify the OAuth
                2.0 provider ID in `oauth2ProviderId`.
              type: boolean
            oauth2ProviderId:
              description: >
                The ID of the OAuth 2.0 provider in your tenant that provides
                access tokens for the callout. This field is required if
                `requiredOauth2` is `true`.


                For more information about how to get the ID of an OAuth 2.0
                provider, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Add_an_OAuth_2.0_Provider#Retrieve_the_ID_of_an_OAuth_2.0_provider"
                target="_blank">Retrieve the ID of an OAuth 2.0 provider</a>.
          required:
            - requiredOauth2
    POSTPublicCalloutTemplateRequest:
      oneOf:
        - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon'
        - $ref: >-
            #/components/schemas/POSTPublicCalloutTemplateRequestBasicAuthentication
        - $ref: >-
            #/components/schemas/POSTPublicCalloutTemplateRequestOauth2Authentication
    PUTPublicCalloutTemplateRequestCommon:
      title: Callout - without authentication
      description: |
        Common information for callout templates.
      properties:
        active:
          default: true
          description: The status of the callout.
          type: boolean
        calloutBaseurl:
          description: >
            The callout URL. It must start with `https://`.


            Zuora uses port 443 to send callout notifications by default. If you
            want to use other ports, submit a request at <a
            href="http://support.zuora.com/" target="_blank">Zuora Global
            Support</a>.


            You can add merge fields in the callout URL. For example,
            `https://mywebsite.com/zuora/{{DataSource.Account.Id}}`. For more
            information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.
          example: https://***
          format: url
          minLength: 10
          type: string
        calloutHeaders:
          type: object
          title: calloutHeader
          description: >
            Container for custom callout headers. Each custom callout header
            consists of a header name and a header value.
          additionalProperties:
            type: string
            description: >
              The custom callout header consists of a key-value pair:


              * Field key: the name of the custom callout header.

              * Field value: the value of the custom callout header.


              You can add merge fields in the field name or value. For more
              information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.
        calloutParams:
          type: object
          title: calloutParameter
          description: >
            Container for callout parameters sent in the request body. Each
            callout parameter consists of a parameter name and a parameter
            value.
          additionalProperties:
            type: string
            description: >
              The callout parameter consists of a key-value pair:


              * Field key: the name of the callout parameter.

              * Field value: the value of the callout parameter.


              You can add merge fields in the field name or value. For example,
              `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For
              more information, see <a
              href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
              target="_blank">Merge field syntax for email and callout
              templates</a>.


              Alternatively, you can use the `customRequestBody` field for
              JSON-formatted callout parameters sent in the callout body.
        calloutRetry:
          default: true
          description: >-
            Specified whether to retry the callout when the callout fails. The
            default value is `true`.
          type: boolean
        certificate:
          type: string
          description: >
            The SSL certificate for the domain of the callout receiver server
            specified in `calloutBaseurl`.


            The value must be in PEM format, which typically starts with
            `-----BEGIN CERTIFICATE-----` and ends with `-----END
            CERTIFICATE-----`.


            Specifying the SSL certificate can eliminate SSL certificate errors
            (HTTP status code 495) for callout notifications.
        confirmSuccessFromResponseContent:
          type: boolean
          default: false
          description: >
            Indicates how Zuora determines whether callout notifications to your
            system succeed or fail:


            * If `false`, Zuora determines the result based solely on the HTTP
            response status code. This is the default value.


            * If `true`, and the HTTP response status code is 200, Zuora
            evaluates the callout response and considers the notification
            successful only if the `Content-Type` header is set to
            `application/json`, and the response body contains a `success` field
            set to `true`.
        customRequestBody:
          type: string
          description: >
            Customized request body. This field is available only for callouts
            whose Content-Type in the request body is `application/json`. The
            value must be in JSON format and double quotes in the value must be
            escaped.


            You can add merge fields to the request body. For example,
            `{\"AccountNumber\":
            \"{{DataSource.Account.AccountNumber}}\",\"AccountId\":
            \"{{DataSource.Account.Id}}\"}`. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Events_and_Notifications/Create_Email_Templates/A_Merge_field_syntax_for_email_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.


            You must set `useCustomRequestBody` to `true` if you want to
            customize the callout request body with this field. Alternatively,
            you can use the `calloutParams` field.
        description:
          description: Description for the callout template.
          maxLength: 255
          type: string
        hmacAlgorithm:
          type: string
          description: >
            The hash function Zuora uses to generate the signed data for HMAC
            authentication.
          enum:
            - MD5
            - SHA-1
            - SHA-224
            - SHA-256
            - SHA-384
            - SHA-512
        hmacData:
          type: string
          description: >
            The message to be authenticated for HMAC authentication.


            You can use merge fields in this value:


            - `{{Request.Headers.<header_name>}}`: Refers to the value of a
            particular request header. For example, `{{Request.Headers.Date}}`
            refers to the value of the request header called `Date`.

            - `{{Request.Body}}`: Refers to the request body.

            - Other merge fields: See <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Extensibility/Events_and_Notifications/AF_Manage_email_and_callout_templates/C_Merge_field_syntax_for_email_and_callout_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.
        hmacKey:
          type: string
          description: >
            The header key that Zuora uses to send the header value for HMAC
            authentication. The header value is specified in the `hmacValue`
            field and typically contains the signed data.
        hmacOutputFormat:
          type: string
          description: |
            The format of the signed data for HMAC authentication.
          enum:
            - BASE64
            - HEX
        hmacSecret:
          type: string
          description: >
            The shared secret key that Zuora uses to generate the signed data
            for HMAC authentication.
        hmacValue:
          type: string
          description: >
            The header value for HMAC authentication. The header key is
            specified in the `hmacKey` field.


            You can use merge fields in this value:


            - `{{Request.HMAC.Signed}}`: Refers to the signed data.

            - Other merge fields: See <a
            href="https://knowledgecenter.zuora.com/Zuora_Platform/Extensibility/Events_and_Notifications/AF_Manage_email_and_callout_templates/C_Merge_field_syntax_for_email_and_callout_templates"
            target="_blank">Merge field syntax for email and callout
            templates</a>.


            The following is a header value example: `The algorithm is SHA-256
            and the signed data is {{Request.HMAC.Signed}}`.
        httpMethod:
          description: The HTTP method of the callout.
          enum:
            - POST
            - GET
            - PUT
            - PATCH
            - DELETE
          example: POST
          type: string
        name:
          description: >-
            The name of the callout template. It must be unique across all
            callout templates.
          maxLength: 255
          type: string
        useCustomRequestBody:
          type: boolean
          description: >
            Indicates whether to enable the customized request body configured
            in the `customRequestBody` field.
      type: object
    PUTPublicCalloutTemplateRequestBasicAuthentication:
      title: Callout - Base authentication
      allOf:
        - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon'
        - type: object
          description: |
            The Basic Authentication information for callout templates.
          properties:
            requiredAuth:
              description: >
                Indicates whether Basic authentication is enabled for the
                callout.
              type: boolean
            calloutAuth:
              $ref: '#/components/schemas/CalloutAuth'
    PUTPublicCalloutTemplateRequestOauth2Authentication:
      title: Callout - OAuth 2.0 authentication
      allOf:
        - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon'
        - type: object
          description: |
            The OAuth 2.0 Authentication information for callout templates.
          properties:
            requiredOauth2:
              description: >
                Indicates whether OAuth 2.0 authentication is enabled for the
                callout.
              type: boolean
            oauth2ProviderId:
              description: >
                The ID of the OAuth 2.0 provider in your tenant that provides
                access tokens for the callout.


                For more information about how to get the ID of an OAuth 2.0
                provider, see <a
                href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/Add_an_OAuth_2.0_Provider#Retrieve_the_ID_of_an_OAuth_2.0_provider"
                target="_blank">Retrieve the ID of an OAuth 2.0 provider</a>.
    PUTPublicCalloutTemplateRequest:
      oneOf:
        - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon'
        - $ref: >-
            #/components/schemas/PUTPublicCalloutTemplateRequestBasicAuthentication
        - $ref: >-
            #/components/schemas/PUTPublicCalloutTemplateRequestOauth2Authentication
    CreateOrUpdateReusableBlockFormat:
      properties:
        active:
          default: true
          description: >
            The status of the reusable block. Only active blocks can be embedded
            into email templates.
          type: boolean
        category:
          description: >
            The category of the reusable block. You can filter blocks by
            category when editing email templates in the UI.
          type: string
          enum:
            - Headers
            - Footers
            - Other
        content:
          description: >
            The content of the reusable block, which is automatically inserted
            into email templates when sending email notifications.
          type: string
        id:
          description: >
            ID of an existing reusable block. Specify this field if you want to
            update an existing reusable block. You must provide all fields when
            updating an existing reusable block.
          type: string
        name:
          description: >
            The name of the reusable block. The value must be unique across all
            blocks.
          type: string
        number:
          description: >
            The number of the reusable block. The value must be unique across
            all blocks.


            If not specified, a unique value will be provided by default.
          type: string
        tags:
          description: >
            List of tags that help you quickly locate reusable blocks when
            editing email templates in the UI by using the tag filter.
          items:
            type: string
          type: array
      required:
        - category
        - content
        - name
      type: object
    CreateOrUpdateReusableBlockRequest:
      properties:
        allowPartialSuccess:
          description: >
            When set to false, the call will fail if one or multiple instances
            fail to import, and a 200 response is returned if all reusable
            blocks have been successfully updated. 

            When set to true, a success (200) response is returned if one or
            more instances have imported successfully. All failed instances are
            also returned in the response.
          type: boolean
        reusableBlocks:
          description: |
            A container for reusable blocks.
          maxItems: 1000
          minItems: 1
          items:
            $ref: '#/components/schemas/CreateOrUpdateReusableBlockFormat'
          type: array
      type: object
    CreateOrUpdateReusableBlockResponse:
      example:
        reasons: []
      properties:
        reasons:
          description: |
            Returns an empty array if the request succeeds.
          items:
            type: string
          type: array
      type: object
    GetPublicReusableBlockResponse:
      example:
        id: c6af751e4a0041eebb000c51e95e6c2d
        createdBy: 8a90e08282f4ed040182f67bab2902ff
        createdOn: 2025-04-22T08:17:24.000 UTC
        updatedBy: 8a90e08282f4ed040182f67bab2902ff
        updatedOn: 2025-04-22T08:17:24.000 UTC
        active: true
        name: Header Block
        number: RB-00000010
        category: Headers
        tags: []
        content: (The content of the block)
      properties:
        active:
          default: true
          description: >
            The status of the reusable block. Only active blocks can be embedded
            into email templates.
          type: boolean
        category:
          description: >
            The category of the reusable block. You can filter blocks by
            category when editing email templates in the UI.
          type: string
          enum:
            - Headers
            - Footers
            - Other
        content:
          description: >
            The content of the reusable block, which is automatically inserted
            into email templates when sending email notifications.
          type: string
        createdBy:
          description: |
            The ID of the user who created the reusable block.
          format: uuid
          type: string
        createdOn:
          description: |
            The time when the reusable block was created.
          format: date-time
          type: string
        id:
          description: |
            The ID of the reusable block.
          format: uuid
          type: string
        name:
          description: >
            The name of the reusable block. The value must be unique across all
            blocks.
          type: string
        number:
          description: >
            The number of the reusable block. The value must be unique across
            all blocks.


            If not specified, a unique value will be provided by default.
          type: string
        tags:
          description: >
            List of tags that help you quickly locate reusable blocks when
            editing email templates in the UI by using the tag filter.
          items:
            type: string
          type: array
        updatedBy:
          description: |
            The ID of the user who updated the reusable block.
          format: uuid
          type: string
        updatedOn:
          description: |
            TThe time when the reusable block was updated.
          format: date-time
          type: string
      type: object
    CreatePublicReusableBlockRequest:
      example:
        name: Header Block
        category: Headers
        content: (The content of the block)
      properties:
        active:
          default: true
          description: >
            The status of the reusable block. Only active blocks can be embedded
            into email templates.
          type: boolean
        category:
          description: >
            The category of the reusable block. You can filter blocks by
            category when editing email templates in the UI.
          type: string
          enum:
            - Headers
            - Footers
            - Other
        content:
          description: >
            The content of the reusable block, which is automatically inserted
            into email templates when sending email notifications.
          type: string
        name:
          description: >
            The name of the reusable block. The value must be unique across all
            blocks.
          type: string
        number:
          description: >
            The number of the reusable block. The value must be unique across
            all blocks.


            If not specified, a unique value will be provided by default.
          type: string
        tags:
          description: >
            List of tags that help you quickly locate reusable blocks when
            editing email templates in the UI by using the tag filter.
          items:
            type: string
          type: array
      required:
        - category
        - content
        - name
      type: object
    UpdatePublicReusableBlockRequest:
      example:
        tag:
          - logo
      properties:
        active:
          default: true
          description: >
            The status of the reusable block. Only active blocks can be embedded
            into email templates.
          type: boolean
        category:
          description: >
            The category of the reusable block. You can filter blocks by
            category when editing email templates in the UI.
          type: string
          enum:
            - Headers
            - Footers
            - Other
        content:
          description: >
            The content of the reusable block, which is automatically inserted
            into email templates when sending email notifications.
          type: string
        name:
          description: >
            The name of the reusable block. The value must be unique across all
            blocks.
          type: string
        number:
          description: >
            The number of the reusable block. The value must be unique across
            all blocks.
          type: string
        tags:
          description: >
            List of tags that help you quickly locate reusable blocks when
            editing email templates in the UI by using the tag filter.
          items:
            type: string
          type: array
      type: object
    UpdatePublicReusableBlockResponse:
      example:
        id: c6af751e4a0041eebb000c51e95e6c2d
        createdBy: 8a90e08282f4ed040182f67bab2902ff
        createdOn: 2025-04-22T08:17:24.000 UTC
        updatedBy: 8a90e08282f4ed040182f67bab2902ff
        updatedOn: 2025-04-22T08:17:24.000 UTC
        active: true
        name: Header Block
        number: RB-00000010
        category: Headers
        tags:
          - logo
        content: (The content of the block)
      properties:
        active:
          default: true
          description: >
            The status of the reusable block. Only active blocks can be embedded
            into email templates.
          type: boolean
        category:
          description: >
            The category of the reusable block. You can filter blocks by
            category when editing email templates in the UI.
          type: string
          enum:
            - Headers
            - Footers
            - Other
        content:
          description: >
            The content of the reusable block, which is automatically inserted
            into email templates when sending email notifications.
          type: string
        createdBy:
          description: |
            The ID of the user who created the reusable block.
          format: uuid
          type: string
        createdOn:
          description: |
            The time when the reusable block was created.
          format: date-time
          type: string
        id:
          description: |
            The ID of the reusable block.
          format: uuid
          type: string
        name:
          description: >
            The name of the reusable block. The value must be unique across all
            blocks.
          type: string
        number:
          description: >
            The number of the reusable block. The value must be unique across
            all blocks.


            If not specified, a unique value will be provided by default.
          type: string
        tags:
          description: >
            List of tags that help you quickly locate reusable blocks when
            editing email templates in the UI by using the tag filter.
          items:
            type: string
          type: array
        updatedBy:
          description: |
            The ID of the user who updated the reusable block.
          format: uuid
          type: string
        updatedOn:
          description: |
            TThe time when the reusable block was updated.
          format: date-time
          type: string
      type: object
    NotificationsHistoryDeletionTaskResponse:
      description: The notification history deletion task information.
      properties:
        accountId:
          description: >-
            The ID of the account whose notification histories are deleted by
            the current deletion task.
          format: uuid
          type: string
        createdBy:
          description: >-
            The ID of the user who submits the notification history deletion
            task.
          format: uuid
          type: string
        createdOn:
          description: >-
            The timestamp when the notification history deletion task is
            created.
          type: integer
        id:
          description: The ID of the notification history deletion task.
          format: uuid
          type: string
        status:
          description: The status of the notification history deletion task.
          enum:
            - RUNNING
            - FINISHED
            - FAILED
          type: string
        tenantId:
          description: >-
            The ID of the tenant where the notification history deletion task
            runs.
          type: string
      type: object
    POSTResendCalloutNotifications:
      example:
        - a02ea6d76931475bb73fcd339b5f6ht8g
        - 40dbbc5f2cfb4e2fa236db11ea1dfghht
        - a3fd8e81c20a4ac0a1eb3747339asdfef
        - a00000000000000000000000000000000
      items:
        description: >
          ID for failed callout notifications. You can resend at most 1000
          callout notifications at a time.
        type: string
      type: array
    ResendCalloutNotificationsFailedResponse:
      additionalProperties:
        description: >
          The ID of a fail-to-resend callout notification history object,
          containing an object with the error code and message.


          **Note:** Multiple records of this field are allowed in the response.
          Each of them represents a fail-to-resend callout notification history.
        properties:
          code:
            description: |
              The error code of response.
            type: string
          message:
            description: The detail information of the error response
            type: string
        type: object
      type: object
    POSTResendEmailNotifications:
      example:
        - a02ea6d76931475bb73fcd339b5f6ht8g
        - 40dbbc5f2cfb4e2fa236db11ea1dfghht
        - a3fd8e81c20a4ac0a1eb3747339asdfef
        - a00000000000000000000000000000000
      items:
        description: >
          ID for failed email notifications. You can resend at most 1000 email
          notifications at a time.
        type: string
      type: array
    ResendEmailNotificationsFailedResponse:
      additionalProperties:
        description: >
          The ID of a fail-to-resend email notification history object,
          containing an object with the error code and message.


          **Note:** Multiple records of this field are allowed in the response.
          Each of them represents a fail-to-resend email notification history.
        properties:
          code:
            description: |
              The error code of response.
            type: string
          message:
            description: The detail information of the error response
            type: string
        type: object
      type: object
    GETCalloutHistoryVOType:
      properties:
        attemptedNum:
          description: |
            The number of times the callout was retried.
          type: string
        createTime:
          description: |
            The time that the calloutHistory record was made.
          type: string
        eventCategory:
          description: |
            The event category for the callout.
          type: string
        eventContext:
          description: |
            The context of the callout event.
          type: string
        notification:
          description: |
            The name of the notification.
          type: string
        requestMethod:
          description: |
            The request method set in notifications settings.
          type: string
        requestUrl:
          description: |
            The base url set in notifications settings.
          type: string
        responseCode:
          description: |
            The responseCode of the request.
          type: string
        responseContent:
          description: ''
          type: string
      title: calloutHistories
      type: object
    GETCalloutHistoryVOsType:
      properties:
        calloutHistories:
          description: |
            A container for callout histories.
          items:
            $ref: '#/components/schemas/GETCalloutHistoryVOType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETEmailHistoryVOType:
      properties:
        accountId:
          description: |
            ID of an account.
          type: string
        bcc:
          description: |
            Blind carbon copy recipients of the email.
          type: string
        cc:
          description: |
            Carbon Copy recipients of the email.
          type: string
        errorMessage:
          description: >
            null if the content of result is "OK". A description of the error if
            the content of result is not "OK".
          type: string
        eventCategory:
          description: |
            The event category of the email.
          type: string
        fromEmail:
          description: |
            The sender of the email.
          type: string
        notification:
          description: |
            The name of the notification.
          type: string
        replyTo:
          description: |
            The reply-to address as configured in the email template.
          type: string
        result:
          description: |
            The result from the mail server of sending the email.
          type: string
        sendTime:
          description: |
            The date and time the email was sent.
          type: string
        subject:
          description: |
            The subject of the email.
          type: string
        toEmail:
          description: |
            The intended recipient of the email.
          type: string
      title: emailHistories
      type: object
    GETEmailHistoryVOsType:
      properties:
        emailHistories:
          description: |
            A container for email histories.
          items:
            $ref: '#/components/schemas/GETEmailHistoryVOType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    CustomObjectCustomFieldDefinition:
      description: The custom field definition in the custom object
      properties:
        displayName:
          description: >
            Indicates whether to use this field as the display name of the
            custom object when being linked to another custom object.


            This field applies only to the Text custom field type:


            - The `type` field is `string`.

            - The `enum` field is not specified.
          type: boolean
        format:
          description: The data format of the custom field
          type: string
        label:
          description: The UI label of the custom field
          type: string
        maxLength:
          description: |
            The maximum length of string that can be stored in the custom field.

            This field applies only to the following custom field types:

            - Text:
              - The `type` field is `string`.
              - The `format` field is not specified or is `url`.
              - The `enum` field is not specified.
            - Long Text:
              - The `type` field is `string`.
              - The `format` field is `long-text`.
            - Picklist:
              - The `type` field is `string`.
              - The `enum` field is specified.
              - The `multiselect` field is not specified or is `false`.
            - Multiselect:
              - The `type` field is `string`.
              - The `enum` field is specified.
              - The `multiselect` field is `true`.
          type: integer
        multiselect:
          description: >
            Indicates whether this is a multiselect custom field.


            This field applies only to the Picklist or Multiselect custom field
            types:


            - The `type` field is `string`.

            - The `maxLength` field is specified.

            - The `enum` field is specified.
          type: boolean
        origin:
          description: Specifies that this is a custom field
          enum:
            - custom
          type: string
        type:
          description: The data type of the custom field
          type: string
      title: customObjectCustomFieldDefinition
      type: object
    CustomObjectCustomFieldsDefinition:
      additionalProperties:
        $ref: '#/components/schemas/CustomObjectCustomFieldDefinition'
      description: The custom field definition in the custom object definition
      title: customObjectCustomFieldDefinition
      type: object
    CustomObjectAllFieldsDefinition:
      allOf:
        - properties:
            CreatedById:
              description: The `CreatedById` field definition
              properties:
                format:
                  description: The field data format
                  enum:
                    - uuid
                  type: string
                label:
                  description: The UI name of the field
                  type: string
                origin:
                  description: >-
                    Specifies whether the field is a system field or a custom
                    field
                  enum:
                    - system
                  type: string
                type:
                  description: The field data type
                  enum:
                    - string
                  type: string
              type: object
            CreatedDate:
              description: The `CreatedDate` field definition
              properties:
                format:
                  description: The field data format
                  enum:
                    - date-time
                  type: string
                origin:
                  description: Specifies the field is a system field
                  enum:
                    - system
                  type: string
                type:
                  description: The field data type
                  enum:
                    - string
                  type: string
              type: object
            Id:
              description: The `Id` field definition
              properties:
                format:
                  description: The field data format
                  enum:
                    - uuid
                  type: string
                label:
                  description: The UI name of the field
                  type: string
                origin:
                  description: >-
                    Specifies whether the field is a system field or a custom
                    field
                  enum:
                    - system
                  type: string
                type:
                  description: The field data type
                  enum:
                    - string
                  type: string
              type: object
            UpdatedById:
              description: The `UpdatedById` field definition
              properties:
                format:
                  description: The field data format
                  enum:
                    - uuid
                  type: string
                label:
                  description: The UI name of the field
                  type: string
                origin:
                  description: >-
                    Specifies whether the field is a system field or a custom
                    field
                  enum:
                    - system
                  type: string
                type:
                  description: The field data type
                  enum:
                    - string
                  type: string
              type: object
            UpdatedDate:
              description: The `UpdatedDate` field definition
              properties:
                format:
                  description: The field data format
                  enum:
                    - date-time
                  type: string
                origin:
                  description: Specifies the field is a system field
                  enum:
                    - system
                  type: string
                type:
                  description: The field data type
                  enum:
                    - string
                  type: string
              type: object
          type: object
        - $ref: '#/components/schemas/CustomObjectCustomFieldsDefinition'
      description: The definitions of all the fields in the custom object definition
      title: customObjectFieldDefinition
    FieldsAdditionalProperties:
      additionalProperties:
        type: string
      description: >
        Field mappings in the form of `<this-object-field-name>`:
        `<other-object-field-name>`.
      title: relationshipFieldMapping
      type: object
    CustomObjectDefinition:
      example:
        CreatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c
        CreatedDate: '2019-09-29T06:45:23.378Z'
        Id: df7f10f9-4ec9-4389-a9eb-a6a3d549bb61
        UpdatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c
        UpdatedDate: '2019-09-29T06:45:23.378Z'
        schema:
          filterable:
            - last_name__c
            - email__c
          label: Personal Profile
          object: person
          properties:
            CreatedById:
              format: uuid
              label: CreatedById
              origin: system
              type: string
            CreatedDate:
              format: date-time
              label: CreatedDate
              origin: system
              type: string
            Id:
              format: uuid
              label: Id
              origin: system
              type: string
            UpdatedById:
              format: uuid
              label: UpdatedById
              origin: system
              type: string
            UpdatedDate:
              format: date-time
              label: UpdatedDate
              origin: system
              type: string
            age__c:
              description: Age in years
              minimum: 0
              origin: custom
              type: integer
            email__c:
              format: email
              maxLength: 128
              origin: custom
              type: string
            home_address__c:
              format: uuid
              origin: custom
              type: string
            last_name__c:
              maxLength: 128
              origin: custom
              type: string
            marital_status__c:
              default: Unknown
              enum:
                - Single
                - Married
                - Unknown
              origin: custom
              type: string
            work_address__c:
              format: uuid
              origin: custom
              type: string
          relationships:
            - cardinality: manyToOne
              fields:
                home_address__c: Id
              namespace: default
              object: address
              recordConstraints:
                create:
                  enforceValidMapping: false
            - cardinality: manyToOne
              fields:
                work_address__c: Id
              namespace: default
              object: address
              recordConstraints:
                create:
                  enforceValidMapping: false
            - cardinality: oneToMany
              fields:
                Id: person_id__c
              namespace: default
              object: car
              recordConstraints:
                create:
                  enforceValidMapping: false
            - cardinality: oneToMany
              fields:
                Id: person_id__c
              namespace: default
              object: device
              recordConstraints:
                create:
                  enforceValidMapping: false
          required:
            - last_name__c
            - marital_status__c
          type: object
        type: person
      properties:
        CreatedById:
          description: The creator's Id
          format: uuid
          type: string
        CreatedDate:
          description: >-
            The creation time of the custom object definition in date-time
            format.
          format: date-time
          type: string
        Id:
          description: The unique Id of the custom object definition
          format: uuid
          type: string
        UpdatedById:
          description: The modifier's Id
          format: uuid
          type: string
        UpdatedDate:
          description: The update time of the custom object definition in date-time format.
          format: date-time
          type: string
        schema:
          description: The schema of the custom object definition
          properties:
            auditable:
              description: >-
                The set of fields which Audit Trail tracks and records changes
                of.
              items:
                type: string
              type: array
            enableCreateRecordAuditing:
              description: >-
                Indicates whether to audit the creation of custom object records
                of this custom object definition.
              type: boolean
            enableDeleteRecordAuditing:
              description: >-
                Indicates whether to audit the deletion of custom object records
                of this custom object definition.
              type: boolean
            filterable:
              description: >-
                The set of fields that are allowed to be queried on. Queries on
                non-filterable fields will be rejected. You can not change a
                non-filterable field to filterable.
              items:
                type: string
              type: array
            label:
              description: A label for the custom object
              type: string
            object:
              description: The API name of the custom object
              type: string
            properties:
              $ref: '#/components/schemas/CustomObjectAllFieldsDefinition'
            relationships:
              description: >-
                An array of relationships with Zuora objects or other custom
                objects
              items:
                additionalProperties: false
                properties:
                  cardinality:
                    default: manyToOne
                    description: >
                      The cardinality of the relationship from this object to
                      another object.


                      A `manyToOne` relationship means this object is the child
                      object (the "many" side), and the referenced object (the
                      "one" side) is the parent.


                      A `oneToMany` relationship means this object is the parent
                      object (the "one" side), and the referenced object (the
                      "many" side) is the child.
                    enum:
                      - manyToOne
                      - oneToMany
                    type: string
                  fields:
                    $ref: '#/components/schemas/FieldsAdditionalProperties'
                  namespace:
                    description: The namespace where the related object is located
                    type: string
                  object:
                    description: The API name of the related object
                    type: string
                  recordConstraints:
                    description: |
                      Specifies contraints to apply to custom object records.
                    properties:
                      create:
                        properties:
                          enforceValidMapping:
                            description: >
                              Specifies whether Zuora validates the values of
                              mapped fields

                              in custom object records.
                            type: boolean
                        type: object
                    type: object
                type: object
              type: array
            required:
              description: >-
                The required fields of the custom object definition. You can
                change required fields to optional. However, you can only change
                optional fields to required on the custom objects with no
                records.
              items:
                type: string
              type: array
            type:
              description: >-
                The custom object definition type. Can only be `object`
                currently.
              enum:
                - object
              type: string
            unique:
              description: The fields with unique constraints.
              items:
                type: string
              type: array
          type: object
        type:
          description: The API name of the custom object
          type: string
      title: customObjectDefinition
      type: object
    CustomObjectDefinitions:
      additionalProperties:
        $ref: '#/components/schemas/CustomObjectDefinition'
      description: >-
        The custom object definitions. This object maps types to custom object
        definitions.
      title: customObjectDefinitions
      type: object
    GETAllCustomObjectDefinitionsInNamespaceResponse:
      example:
        Id: f67635c8-094e-4ffc-90be-5dba5c639494
        type: Vehicle
        CreatedById: 8ad084a67f9c7138017fab8a8b511b5a
        UpdatedById: 8ad084a67f9c7138017fab8a8b511b5a
        CreatedDate: '2024-11-15T06:13:27.338Z'
        UpdatedDate: '2024-11-15T06:13:27.338Z'
        schema:
          object: Vehicle
          label: Vehicle
          enableCreateRecordAuditing: false
          enableDeleteRecordAuditing: false
          properties:
            DeviceId__c:
              maxLength: 20
              label: Device ID
              origin: custom
              type: string
            OrderId__c:
              format: uuid
              label: Order ID
              origin: custom
              type: string
            Id:
              format: uuid
              label: Id
              origin: system
              type: string
            CreatedById:
              label: CreatedById
              origin: system
              type: string
            UpdatedById:
              label: UpdatedById
              origin: system
              type: string
            CreatedDate:
              format: date-time
              label: CreatedDate
              origin: system
              type: string
            UpdatedDate:
              format: date-time
              label: UpdatedDate
              origin: system
              type: string
          required:
            - Id
            - CreatedById
            - UpdatedById
            - CreatedDate
            - UpdatedDate
          filterable:
            - OrderId__c
            - Id
            - CreatedDate
            - UpdatedDate
          relationships:
            - cardinality: manyToOne
              namespace: com_zuora
              object: orders
              fields:
                OrderId__c: Id
              recordConstraints:
                create:
                  enforceValidMapping: true
            - cardinality: manyToOne
              namespace: com_zuora
              object: User
              fields:
                CreatedById: Id
              recordConstraints:
                create:
                  enforceValidMapping: true
            - cardinality: manyToOne
              namespace: com_zuora
              object: User
              fields:
                UpdatedById: Id
              recordConstraints:
                create:
                  enforceValidMapping: true
          enableRecordMigration: false
      properties:
        count:
          description: >-
            The number of objects in the `definitions` object. The value of this
            field is the number of custom object definitions in the namespace.
          type: integer
        definitions:
          $ref: '#/components/schemas/CustomObjectDefinitions'
      type: object
    PostCustomObjectDefinitionFieldDefinitionRequest:
      properties:
        displayName:
          description: >
            Indicates whether to use this field as the display name of the
            custom object when being linked to another custom object.


            This field applies only to the Text custom field type:


            - The `type` field is `string`.

            - The `enum` field is not specified.
          type: boolean
        format:
          description: The data format of the custom field
          type: string
        label:
          description: The UI label of the custom field
          type: string
        maxLength:
          description: |
            The maximum length of string that can be stored in the custom field.

            This field applies only to the following custom field types:

            - Text:
              - The `type` field is `string`.
              - The `format` field is not specified or is `url`.
              - The `enum` field is not specified.
            - Long Text:
              - The `type` field is `string`.
              - The `format` field is `long-text`.
            - Picklist:
              - The `type` field is `string`.
              - The `enum` field is specified.
              - The `multiselect` field is not specified or is `false`.
            - Multiselect:
              - The `type` field is `string`.
              - The `enum` field is specified.
              - The `multiselect` field is `true`.
          type: integer
        multiselect:
          description: >
            Indicates whether this is a multiselect custom field.


            This field applies only to the Picklist or Multiselect custom field
            types:


            - The `type` field is `string`.

            - The `maxLength` field is specified.

            - The `enum` field is specified.
          type: boolean
        type:
          description: The data type of the custom field
          type: string
      required:
        - type
        - label
      title: customObjectCustomFieldDefinition
      type: object
    PostCustomObjectDefinitionFieldsDefinitionRequest:
      additionalProperties:
        $ref: '#/components/schemas/PostCustomObjectDefinitionFieldDefinitionRequest'
      title: customObjectCustomFieldDefinitions
      type: object
    FieldsAdditionalPropertiesForPostDefinition:
      additionalProperties:
        type: string
      description: >
        Field mappings in the form of `<this-object-field-name>`:
        `<other-object-field-name>`. Usually the `<other-object-field-name>` can
        only be the `Id` field of the related object. Two exceptions are
        Subscription Name and Rate Plan Charge Number as both of them are
        unique.
      title: relationshipFieldMapping
      type: object
    PostCustomObjectDefinitionsRequestDefinition:
      properties:
        auditable:
          description: >-
            The set of fields which Audit Trail tracks and records changes of.
            You can change auditable fields to non-auditable, and vice versa.
            One custom object can have a maximum of five auditable fields.
          items:
            type: string
          type: array
        enableCreateRecordAuditing:
          default: false
          description: >
            Indicates whether to audit the creation of custom object records of
            this custom object definition.


            Note that you must enable the **Custom Object Definition** audit
            trail setting in your Zuora tenant before auditing custom object
            record creation. For more information, see <a
            href="https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings"
            target="_blank">Manage audit trail settings</a>.
          type: boolean
        enableDeleteRecordAuditing:
          default: false
          description: >
            Indicates whether to audit the deletion of custom object records of
            this custom object definition.


            Note that you must enable the **Custom Object Definition** audit
            trail setting in your Zuora tenant before auditing custom object
            record deletion. For more information, see <a
            href="https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings"
            target="_blank">Manage audit trail settings</a>.
          type: boolean
        filterable:
          description: >-
            The set of fields that are allowed to be queried on. Queries on
            non-filterable fields will be rejected. You can not change a
            non-filterable field to filterable.
          items:
            type: string
          type: array
        label:
          description: A UI label for the custom object
          type: string
        object:
          description: The API name of the custom object
          type: string
        properties:
          $ref: >-
            #/components/schemas/PostCustomObjectDefinitionFieldsDefinitionRequest
        relationships:
          description: >-
            An array of relationships with Zuora objects or other custom
            objects. You can add at most 2 `manyToOne` relationships when
            creating a custom field definition.
          items:
            additionalProperties: false
            properties:
              cardinality:
                description: >
                  The cardinality of the relationship from this object to
                  another object.


                  Only the `manyToOne` cardinality can be used when creating
                  relationships.  A relationship with `oneToMany` cardinality is
                  created implicitly when a `manyToOne` relationship is created.


                  A custom object definition can have a maximum of 2 `manyToOne`
                  relationships.
                enum:
                  - manyToOne
                type: string
              fields:
                $ref: >-
                  #/components/schemas/FieldsAdditionalPropertiesForPostDefinition
              namespace:
                description: The namespace where the related object is located
                type: string
              object:
                description: The API name of the related object
                type: string
              recordConstraints:
                description: |
                  Specifies contraints to apply to custom object records.
                properties:
                  create:
                    properties:
                      enforceValidMapping:
                        default: true
                        description: >
                          Specifies whether Zuora validates the values of mapped
                          fields

                          in custom object records.


                          By default, Zuora validates the values of mapped
                          fields

                          in custom object records. For example, if the

                          custom object definition has a field called
                          `AccountId__c`

                          that is mapped to the `Id` field of the `account`
                          object,

                          Zuora verifies that the value of `AccountId__c` is a
                          valid

                          account ID when a custom object record is created.

                          If the value of `AccountId__c` is not a valid account
                          ID,

                          the operation fails.
                        type: boolean
                    type: object
                type: object
            required:
              - namespace
              - object
              - fields
            type: object
          type: array
        required:
          description: >-
            The required fields of the custom object. You can change required
            fields to optional. However, you can only change optional fields to
            required on the custom objects with no records.
          items:
            type: string
          type: array
        unique:
          description: >-
            The fields with unique constraints. You can remove the unique
            constraint on a field. However, you can only add a unique constraint
            to a filterable field if the custom object contains no record. One
            custom object can have a maximum of five fields with unique
            constraints.
          items:
            type: string
          type: array
      required:
        - object
        - label
      title: customObjectDefinition
      type: object
    PostCustomObjectDefinitionsRequestDefinitions:
      additionalProperties:
        $ref: '#/components/schemas/PostCustomObjectDefinitionsRequestDefinition'
      description: >
        The custom object definitions. This object maps types to custom object
        definitions.
      title: customObjectDefinitions
      type: object
    PostCustomObjectDefinitionsRequest:
      example:
        definitions:
          Vehicle:
            label: Vehicle
            object: Vehicle
            properties:
              DeviceId__c:
                label: Device ID
                type: string
                maxLength: 20
              OrderId__c:
                label: Order ID
                type: string
                format: uuid
            relationships:
              - namespace: com_zuora
                object: orders
                fields:
                  OrderId__c: Id
      properties:
        definitions:
          $ref: '#/components/schemas/PostCustomObjectDefinitionsRequestDefinitions'
      type: object
    CustomObjectCustomFieldDefinitionUpdate:
      description: The custom field definition in the custom object
      properties:
        default:
          description: Applicable if the `type` of the action is  `updateField`
          type: string
        description:
          description: Applicable if the `type` of the action is  `updateField`
          type: string
        displayName:
          description: >
            Indicates whether to use this field as the display name of the
            custom object when being linked to another custom object.


            This field applies only to the Text custom field type:


            - The `type` field is `string`.

            - The `enum` field is not specified.
          type: boolean
        format:
          description: The data format of the custom field
          type: string
        label:
          description: The UI label of the custom field
          type: string
        maxLength:
          description: |
            The maximum length of string that can be stored in the custom field.

            This field applies only to the following custom field types:

            - Text:
              - The `type` field is `string`.
              - The `format` field is not specified or is `url`.
              - The `enum` field is not specified.
            - Long Text:
              - The `type` field is `string`.
              - The `format` field is `long-text`.
            - Picklist:
              - The `type` field is `string`.
              - The `enum` field is specified.
              - The `multiselect` field is not specified or is `false`.
            - Multiselect:
              - The `type` field is `string`.
              - The `enum` field is specified.
              - The `multiselect` field is `true`.
          type: integer
        multiselect:
          description: >
            Indicates whether this is a multiselect custom field.


            This field applies only to the creation of Picklist or Multiselect
            custom fields:


            - The action `type` field is `addField`.

            - The definition `type` field is `string`.

            - The `maxLength` field is specified.

            - The `enum` field is specified.
          type: boolean
        origin:
          description: Specifies that this is a custom field
          enum:
            - custom
          type: string
        type:
          description: The data type of the custom field
          type: string
      title: customObjectCustomFieldDefinition
      type: object
    UpdateCustomObjectCusotmField:
      description: A reference to a field.
      properties:
        auditable:
          description: >
            Indicates whether Audit Trail will record changes of this custom
            field. You can change auditable fields to non-auditable, and vice
            versa. One custom object can have a maximum of five auditable
            fields.
          type: boolean
        definition:
          $ref: '#/components/schemas/CustomObjectCustomFieldDefinitionUpdate'
        filterable:
          description: >
            Indicates whether the field is filterable or not. Applicable to
            `addField` and `updateField` actions.


            You can change a filterable field to non-filterable and vice versa.
            You can also add a filterable field. One custom object can have a
            maximum of 10 filterable fields.


            Note that changing filterable fields triggers reindexing. It will
            take 12-24 hours before all your data are reindexed and available to
            query.
          type: boolean
        name:
          description: The name of the custom field to be updated
          type: string
        required:
          description: >
            Indicates whether the field is required or optional.


            You can update a required field to optional. On the other hand, you
            can only update an optional field to required on the custom object
            with no records.


            You can only add a required field to the custom object with no
            records.
          type: boolean
        targetName:
          description: Required if the `type` of the action is `renameField`
          type: string
        unique:
          description: >
            Indicates whether to specify a unique constraint to the field. You
            can remove the unique constraint on the field. However, you can only
            add a unique constraint to a filterable field if the custom object
            contains no record. One custom object can have a maximum of five
            fields with unique constraints.
          type: boolean
      type: object
    CustomObjectDefinitionUpdateActionRequest:
      example:
        field:
          definition:
            description: Address zip code
            label: Zip code
            maxLength: 10
            type: string
          name: zip__c
        namespace: default
        object: address
        type: addField
      properties:
        description:
          description: Optional property for `updateObject` action
          type: string
        enableCreateRecordAuditing:
          description: >
            Optional property for `updateObject` action.


            Indicates whether to audit the creation of custom object records of
            this custom object definition.


            Note that you must enable the **Custom Object Definition** audit
            trail setting in your Zuora tenant before auditing custom object
            record creation. For more information, see <a
            href="https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings"
            target="_blank">Manage audit trail settings</a>.
          type: boolean
        enableDeleteRecordAuditing:
          description: >
            Optional property for `updateObject` action.


            Indicates whether to audit the deletion of custom object records of
            this custom object definition.


            Note that you must enable the **Custom Object Definition** audit
            trail setting in your Zuora tenant before auditing custom object
            record deletion. For more information, see <a
            href="https://docs.zuora.com/en/zuora-platform/system-management/administrator-settings/manage-audit-trail-settings"
            target="_blank">Manage audit trail settings</a>.
          type: boolean
        field:
          $ref: '#/components/schemas/UpdateCustomObjectCusotmField'
        label:
          description: Optional property for `updateObject` action
          type: string
        namespace:
          description: The namespace of the custom object definition to be updated
          type: string
        object:
          description: The API name of the custom object definition to be updated
          type: string
        relationship:
          additionalProperties: false
          properties:
            cardinality:
              description: >
                The cardinality of the relationship from this object to another
                object.


                Only the `manyToOne` cardinality can be used when creating
                relationships.  A relationship with `oneToMany` cardinality is
                created implicitly when a `manyToOne` relationship is created.


                A custom object definition can have a maximum of 2 `manyToOne`
                relationships.
              enum:
                - manyToOne
              type: string
            fields:
              $ref: '#/components/schemas/FieldsAdditionalProperties'
            namespace:
              description: The namespace where the related object is located
              type: string
            object:
              description: The API name of the related object
              type: string
            recordConstraints:
              description: |
                Specifies contraints to apply to custom object records.
              properties:
                create:
                  properties:
                    enforceValidMapping:
                      default: true
                      description: >
                        Specifies whether Zuora validates the values of mapped
                        fields

                        in custom object records.


                        By default, Zuora validates the values of mapped fields

                        in custom object records. For example, if the

                        custom object definition has a field called
                        `AccountId__c`

                        that is mapped to the `Id` field of the `account`
                        object,

                        Zuora verifies that the value of `AccountId__c` is a
                        valid

                        account ID when a custom object record is created.

                        If the value of `AccountId__c` is not a valid account
                        ID,

                        the operation fails.
                      type: boolean
                  type: object
              type: object
          required:
            - namespace
            - object
            - fields
          type: object
        type:
          description: The type of the updating action on a custom object definition
          enum:
            - addField
            - deleteField
            - updateField
            - updateObject
            - renameField
            - addRelationship
            - deleteRelationship
          type: string
      required:
        - type
        - namespace
        - object
      type: object
    MigrationUpdateCustomObjectDefinitionsRequest:
      additionalProperties: false
      properties:
        actions:
          description: >-
            The actions of updating custom object definitions, to be performed
            as parts of the migration.  Currently only one action per migration
            is supported.
          items:
            $ref: '#/components/schemas/CustomObjectDefinitionUpdateActionRequest'
          maxItems: 1
          minItems: 1
          type: array
      required:
        - actions
      type: object
    CustomObjectDefinitionUpdateActionResponse:
      example:
        field:
          definition:
            description: Address zip code
            label: Zip code
            maxLength: 10
            type: string
          name: zip__c
        namespace: default
        object: address
        type: addField
      properties:
        description:
          description: Optional property for `updateObject` action
          type: string
        enableCreateRecordAuditing:
          description: >-
            Indicates whether to audit the creation of custom object records of
            this custom object definition.
          type: boolean
        enableDeleteRecordAuditing:
          description: >-
            Indicates whether to audit the deletion of custom object records of
            this custom object definition.
          type: boolean
        field:
          $ref: '#/components/schemas/UpdateCustomObjectCusotmField'
        label:
          description: Optional property for `updateObject` action
          type: string
        namespace:
          description: The namespace of the custom object definition to be updated
          type: string
        object:
          description: The API name of the custom object definition to be updated
          type: string
        relationship:
          additionalProperties: false
          properties:
            cardinality:
              default: manyToOne
              description: >
                The cardinality of the relationship from this object to another
                object.


                A `manyToOne` relationship means this object is the child object
                (the "many" side), and the referenced object (the "one" side) is
                the parent.


                A `oneToMany` relationship means this object is the parent
                object (the "one" side), and the referenced object (the "many"
                side) is the child.
              enum:
                - manyToOne
                - oneToMany
              type: string
            fields:
              $ref: '#/components/schemas/FieldsAdditionalProperties'
            namespace:
              description: The namespace where the related object is located
              type: string
            object:
              description: The API name of the related object
              type: string
            recordConstraints:
              description: |
                Specifies contraints to apply to custom object records.
              properties:
                create:
                  properties:
                    enforceValidMapping:
                      default: true
                      description: >
                        Specifies whether Zuora validates the values of mapped
                        fields

                        in custom object records.
                      type: boolean
                  type: object
              type: object
          type: object
        type:
          description: The type of the updating action on a custom object definition
          enum:
            - addField
            - deleteField
            - updateField
            - updateObject
            - renameField
            - addRelationship
            - deleteRelationship
          type: string
      type: object
    MigrationUpdateCustomObjectDefinitionsResponse:
      additionalProperties: false
      properties:
        actions:
          description: >-
            The actions of updating custom object definitions, to be performed
            as parts of the migration.  Currently only one action per migration
            is supported.
          items:
            $ref: '#/components/schemas/CustomObjectDefinitionUpdateActionResponse'
          maxItems: 1
          minItems: 1
          type: array
      type: object
    CustomObjectRecordWithOnlyCustomFields:
      additionalProperties:
        description: The field-value pairs for a custom object record
      example:
        DeviceId__c: '10101011'
      title: customObjectRecord
      type: object
    CustomObjectRecordWithAllFields:
      allOf:
        - properties:
            CreatedById:
              description: The creator's Id
              type: string
            CreatedDate:
              description: The record creation time in the date-time format
              format: date-time
              type: string
            Id:
              description: The unique Id of the custom object record
              format: uuid
              maxLength: 36
              minLength: 36
              type: string
            UpdatedById:
              description: The modifier's Id
              type: string
            UpdatedDate:
              description: The record modification time in the date-time format
              format: date-time
              type: string
            type:
              description: >-
                The type of the custom object record. It is the API name of the
                custom object definition.
              type: string
        - $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields'
      description: Record data from an object
      example:
        Id: e0668230-eb63-40df-be65-08f083ca47b1
        type: Vehicle
        CreatedById: 8ad09fc28193c189018194da28be74ba
        UpdatedById: b243314d594646d3b2651aeedd4be47e
        CreatedDate: '2024-07-17T03:23:47.698Z'
        UpdatedDate: '2024-07-17T03:26:28.772Z'
        DeviceId__c: '10101011'
        OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d
      title: customObjectRecord
      type: object
    QueryCustomObjectRecordsResponse:
      properties:
        count:
          description: The record count of the given custom object type
          example: 1
          type: integer
        records:
          example:
            - CreatedById: 58bcc694-0b01-4c38-83d9-679891aee4dc
              CreatedDate: '2017-06-07T17:26:47.501Z'
              Id: f4f3d0a8-9d45-43d6-956c-4820f2de7559
              UpdatedById: 58bcc694-0b01-4c38-83d9-679891aee4dc
              UpdatedDate: '2017-06-07T17:26:47.501Z'
              age__c: 32
              email__c: smith123@example.com
              home_address__c: 59b38ad1-27d4-40e8-af66-8c138bc382ee
              last_name__c: Smith
              marital_status__c: Married
              type: person
              version: 1
              work_address__c: 8a19f16a-2b5e-4a26-bb20-c79cd6984714
          items:
            $ref: '#/components/schemas/CustomObjectRecordWithAllFields'
          type: array
      required:
        - count
        - records
      type: object
    PostCustomObjectRecordsRequest:
      properties:
        allowPartialSuccess:
          default: false
          description: >-
            Indicates whether the records that pass the schema validation should
            be created when not all records in the request pass the schema
            validation.
          example: true
          type: boolean
        records:
          description: A list of custom object records to be created
          items:
            $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields'
          type: array
      required:
        - records
      type: object
    CustomObjectRecordsWithError:
      properties:
        code:
          description: >
            See <a
            href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-objects/custom-objects-api/custom-objects-api-error-code"
            target="_blank">Custom Objects API error code</a> for details.
          enum:
            - 71012520
            - 71012521
            - 71012522
            - 71012523
            - 71012524
            - 71012525
            - 71012526
            - 71012530
          format: Int32
          type: integer
        message:
          example: Field [last_name__c] cannot accept empty string.
          type: string
        record:
          $ref: '#/components/schemas/CustomObjectRecordWithAllFields'
      type: object
    CustomObjectRecordsErrorResponse:
      properties:
        code:
          example: 710125XX
          format: Int32
          type: integer
        details:
          example:
            - code: 710125XX
              message: Field [age__c] is an integer field but received a string value.
              record:
                Id: 8a19f16a-2b5e-4a26-bb20-c79cd6984714
                age__c: '32'
                email__c: smith123@example.com
                home_address__c: 59b38ad1-27d4-40e8-af66-8c138bc382ee
                last_name__c: Smith
                marital_status__c: Married
                work_address__c: 8a19f16a-2b5e-4a26-bb20-c79cd6984714
          items:
            $ref: '#/components/schemas/CustomObjectRecordsWithError'
          type: array
        message:
          example: Unabled to create object records due to invalid request.
          type: string
      type: object
    PostCustomObjectRecordsResponse:
      properties:
        error:
          $ref: '#/components/schemas/CustomObjectRecordsErrorResponse'
        records:
          description: The custom object records that are succesfully created and stored
          items:
            $ref: '#/components/schemas/CustomObjectRecordWithAllFields'
          type: array
      type: object
    Error401:
      properties:
        code:
          example: 7101251X
          format: Int32
          type: integer
        message:
          example: Unauthorized Action
          type: string
      type: object
    ErrorResponse401Record:
      properties:
        code:
          example: 7101251X
          format: Int32
          type: integer
        details:
          example:
            - code: 7101251X
              message: Unauthorized to view object record.
          items:
            $ref: '#/components/schemas/Error401'
          type: array
        message:
          example: Unauthorized to process object record.
          type: string
      type: object
    CustomObjectRecordsThrottledResponse:
      properties:
        code:
          example: 71012561
          format: Int32
          type: integer
        details:
          example:
            - code: 71012561
              message: >-
                Unable to process record due to internal error or database
                throttling.
              record:
                Id: 8a19f16a-2b5e-4a26-bb20-c79cd6984714
                age__c: 32
                email__c: smith123@example.com
                home_address__c: 59b38ad1-27d4-40e8-af66-8c138bc382ee
                last_name__c: Smith
                marital_status__c: Married
                work_address__c: 8a19f16a-2b5e-4a26-bb20-c79cd6984714
          items:
            $ref: '#/components/schemas/CustomObjectRecordsWithError'
          type: array
        message:
          example: Unabled to create object records, please try again later.
          type: string
      type: object
    CustomObjectRecordBatchUpdateMapping:
      additionalProperties:
        description: Map of object Id and associated custom fields data to be updated
        type: object
      description: >-
        Object records that you want to update. Only applicable when `type` is
        `update`.
      example:
        64edb2a5-2796-4e95-9559-846f8636a01b:
          name__c: elba43
          person_id__c": 30c52793-8f06-41c6-b623-04829710d7a
      title: updateIdFieldsMapping
      type: object
    CustomObjectRecordBatchAction:
      description: The batch action on custom object records
      properties:
        allowPartialSuccess:
          default: false
          description: >
            Indicates whether the records that pass the schema validation should
            be updated when not all records in the request pass the schema
            validation.


            Only applicable when `type` is `update`.
          example: true
          type: boolean
        ids:
          description: >-
            Ids of the custom object records that you want to delete. Each ID
            must be a string of 36 characters. Only applicable when `type` is
            `delete`.
          example:
            - 64edb2a5-2796-4e95-9559-846f8636a01b
            - dbfb35a3-dd2b-42c9-b8f7-eb36fed1a1e1
            - 2c2a1810-bfef-4150-84de-50e769978e42
          items:
            format: uuid
            type: string
          type: array
        records:
          $ref: '#/components/schemas/CustomObjectRecordBatchUpdateMapping'
        type:
          description: The type of the batch action
          enum:
            - delete
            - update
          type: string
      required:
        - type
      title: updateDeleteBatchAction
      type: object
    CustomObjectRecordBatchRequest:
      description: Request of processing custom object records in batch.
      example:
        action:
          type: update
          records:
            64edb2a5-2796-4e95-9559-846f8636a01b:
              DeviceId__c: '10101011'
      properties:
        action:
          $ref: '#/components/schemas/CustomObjectRecordBatchAction'
      required:
        - action
      type: object
    CustomObjectRecordsBatchUpdatePartialSuccessResponse:
      example: {}
      properties:
        error:
          $ref: '#/components/schemas/CustomObjectRecordsErrorResponse'
      type: object
    CustomObjectBulkJobResponse:
      example:
        CreatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c
        CreatedDate: '2021-03-15T06:47:18Z'
        Id: ed4b9701-bafb-4976-8019-b08269430153
        UpdatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c
        UpdatedDate: '2021-03-15T06:47:18Z'
        error:
          code: 71012560
          message: Service limit reached, please retry later.
        namespace: default
        object: passenger
        operation: delete
        processingTime: 1882
        recordsProcessed: 500
        status: failed
      properties:
        CreatedById:
          description: The ID of the user who creates the job.
          format: uuid
          type: string
        CreatedDate:
          description: The time when the bulk job is created.
          format: date-time
          type: string
        Id:
          description: The custom object bulk job ID.
          format: uuid
          type: string
        UpdatedById:
          description: The ID of the user who updates the job.
          format: uuid
          type: string
        UpdatedDate:
          description: The time when the bulk job is updated.
          format: date-time
          type: string
        error:
          properties:
            code:
              description: The error code.
              example: 71012560
              format: Int32
              type: integer
            message:
              description: The error message.
              example: Service limit reached, please retry later.
              type: string
          type: object
        namespace:
          description: >
            The namespace of the object. Custom objects belong to the `default`
            namespace. Zuora standard objects belong to the `com_zuora`
            namespace. Bulk job operations on the following Zuora standard
            objects are supported:

            * SavedQuery
          enum:
            - default
            - com_zuora
          type: string
        object:
          description: The object to that the bulk operation performs on.
          example: passenger
          type: string
        operation:
          description: >
            The operation that the bulk job performs. Only the users that have
            the "Delete Custom Objects" permission can submit a `delete` bulk
            job request. Only the users that have the "Edit Custom Objects"
            permission can submit a `create` or `update` bulk job request. See
            [Platform
            Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions)
            for more information.
          enum:
            - delete
            - create
            - update
          type: string
        processingTime:
          description: >-
            The amount of time elapsed, in milliseconds, from the submission to
            the completion of the bulk job.
          example: 550
          type: integer
        recordsProcessed:
          description: The number of object records processed by the bulk job.
          example: 1000
          type: integer
        status:
          description: >
            The status of the bulk job:


            - `accepted` - The job has been accepted and is ready to process.

            - `pending` - The job is waiting for your input. You can use [Upload
            a file for a custom object bulk
            job](https://developer.zuora.com/api-references/api/operation/POST_UploadFileForCustomObjectBulkJob)
            to upload a file so that the job can start creating records.

            - `in_progress` - The job is processing.

            - `completed` - The job has completed.

            - `failed` - The job was unable to complete. You can use [List all
            errors for a custom object bulk
            job](https://developer.zuora.com/api-references/api/operation/GET_CustomObjectBulkJobErrors)
            to list the errors.

            - `cancelled` - The job was cancelled by the server.
          enum:
            - accepted
            - pending
            - in_progress
            - completed
            - failed
            - cancelled
          example: failed
          type: string
      type: object
    CustomObjectBulkJobResponseCollection:
      properties:
        count:
          description: >-
            The number of custom object bulk jobs returned in the result page
            set.
          example: 2
          type: integer
        cursor:
          description: The `cursor` points to the last job record of the current page.
          example: a9e9a58d-0a11-4685-b1ab-99521dbc20a1
          type: string
        jobs:
          description: All custom object bulk jobs returned in the result page set.
          example:
            - CreatedById: 2c92c0f96a07409d016a0a58ab1172ec
              CreatedDate: '2021-03-10T00:05:54.207Z'
              Id: 5112347a-f7a1-4373-99df-c082984de7be
              UpdatedById: 2c92c0f96a07409d016a0a58ab1172ec
              UpdatedDate: '2021-03-10T00:08:15.614Z'
              namespace: default
              object: vehicle
              operation: create
              processingTime: 62
              recordsProcessed: 3
              status: completed
            - CreatedById: 2c92c0f96a07409d016a0a58ab1172ec
              CreatedDate: '2021-03-09T22:27:59.503Z'
              Id: a9e9a58d-0a11-4685-b1ab-99521dbc20a1
              UpdatedById: 2c92c0f96a07409d016a0a58ab1172ec
              UpdatedDate: '2021-03-09T22:27:59.503Z'
              namespace: default
              object: vehicle
              operation: create
              processingTime: 0
              recordsProcessed: 0
              status: pending
          items:
            $ref: '#/components/schemas/CustomObjectBulkJobResponse'
          type: array
      required:
        - jobs
      type: object
    CustomObjectBulkDeleteFilterCondition:
      description: Condition evaluated on a single object field
      properties:
        field:
          description: >-
            The object field that is evaluated. Only filterable fields can be
            evaluated in the filter.
          example: CreatedDate
          type: string
        operator:
          enum:
            - EQ
            - GT
            - LT
            - GE
            - LE
          example: LT
          type: string
        value:
          description: >-
            The value that the filterable `field` is evaluated against in the
            filter. The data type of `value` is consistent with that of the
            `field`.
          example: '2020-01-01T00:00:00.000Z'
      required:
        - field
        - operator
        - value
      type: object
    CustomObjectBulkDeleteFilter:
      description: >-
        Filters to determine which records to be deleted in the bulk delete
        operation.
      properties:
        conditions:
          description: >-
            Group of field filter conditions that are evaluated in conjunction
            with each other using the AND operator. The minimum number of
            conditions is 1 and the maximum is 2.
          items:
            $ref: '#/components/schemas/CustomObjectBulkDeleteFilterCondition'
          type: array
      required:
        - conditions
      type: object
    CustomObjectBulkJobRequest:
      example:
        object: passenger
        namespace: default
        operation: delete
        filter:
          conditions:
            - field: CreatedDate
              operator: LT
              value: '2020-01-01T00:00:00.000Z'
      properties:
        filter:
          $ref: '#/components/schemas/CustomObjectBulkDeleteFilter'
        namespace:
          description: >
            The namespace of the object. Custom objects belong to the `default`
            namespace. Zuora standard objects belong to the `com_zuora`
            namespace. Bulk job operations on the following Zuora standard
            objects are supported:

            * SavedQuery
          enum:
            - default
            - com_zuora
          type: string
        object:
          description: The object that the bulk operation performs on.
          example: passenger
          type: string
        operation:
          description: >-
            The operation that the bulk job performs. Only the users that have
            the "Delete Custom Objects" permission can submit a `delete` bulk
            job request. Only the users that have the "Edit Custom Objects"
            permission can submit a `create` or `update` bulk job request. See
            [Platform
            Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions)
            for more information.
          enum:
            - delete
            - create
            - update
          type: string
      required:
        - operation
        - object
        - namespace
      type: object
    CustomObjectBulkJobErrorResponse:
      properties:
        code:
          description: The error code.
          example: 71012520
          format: Int32
          type: integer
        message:
          description: The error message.
          example: input string "123" is not a valid UUID
          type: string
        record:
          $ref: '#/components/schemas/CustomObjectRecordWithAllFields'
        row:
          description: >-
            The CSV record row number. The custom object record data starts at
            the second row because the first row is the CSV header.
          example: 12
          format: Int32
          type: integer
      type: object
    CustomObjectBulkJobErrorResponseCollection:
      properties:
        errors:
          description: All errors for a custom object bulk job.
          items:
            $ref: '#/components/schemas/CustomObjectBulkJobErrorResponse'
          type: array
      required:
        - errors
      type: object
    ApiVolumeSummaryRecord:
      allOf:
        - properties:
            api:
              description: |
                The API path name.
              type: string
            error:
              description: >
                The count of failed API requests of above `api` and
                `httpMethod`.
              type: integer
            httpMethod:
              description: |
                The http method.
              type: string
            success:
              description: >
                The count of successful API requests of above `api` and
                `httpMethod`.
              type: integer
            total:
              description: The count of total API requests of above `api` and `httpMethod`.
              type: integer
          type: object
      description: |
        A volume summary record.
      title: volumeSummaryRecord
    GetApiVolumeSummaryResponse:
      properties:
        data:
          description: >
            List of API volume summary records. The records are grouped and
            ordered by API path name and http method.      
          items:
            $ref: '#/components/schemas/ApiVolumeSummaryRecord'
          type: array
      type: object
    SystemHealthErrorResponse:
      properties:
        error:
          description: |
            Error status text.
          type: string
        message:
          description: |
            The associated reason.
          type: string
        path:
          description: |
            The system health api path having error.
          type: string
        status:
          description: |
            Error status code.
          type: integer
        timestamp:
          description: |
            The time when error happens.
          format: date-time
          type: string
      type: object
    ApiFailureRecord:
      properties:
        tracing_identifier:
          description: |
            A unique identifier for tracing the request.
          type: string
          nullable: true
        latency:
          description: |
            The time taken to process the request in milliseconds.
          type: integer
          nullable: false
        ip:
          description: |
            The IP address from which the request originated.
          type: string
          nullable: false
        response_body:
          description: |
            The body of the response returned by the API.
          type: string
          nullable: false
        request_body:
          description: |
            The body of the request sent to the API.
          type: string
          nullable: false
        user_id:
          description: |
            The ID of the user making the request.
          type: string
          nullable: false
        track_id:
          description: |
            A tracking identifier for the request.
          type: string
          nullable: true
        request_path:
          description: |
            The complete path of the API request triggered by the user.
          type: string
          nullable: false
        http_status:
          description: |
            The HTTP status code returned by the API.
          type: string
          nullable: false
        zuora_response_code:
          description: |
            The response code returned by Zuora.
          type: string
          nullable: false
        api:
          description: |
            The path of the API request.
          type: string
          nullable: false
        request_id:
          description: |
            A unique identifier for the API request.
          type: string
          nullable: false
        user_agent:
          description: |
            The user agent string of the client making the request.
          type: string
          nullable: false
        timestamp:
          description: |
            The timestamp when the request was made.
          type: string
          format: date-time
          nullable: false
        status:
          description: |
            The status of the request.
          type: string
          nullable: false
          enum:
            - Error
        http_method:
          description: |
            Type of request method performed for the API endpoint.
          type: string
          nullable: false
      type: object
      description: >
        A list of failure records including additional details about the request
        and response.
      title: FailureRecords
    GetApiFailureRecordResponse:
      properties:
        data:
          description: |
            List of Failed API records      
          items:
            $ref: '#/components/schemas/ApiFailureRecord'
          type: array
        nextPage:
          description: |
            URL to the next page of results for pagination.
          type: string
          format: url
      type: object
    ApiPerformanceDetail:
      properties:
        tracing_identifier:
          description: |
            A unique identifier for tracing the request.
          type: string
          nullable: true
        latency:
          description: |
            The time taken to process the request in milliseconds.
          type: integer
          nullable: false
        ip:
          description: |
            The IP address from which the request originated.
          type: string
          nullable: true
        response_body:
          description: |
            The body of the response returned by the API.
          type: string
          nullable: true
        request_body:
          description: |
            The body of the request sent to the API.
          type: string
          nullable: true
        user_id:
          description: |
            The ID of the user making the request.
          type: string
          nullable: false
        track_id:
          description: |
            A tracking identifier for the request.
          type: string
          nullable: true
        request_path:
          description: |
            The complete path of the API request triggered by the user.
          type: string
          nullable: false
        http_status:
          description: |
            The HTTP status code returned by the API.
          type: string
          nullable: false
        zuora_response_code:
          description: |
            The response code returned by Zuora.
          type: string
          nullable: false
        api:
          description: |
            The path of the API request.
          type: string
          nullable: false
        request_id:
          description: |
            A unique identifier for the API request.
          type: string
          nullable: false
        user_agent:
          description: |
            The user agent string of the client making the request.
          type: string
          nullable: false
        timestamp:
          description: |
            The timestamp when the request was made.
          type: string
          format: date-time
          nullable: false
        status:
          description: |
            The status of the request.
          type: string
          nullable: false
          enum:
            - Error
            - Success
        http_method:
          description: |
            Type of request method performed for the API endpoint.
          type: string
          nullable: false
      type: object
      description: >
        A list of failure records including additional details about the request
        and response.
      title: DetailRecords
    GetApiPerformanceDetailResponse:
      properties:
        data:
          description: |
            List of API Records in detail.
          items:
            $ref: '#/components/schemas/ApiPerformanceDetail'
          type: array
        nextPage:
          description: |
            URL to the next page of results for pagination.
          type: string
          format: url
      type: object
    BillingDocVolumeSummaryRecord:
      allOf:
        - properties:
            totalFailedAccounts:
              description: The count of total accounts who have failed records.
              type: integer
            totalGeneratedCreditMemos:
              description: |
                The count of total generated credit memos.
              type: integer
            totalGeneratedInvoices:
              description: |
                The count of total generated invoices.
              type: integer
          type: object
      description: |
        A volume summary record.
      title: volumeSummaryRecord
    GetBillingDocVolumeSummaryResponse:
      properties:
        data:
          description: >
            List of billing documents summary, including total generated
            invoices and credit memos, also a total number of accounts that
            failed to process.
          items:
            $ref: '#/components/schemas/BillingDocVolumeSummaryRecord'
          type: array
      type: object
    PaymentVolumeSummaryRecord:
      allOf:
        - properties:
            error:
              description: >
                The count of failed payments of above `paymentGatewayType` and
                `paymentMethodType`.
              type: integer
            paymentGatewayType:
              description: |
                The payment gateway type.
              type: string
            paymentMethodType:
              description: |
                The payment method type.
              type: string
            success:
              description: >
                The count of successful payments of above `paymentGatewayType`
                and `paymentMethodType`.
              type: integer
            total:
              description: >-
                The count of total payments of above `paymentGatewayType` and
                `paymentMethodType`.      
              type: integer
          type: object
      description: |
        A volume summary record.
      title: volumeSummaryRecord
    GetPaymentVolumeSummaryResponse:
      properties:
        data:
          description: |
            List of electronic payments summary.
          items:
            $ref: '#/components/schemas/PaymentVolumeSummaryRecord'
          type: array
      type: object
    PaymentRecordsDetails:
      properties:
        payment_method_type:
          description: >
            The type of payment method used for the transaction, such as credit
            card or bank transfer.
          type: string
          nullable: false
        amount:
          description: |
            The total amount of the transaction.
          type: number
          nullable: false
        payment_status:
          description: |
            The current status of the payment transaction.
          type: string
          nullable: false
          enum:
            - Success
            - Error
        source_type:
          description: >
            The source from which the payment transaction originated, such as a
            payment run or manual entry.
          type: string
          nullable: false
        payment_gateway_response_code:
          description: |
            The response code returned by the payment gateway.
          type: string
          nullable: false
        payment_gateway_response_msg:
          description: >
            The response message returned by the payment gateway, providing
            additional details about the transaction status.
          type: string
          nullable: false
        request_duration:
          description: |
            The time taken to process the payment request, in milliseconds.
          type: integer
          nullable: false
        payment_number:
          description: |
            A unique identifier for the payment transaction.
          type: string
          nullable: false
        payment_id:
          description: |
            A unique identifier assigned to the payment in the system.
          type: string
          nullable: false
        zuora_response_code:
          description: >
            The response code returned by Zuora, indicating the status of the
            transaction.
          type: string
          nullable: false
        currency:
          description: |
            The currency in which the transaction was processed.
          type: string
          nullable: false
        source_id:
          description: >
            A unique identifier for the source entity that initiated the
            payment.
          type: string
          nullable: false
        payment_gateway_type:
          description: |
            The type of payment gateway used to process the transaction.
          type: string
          nullable: false
        payment_date:
          description: |
            The date the payment transaction was processed.
          type: string
          format: date
          nullable: false
      type: object
      description: >
        A payment record that includes additional details about the transaction
        and its processing.
      title: PaymentRecord
    GetPaymentRecordsResponse:
      properties:
        data:
          description: |
            List of Electronic Payment Records
          items:
            $ref: '#/components/schemas/PaymentRecordsDetails'
          type: array
        nextPage:
          description: |
            URL to the next page of results for pagination.
          type: string
          format: url
      type: object
    TaxHealthDetailsRecords:
      properties:
        error_message:
          description: >
            A detailed error message, if any, associated with the transaction or
            event.
          type: string
          nullable: false
        document_number:
          description: >
            The document number associated with the transaction, such as an
            invoice number.
          type: string
          nullable: false
        vendor_name:
          description: |
            The name of the vendor involved in the transaction.
          type: string
          nullable: false
        event_source:
          description: |
            The source of the event, such as a third-party service or system.
          type: string
          nullable: false
        error_category:
          description: |
            The main category of the error, if applicable.
          type: string
          nullable: false
        account_id:
          description: >
            The unique identifier for the account involved in the event or
            transaction.
          type: string
          nullable: false
        event_type:
          description: |
            The type of event, such as tax generation or another action.
          type: string
          nullable: false
        total_duration:
          description: >
            The total time taken to process the event or transaction, in
            milliseconds.
          type: integer
          nullable: false
        zuora_request_id:
          description: |
            A unique identifier for the request to the Zuora system.
          type: string
          nullable: false
        account_name:
          description: |
            The name of the account associated with the event or transaction.
          type: string
          nullable: false
        vendor_duration:
          description: >
            The time taken by the vendor to process the request, in
            milliseconds.
          type: number
          nullable: false
        sub_error_category:
          description: |
            A more specific subcategory of the error, if applicable.
          type: string
          nullable: false
        status:
          description: |
            The current status of the event or transaction.
          type: string
          nullable: false
          enum:
            - success
            - error
        timestamp:
          description: |
            The timestamp of the event or transaction in ISO 8601 format.
          type: string
          format: date-time
          nullable: false
      type: object
      description: >
        A detailed record of an event or transaction, including error details,
        processing durations, and associated account information.
      title: TaxRecords
    GetTaxRecordsResponse:
      properties:
        data:
          description: |
            List of tax record details.
          items:
            $ref: '#/components/schemas/TaxHealthDetailsRecords'
          type: array
        nextPage:
          description: |
            URL to the next page of results for pagination.
          type: string
          format: url
      type: object
    DeleteWorkflowSuccess:
      properties:
        id:
          description: The id of the deleted workflow
          type: string
        success:
          description: The indicator for whether the deletion was a success
          type: boolean
      type: object
    DeleteWorkflowError:
      properties:
        Errors:
          description: The error messages
          items:
            type: string
          type: array
      type: object
    Workflow:
      description: |
        A workflow.
      properties:
        calloutTrigger:
          description: >
            Indicates whether the callout trigger is enabled for the retrieved
            workflow.
          type: boolean
        createdAt:
          description: >
            The date and time when the workflow is created, in the `YYYY-MM-DD
            HH:MM:SS` format.
          format: datetime
          type: string
        description:
          description: |
            The description of the workflow.
          type: string
        id:
          description: |
            The unique ID of the workflow.
          type: integer
        interval:
          description: >
            The schedule of the workflow, in a CRON expression. Returns null if
            the schedued trigger is disabled.
          type: string
        name:
          description: |
            The name of the workflow.
          type: string
        ondemandTrigger:
          description: |
            Indicates whether the ondemand trigger is enabled for the workflow.
          type: boolean
        scheduledTrigger:
          description: |
            Indicates whether the scheduled trigger is enabled for the workflow.
          type: boolean
        timezone:
          description: >
            The timezone that is configured for the scheduler of the workflow.
            Returns null if the scheduled trigger is disabled.
          type: string
        type:
          description: >
            The type of the workflow. Currently the only valid value is
            'Workflow::Setup'.
          enum:
            - Workflow::Setup
            - Workflow::Instance
          type: string
        updatedAt:
          description: >
            The date and time when the workflow is updated the last time, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
        version:
          description: |
            The version number of the workflow. 
          type: string
      title: workflow
      type: object
    WorkflowDefinitionAndVersions:
      description: |
        A workflow.
      properties:
        active_version:
          description: |
            Information of the active version. 
          properties:
            description:
              description: |
                The description of the active version.
              type: string
            id:
              description: |
                The unique ID of the active version.
              type: integer
            status:
              description: |
                The status of the active version.
              type: string
            type:
              description: >
                The type of the active version. Currently the only valid value
                is 'Workflow::Setup'.
              enum:
                - Workflow::Setup
                - Workflow::Instance
              type: string
            version:
              description: |
                The version number of the active version.
              type: string
          type: object
        calloutTrigger:
          description: >
            Indicates whether the callout trigger is enabled for the retrieved
            workflow.
          type: boolean
        createdAt:
          description: >
            The date and time when the workflow is created, in the `YYYY-MM-DD
            HH:MM:SS` format.
          format: datetime
          type: string
        description:
          description: |
            The description of the workflow definition.
          type: string
        id:
          description: |
            The unique ID of the workflow definition.
          type: integer
        interval:
          description: >
            The schedule of the workflow, in a CRON expression. Returns null if
            the schedued trigger is disabled.
          type: string
        latest_inactive_verisons:
          description: >
            The list of inactive workflow versions retrieved. Maximum number of
            versions retrieved is 10.  
          items:
            $ref: '#/components/schemas/Workflow'
          type: array
        name:
          description: |
            The name of the workflow definition.
          type: string
        ondemandTrigger:
          description: |
            Indicates whether the ondemand trigger is enabled for the workflow.
          type: boolean
        scheduledTrigger:
          description: |
            Indicates whether the scheduled trigger is enabled for the workflow.
          type: boolean
        status:
          description: |
            The status of the workflow definition.
          type: string
        timezone:
          description: >
            The timezone that is configured for the scheduler of the workflow.
            Returns null if the scheduled trigger is disabled.
          type: string
        updatedAt:
          description: >
            The date and time when the workflow is updated the last time, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
      title: a workflow definition with version information
      type: object
    GetWorkflowsResponse:
      properties:
        data:
          description: |
            The list of workflows retrieved. 
          items:
            $ref: '#/components/schemas/WorkflowDefinitionAndVersions'
          type: array
        pagination:
          description: >
            An object containing pagination information for the list of
            workflows returned by the api
          properties:
            next_page:
              description: >
                A string containing the URL where the next page of data can be
                retrieved.
              type: string
            page:
              description: |
                An integer denoting the current page number.
              type: integer
            page_length:
              description: >
                An integer denoting the number of workflows in this response.
                The maximum value is 50.
              type: integer
          type: object
      type: object
    Linkage:
      description: Used to represent the relationship between workflow tasks
      properties:
        linkage_type:
          enum:
            - Start
            - Success
            - Failure
            - Iterate
            - 'True'
            - 'False'
            - Approve
            - Reject
          type: string
        source_task_id:
          description: the task that spawned the target task
          type: integer
        source_workflow_id:
          description: the workflow the target task is associated with
          type: integer
        target_task_id:
          description: the task that the source task is linked to.
          type: integer
      type: object
    Task:
      description: |
        A task.
      properties:
        action_type:
          description: |
            The type of the task.
          enum:
            - Approval
            - Attachment
            - Billing::BillRun
            - Billing::CurrencyConversion
            - Billing::CustomInvoice
            - Callout
            - Cancel
            - Create
            - CustomObject::Create
            - CustomObject::Delete
            - CustomObject::Query
            - CustomObject::Update
            - Data::BillingPreviewRun
            - Data::Link
            - Delay
            - Delete
            - Download::SFTP
            - Email
            - Export
            - File::CustomPDF::CustomDocument
            - If
            - InvoiceGenerate
            - Iterate
            - Logic::CSVTranslator
            - Logic::Case
            - Logic::CustomCode
            - Logic::JSONTransform
            - Logic::Lambda
            - Logic::ResponseFormatter
            - Logic::XMLTransform
            - NewProduct
            - Notifications::GoogleCloudPrint
            - Notifications::PhoneCall
            - Notifications::SMS
            - Payment::GatewayReconciliation
            - Payment::PaymentRun
            - Query
            - RemoveProduct
            - Reporting::ReportData
            - Reporting::RunReport
            - Resume
            - Suspend
            - UI::Page
            - UI::Stop
            - Update
            - Upload::FTP
            - Upload::SFTP
            - WriteOff
          type: string
        call_type:
          description: |
            The type of API used.
          type: string
        concurrent_limit:
          description: >-
            the number of concurrent tasks that are allowed to run
            simultaneously
          type: integer
        data:
          description: |
            The data payload for the task.
          type: object
        end_time:
          description: |
            If **Instance** is **true**, the end time of the task instance.
          type: string
        error:
          description: >
            If **Instance** is **true** and **status** is **Error**, the error
            reason of the task instance failure.
          type: string
        error_class:
          description: >
            If **Instance** is **true** and **status** is **Error**, the error
            class of the task instance failure.
          type: string
        error_details:
          description: >
            If **Instance** is **true** and **status** is **Error**, the error
            details of the task instance failure.
          type: string
        id:
          description: |
            The unique ID of the task.
          type: integer
        instance:
          description: |
            Indicates whether this task belongs to an instance of a workflow.
          type: boolean
        name:
          description: |
            The name of the task.
          type: string
        object:
          description: |
            The selected object for the task.
          type: string
        object_id:
          description: |
            The id of the selected object of the task.
          type: string
        original_task_id:
          description: >
            If **Instance** is **true**, the ID of the original task in the
            original workflow.
          type: integer
        original_workflow_id:
          description: |
            If **Instance** is **true**, the ID of the original workflow.
          type: integer
        parameters:
          description: |
            The configuration of the task.
          type: object
        start_time:
          description: |
            If **Instance** is **true**, the start time of the task instance.
          type: string
        status:
          description: |
            If **Instance** is **true**, the status of the task instance.
          enum:
            - Queued
            - Processing
            - Pending
            - Success
            - Stopped
            - Error
          type: string
        tags:
          description: |
            The array of filter tags.
          items:
            type: string
          type: array
        task_id:
          description: >-
            the id of this task's parent task. Will be null if this is the first
            task of the workflow
          type: integer
        workflow_id:
          description: |
            The ID of the workflow that the task belongs to.
          type: integer
      type: object
    POSTWorkflowDefinitionImportRequest:
      example:
        workflow:
          id: 458
          name: Checking Workflow
          description: ''
          type: Workflow::Setup
          ondemand_trigger: true
          callout_trigger: false
          scheduled_trigger: false
          interval: ''
          timezone: ''
          status: Active
          version: 0.0.1
        tasks:
          - id: 1418
            name: Checking the Approval Email
            parameters:
              emailBody: >-
                <body style=\font-family: Arial, sans-serif; margin: 20px;
                line-height: 1.6; color: #333;\>\n\t<p> Hello,</p>\n\t<p>You
                have a pending approval. Please <a
                href=\{{Data.Approval.approveLink}}\>approve</a> or <a
                href=\{{Data.Approval.rejectLink}}\>reject</a>.</p>\n\t<p>Thanks</p>
                \n</body>
              senderName: Admin
              senderEmail: workflow@zuora.com
              approvalNote: ''
              subjectEmail: This is the email to check if this email is working
              delivery_method: email
              email_approver_emails:
                - admin@company.com
            action_type: Approval
            object: ''
            object_id: ''
            call_type: SOAP
            task_id: null
            concurrent_limit: 9999999
            tags: []
        linkages:
          - source_workflow_id: 458
            source_task_id: null
            target_task_id: 1418
            linkage_type: Finish
      properties:
        linkages:
          items:
            $ref: '#/components/schemas/Linkage'
          type: array
        tasks:
          items:
            $ref: '#/components/schemas/Task'
          type: array
        workflow:
          $ref: '#/components/schemas/Workflow'
      type: object
    WorkflowUsage:
      description: |
        The task usage of a particular day.
      properties:
        date:
          description: |
            The date when the usage record is created.
          type: string
        values:
          properties:
            taskCount:
              description: |
                The amount of task runs that have been used.
              type: integer
          type: object
      type: object
    UsagesResponse:
      properties:
        metrics:
          description: |
            The list of tasks retrieved.
          items:
            $ref: '#/components/schemas/WorkflowUsage'
          type: array
      type: object
    TasksResponse:
      properties:
        data:
          description: |
            The list of tasks retrieved.
          items:
            $ref: '#/components/schemas/Task'
          type: array
        pagination:
          description: >
            An object containing pagination information for the list of tasks
            returned by the API.
          properties:
            next_page:
              description: >
                A string containing the URL where the next page of data can be
                retrieved.
              type: string
            page:
              description: |
                An integer denoting the current page number.
              type: integer
            page_length:
              description: >
                An integer denoting the number of tasks in this response. The
                maximum value is 100.
              type: integer
          type: object
      type: object
    UpdateTask:
      description: |
        A task.
      properties:
        action_type:
          description: |
            The type of task.
          type: string
        call_type:
          description: |
            The type of the API used.
          type: string
        concurrent_limit:
          description: |
            The maximum number of this task that can run concurrently.
          maximum: 9999999
          minimum: 1
          type: integer
        id:
          description: |
            The unique ID of the task.
          type: integer
        name:
          description: |
            The name of the task.
          type: string
        object:
          description: |
            The selected object for the task.
          type: string
        object_id:
          description: |
            The ID of the selected object of the task.
          type: string
        status:
          description: |
            The status of the task instance.
          enum:
            - Queued
            - Processing
            - Pending
            - Success
            - Stopped
            - Error
          type: string
        tags:
          description: |
            The array of filter tags.
          items:
            type: string
          type: array
        workflow_id:
          description: |
            The ID of the workflow the task belongs to.
          type: integer
      required:
        - id
      title: task
      type: object
    PutTasksRequest:
      example:
        data:
          - id: 2771
            name: If
            action_type: If
            call_type: SOAP
            status: Success
            workflow_id: 476
      properties:
        data:
          description: |
            The list of tasks to update.
          items:
            $ref: '#/components/schemas/UpdateTask'
          maximum: 50
          minimum: 1
          type: array
      type: object
    BadRequestResponse:
      properties:
        Errors:
          items:
            properties:
              code:
                description: The error code.
                type: string
              status:
                description: The status of the response.
                type: string
              title:
                description: The reason for the error.
                type: string
            type: object
          type: array
      type: object
    GetWorkflowResponse:
      properties:
        cpuTime:
          description: |
            The overall CPU time for the execution of the workflow.
          format: time
          type: string
        createdAt:
          description: >
            The date and time when the workflow is created, in the `YYYY-MM-DD
            HH:MM:SS` format..
          format: datetime
          type: string
        finishedAt:
          description: >
            The date and time when the execution of the workflow completes, in
            the `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
        id:
          description: |
            The unique ID of the workflow.
          type: integer
        messages:
          description: |
            Messages from tasks. 

            **Note:** This field is only returned in Production.
          type: object
        name:
          description: |
            The unique run number of the workflow.
          type: string
        originalWorkflowId:
          description: |
            The ID of the workflow setup.
          type: string
        runTime:
          description: >
            The execution time of the workflow including the waiting time, in
            seconds.
          format: double
          type: number
        status:
          description: |
            The status of the workflow:
              - Queued: The workflow is in queue for being processed.
              - Processing: The workflow is in process.
              - Stopping: The workflow is being stopped through Zuora UI.
              - Stopped: The workflow is stopped through Zuora UI.
              - Finished: The workflow is finished. When a workflow is finished, it might have tasks pending for retry or delay. Pending tasks do not block the onfinish branch of the workflow, but they block the oncomplete branch of the iterate. 
          enum:
            - Queued
            - Processing
            - Stopping
            - Stopped
            - Finished
          type: string
        tasks:
          description: |
            An object containing task counts.
          properties:
            error:
              description: |
                The number of tasks in **Error** state.
              type: integer
            pending:
              description: |
                The number of tasks in **Pending** state.
              type: integer
            processing:
              description: |
                The number of tasks in **Processing** state.
              type: integer
            queued:
              description: |
                The number of tasks in **Queued** state.
              type: integer
            stopped:
              description: |
                The number of tasks in **Stopped** state.
              type: integer
            success:
              description: |
                The number of tasks in **Success** state.
              type: integer
            total:
              description: |
                The total number of tasks.
              type: integer
          type: object
        type:
          description: |
            The type of the current workflow. Possible values:
              - `Workflow::Setup`: The workflow is a setup and is used for creating workflow instances.
              - `Workflow::Instance`: The workflow is an execution that has data.
          type: string
        updatedAt:
          description: >
            The date and time when the workflow is updated the last time, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
      type: object
    WorkflowDefinition:
      description: |
        A workflow.
      properties:
        active_version:
          description: |
            Information of the active version. 
          properties:
            description:
              description: |
                The description of the active version.
              type: string
            id:
              description: |
                The unique ID of the active version.
              type: integer
            status:
              description: |
                The status of the active version.
              type: string
            type:
              description: >
                The type of the active version. Currently the only valid value
                is 'Workflow::Setup'.
              enum:
                - Workflow::Setup
                - Workflow::Instance
              type: string
            version:
              description: |
                The version number of the active version.
              type: string
          type: object
        calloutTrigger:
          description: >
            Indicates whether the callout trigger is enabled for the retrieved
            workflow.
          type: boolean
        createdAt:
          description: >
            The date and time when the workflow is created, in the `YYYY-MM-DD
            HH:MM:SS` format.
          format: datetime
          type: string
        description:
          description: |
            The description of the workflow definition.
          type: string
        id:
          description: |
            The unique ID of the workflow definition.
          type: integer
        interval:
          description: >
            The schedule of the workflow, in a CRON expression. Returns null if
            the schedued trigger is disabled.
          type: string
        name:
          description: |
            The name of the workflow definition.
          type: string
        ondemandTrigger:
          description: |
            Indicates whether the ondemand trigger is enabled for the workflow.
          type: boolean
        scheduledTrigger:
          description: |
            Indicates whether the scheduled trigger is enabled for the workflow.
          type: boolean
        status:
          description: |
            The status of the workflow definition.
          type: string
        timezone:
          description: >
            The timezone that is configured for the scheduler of the workflow.
            Returns null if the scheduled trigger is disabled.
          type: string
        updatedAt:
          description: >
            The date and time when the workflow is updated the last time, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
      title: a workflow definition with version information
      type: object
    ValidationReasons:
      properties:
        fieldName:
          description: The name of the invalid field
          type: string
        title:
          description: A description why that field is invalid
          type: string
      type: object
    ValidationErrors:
      properties:
        reasons:
          description: The list of reasons that the request was unsuccessful
          items:
            $ref: '#/components/schemas/ValidationReasons'
          title: validation reasons
          type: array
        success:
          description: Returns `false` if the request was not successful.
          type: boolean
      type: object
    ExportWorkflowVersionResponse:
      properties:
        linkages:
          items:
            $ref: '#/components/schemas/Linkage'
          type: array
        tasks:
          items:
            $ref: '#/components/schemas/Task'
          type: array
        workflow:
          $ref: '#/components/schemas/Workflow'
      type: object
    WorkflowError:
      properties:
        code:
          description: A short error code describing the error
          enum:
            - invalid
          type: string
        status:
          description: The http status code for this error
          type: integer
        title:
          description: A human readable description describing the error
          type: string
      type: object
    WorkflowInstance:
      description: A instance workflow object.
      properties:
        createdAt:
          description: >
            The date and time when the workflow is created, in the `YYYY-MM-DD
            HH:MM:SS` format.
          format: datetime
          type: string
        id:
          description: |
            The unique ID of the workflow.
          type: integer
        name:
          description: |
            The run number of this workflow instance
          type: string
        originalWorkflowId:
          description: >
            The identifier of the workflow template that is used to create this
            instance.
          type: integer
        status:
          description: |
            Describes the current state of this workflow instance:
              - Queued: The workflow is in queue for being processed.
              - Processing: The workflow is in process.
          enum:
            - Queued
            - Processing
          type: string
        updatedAt:
          description: >
            The date and time the last time when the workflow is updated, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
      type: object
    GetVersionsResponse:
      properties:
        data:
          description: |
            The list of workflow versions retrieved. 
          items:
            $ref: '#/components/schemas/Workflow'
          type: array
      type: object
    DetailedWorkflow:
      description: |
        A workflow.
      properties:
        call_type:
          description: |
            The call type of the active workflow version.
          type: string
        calloutTrigger:
          description: >
            Indicates whether the callout trigger is enabled for the retrieved
            workflow.
          type: boolean
        createdAt:
          description: >
            The date and time when the workflow is created, in the `YYYY-MM-DD
            HH:MM:SS` format.
          format: datetime
          type: string
        description:
          description: |
            The description of the workflow.
          type: string
        finished_at:
          description: >
            The date and time when the instance of the workflow version finished
            at.
          format: datetime
          type: string
        id:
          description: |
            The unique ID of the workflow.
          type: integer
        interval:
          description: >
            The schedule of the workflow, in a CRON expression. Returns null if
            the schedued trigger is disabled.
          type: string
        name:
          description: |
            The name of the workflow.
          type: string
        ondemandTrigger:
          description: |
            Indicates whether the ondemand trigger is enabled for the workflow.
          type: boolean
        original_workflow_id:
          description: |
            The unique ID of the original workflow version.
          type: integer
        priority:
          description: |
            The priority of the active workflow version. 
          type: string
        scheduledTrigger:
          description: |
            Indicates whether the scheduled trigger is enabled for the workflow.
          type: boolean
        started_at:
          description: >
            The date and time when the instance of the workflow version started
            at.
          format: datetime
          type: string
        status:
          description: |
            The status of the active workflow version.
          type: integer
        sync_trigger:
          description: |
            Indicates whether the workflow version is enabled for the sync mode.
          type: boolean
        timezone:
          description: >
            The timezone that is configured for the scheduler of the workflow.
            Returns null if the scheduled trigger is disabled.
          type: string
        type:
          description: >
            The type of the workflow. Currently the only valid value is
            'Workflow::Setup'.
          enum:
            - Workflow::Setup
            - Workflow::Instance
          type: string
        updatedAt:
          description: >
            The date and time when the workflow is updated the last time, in the
            `YYYY-MM-DD HH:MM:SS` format.
          format: datetime
          type: string
        version:
          description: |
            The version number of the active workflow version.            
          type: string
      title: detailed workflow
      type: object
    StopWorkflowRunSuccess:
      type: object
      properties:
        success:
          type: boolean
          description: >-
            The indicator for whether the operation to stop a workflow run was a
            success.
    StopWorkflowRunError:
      type: object
      properties:
        errors:
          type: array
          description: The error messages
          items:
            type: object
            properties:
              code:
                type: string
                description: The error code.
              status:
                type: number
                description: Status code.
              title:
                type: string
                description: Error title.
    ExpandedContact:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the contact.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the contact.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the contact was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the contact.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the contact was last updated.
        accountId:
          description: |
            The ID of the account associated with the contact.
          type: string
        address1:
          description: >
            The first line of the contact's address, which is often a street
            address or business name.
          maxLength: 255
          type: string
        address2:
          description: |
            The second line of the contact's address.
          maxLength: 255
          type: string
        asBillTo:
          type: boolean
          description: |
            Indicates whether the contact can be specified as a bill-to contact.
        asShipTo:
          type: boolean
          description: |
            Indicates whether the contact can be specified as a ship-to contact.
        asSoldTo:
          type: boolean
          description: |
            Indicates whether the contact can be specified as a sold-to contact.
        city:
          description: |
            The city of the contact's address.
          maxLength: 40
          type: string
        country:
          description: |
            The country of the contact's address.
          maxLength: 64
          type: string
        county:
          description: >
            The county. May optionally be used by Zuora Tax to calculate county
            tax.
          maxLength: 32
          type: string
        fax:
          description: |
            The contact's fax number. 
          maxLength: 40
          type: string
        description:
          description: |
            A description for the contact.
          maxLength: 100
          type: string
        firstName:
          description: |
            The contact's first name.
          maxLength: 100
          type: string
        homePhone:
          description: |
            The contact's home phone number.
          maxLength: 40
          type: string
        lastName:
          description: |
            The contact's last name.
          maxLength: 100
          type: string
        mobilePhone:
          description: |
            The mobile phone number of the contact.
          maxLength: 100
          type: string
        nickname:
          description: |
            A nickname for the contact.
          maxLength: 100
          type: string
        otherPhone:
          description: |
            An additional phone number for the contact.
          maxLength: 40
          type: string
        otherPhoneType:
          description: |
            The type of the additional phone number.
          enum:
            - Work
            - Mobile
            - Home
            - Other
          type: string
        personalEmail:
          description: |
            The contact's personal email address.
          maxLength: 80
          type: string
        state:
          description: |
            The state or province of the contact's address.
          maxLength: 40
          type: string
        postalCode:
          description: |
            ZIP code or other postal code of the contact's address.
          maxLength: 20
          type: string
        taxRegion:
          description: >
            If using Zuora Tax, a region string as optionally defined in your
            tax rules. 
          maxLength: 32
          type: string
        workEmail:
          description: |
            The contact's business email address.
          maxLength: 80
          type: string
        workPhone:
          description: |
            The contact's business phone number.
          maxLength: 40
          type: string
      additionalProperties:
        type: object
        description: >
          Custom fields of the Contact object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryContactResponse
    NestedPaymentMethodOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment method.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the payment method.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the payment method gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            method.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the payment method gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        accountId:
          type: string
          description: |
            The unique identifier of the account that the payment method is
            associated with.
        achAbaCode:
          type: string
          description: >
            The nine-digit routing number or ABA number used by banks. This
            field is only required if the `type` field is set to `ACH`.
        achAccountName:
          type: string
          description: >
            The name of the account holder, which can be either a person or a
            company. This field is only required if the `type` field is set to
            `ACH`.
        achAccountNumberMask:
          description: >
            The masked bank account number associated with the ACH payment
            method. This field is only required if the `type` field is set to
            `ACH`.
          type: string
        achAccountType:
          type: string
          description: >
            The type of bank account associated with the ACH payment method.
            This field is only required if the `type` field is set to `ACH`.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify any of
            the allowed values as a dummy value, `Checking` preferably.
          enum:
            - BusinessChecking
            - Checking
            - Saving
        achAddress1:
          type: string
          description: |
            First address line for the ACH payment method.
          maxLength: 255
        achAddress2:
          type: string
          description: |
            Second address line for the ACH payment method.
          maxLength: 255
        achBankName:
          type: string
          description: >
            The name of the bank where the ACH payment account is held.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify a dummy
            value.
          maxLength: 70
        achCity:
          type: string
          description: >
            City for the ACH payment method.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          maxLength: 40
        achCountry:
          description: >
            Country for the ACH payment method. Must be a valid country name or
            abbreviation.


            See <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a> for the list of
            supported country names and abbreviations.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          type: string
        achPostalCode:
          type: string
          description: |
            Zip code or postal code for the ACH payment method.
          maxLength: 20
        achState:
          type: string
          description: >
            State for the ACH payment method. Must be a valid subregion (state
            or province) name or code. For more information, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
            target="_blank">View subregions of a specific country or region</a>.
        active:
          type: boolean
          description: >
            Indicates whether the payment method type is active. This field is
            for Zuora internal use and does not impact customer integration or
            use cases.
        isSystem:
          type: boolean
          description: >
            Indicates whether the payment method is a system-generated payment
            method. This field is for Zuora internal use and does not impact
            customer integration or use cases.
        bankBranchCode:
          type: string
          description: |
            The branch code of the bank used for Direct Debit.  
        bankCheckDigit:
          description: >-
            The check digit in the international bank account number, which
            confirms the validity of the account. Applicable to direct debit
            payment methods.
          type: string
        bankCity:
          type: string
          description: The city of the direct debit bank.
        bankCode:
          type: string
          description: >
            The sort code or number that identifies the bank. This is also known
            as the sort code. 
        bankIdentificationNumber:
          type: string
          description: >-
            The first six or eight digits of the payment method's number, such
            as the credit card number or account number. Banks use this number
            to identify a payment method.
        bankName:
          type: string
          description: The name of the direct debit bank.
        bankPostalCode:
          type: string
          description: The zip code or postal code of the direct debit bank.
        bankStreetName:
          type: string
          description: The name of the street of the direct debit bank.
        bankStreetNumber:
          type: string
          description: The number of the direct debit bank.
        bankTransferAccountName:
          type: string
          description: The name on the direct debit bank account.
        bankTransferAccountNumberMask:
          type: string
          description: >
            This is a masked displayable version of the bank account number,
            used for

            security purposes. For example: `XXXXXXXXX54321`.
        bankTransferAccountType:
          type: string
          description: |
            The type of the customer's bank account. Applicable to direct debit
            payment methods.
        bankTransferType:
          description: >
            Specifies the type of direct debit transfer. The value of this field
            is dependent on the country of the user.


            Possible Values: 



            * `AutomatischIncasso` (NL)


            * `LastschriftDE` (Germany)


            * `LastschriftAT` (Austria)


            * `DemandeDePrelevement` (FR)


            * `DirectDebitUK` (UK)


            * `Domicil` (Belgium)


            * `LastschriftCH` (CH)


            * `RID` (Italy)


            * `OrdenDeDomiciliacion` (Spain)

            * `Autogiro` (Sweden)

            * `Betalingsservice` (Denmark)
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        businessIdentificationCode:
          type: string
          description: >
            The business identification code for Swiss direct payment methods
            that use

            the Global Collect payment gateway. Only applicable to direct debit

            payment methods in Switzerland with Global Collect.
        city:
          description: >
            The city of the customer's address. Applicable to debit payment
            methods.
          type: string
        country:
          type: string
          description: >-
            The two-letter country code of the customer's address. Applicable to
            direct debit payment methods.
        creditCardAddress1:
          type: string
          description: |
            The first line of the card holder's address, which is often a street
            address or business name. Applicable to credit card and direct debit
            payment methods.
        creditCardAddress2:
          type: string
          description: >
            The second line of the card holder's address. Applicable to credit
            card

            and direct debit payment methods.
        creditCardCity:
          type: string
          description: |
            The city of the card holder's address. Applicable to credit card and
            direct debit payment methods.
        creditCardCountry:
          description: >
            The country where the credit card holder stays.


            When creating a payment method through a translated UI or Payment
            Page, a country name in a translated language might be selected. 

            Regardless of the country texts selected when creating the payment
            method, only the supported country name returns in this field. 

            For a complete list of supported country names, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a>. 

            Internationalization is not supported for the API field value.
          type: string
        creditCardExpirationMonth:
          type: integer
          format: int32
          description: |
            One or two digits expiration month.
          minimum: 1
          maximum: 12
        creditCardExpirationYear:
          type: integer
          format: int32
          description: |
            Four-digit expiration year.
        creditCardHolderName:
          type: string
          description: |
            The full name of the credit card holder.
        creditCardMaskNumber:
          description: |
            The masked credit card number, such as `*********1112`.
          type: string
        creditCardPostalCode:
          type: string
          description: |
            The postal code for the address of the credit card holder.
        creditCardState:
          type: string
          description: |
            The state where the credit card holder stays.
        creditCardType:
          description: >
            The type of the credit card or debit card.


            Possible values include `Visa`, `MasterCard`, `AmericanExpress`,
            `Discover`, `JCB`, and `Diners`. For more information about credit
            card types supported by different payment gateways, see [Supported
            Payment
            Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).


            **Note:** This field is only returned for the Credit Card and Debit
            Card payment types.
          type: string
        deviceSessionId:
          description: >
            The session ID of the user when the `PaymentMethod` was created or
            updated.
          type: string
        existingMandate:
          description: |
            Indicates whether the mandate is an existing mandate.
          enum:
            - 'Yes'
            - 'No'
          type: string
        email:
          description: |
            The email address of the payment method holder.
          type: string
        firstName:
          type: string
          description: >
            The customer's first name. Only applicable to direct debit payment
            methods.
        iBAN:
          type: string
          description: >
            The International Bank Account Number used to create the SEPA
            payment method. The value is masked.
        iPAddress:
          type: string
          description: >
            The IP address of the user when the payment method was created or
            updated.
        identityNumber:
          type: string
          description: |
            The identity number of the account holder or the cardholder.
        companyName:
          type: string
          description: |
            The name of the company.
        isCompany:
          type: boolean
          description: |
            Whether the customer account is a company.
        lastFailedSaleTransactionDate:
          type: string
          format: date
          description: >
            The date of the last failed attempt to collect payment with this
            payment

            method.
        lastName:
          type: string
          description: >
            The customer's last name. Only applicable to direct debit payment
            methods.
        lastTransactionDateTime:
          type: string
          description: |
            The date and time of the most recent transaction.
          format: date-time
        lastTransactionStatus:
          type: string
          description: The status of the most recent transaction.
        mandateCreationDate:
          description: |
            The date on which the mandate was created.
          format: date
          type: string
        mandateId:
          description: |
            The mandate ID.
          type: string
        mandateReason:
          description: |
            The reason of the mandate from the gateway side.
          type: string
        mandateReceived:
          type: string
          description: |
            Indicates whether the mandate is received from the gateway.
          enum:
            - 'Yes'
            - 'No'
        mandateStatus:
          type: string
          description: |
            The status of the mandate from the gateway side.
        mandateUpdateDate:
          type: string
          format: date
          description: |
            The date on which the mandate was updated.
        maxConsecutivePaymentFailures:
          type: integer
          format: int32
          description: >
            The number of allowable consecutive failures Zuora attempts with the
            payment method before stopping.
        name:
          type: string
          description: |
            The name of the payment method.
        numConsecutiveFailures:
          type: integer
          format: int32
          description: >
            The number of consecutive failed payments for this payment method.
            It is reset to `0` upon successful payment. 
        paymentMethodStatus:
          type: string
          description: |
            The status of the payment method.
          enum:
            - Active
            - Closed
            - Scrubbed
        paymentRetryWindow:
          type: integer
          format: int32
          description: >
            The retry interval setting, which prevents making a payment attempt
            if the last failed attempt was within the last specified number of
            hours.
        paypalBaid:
          type: string
          description: |
            ID of a PayPal billing agreement. 
          example: I-1TJ3GAGG82Y9
        paypalEmail:
          type: string
          description: |
            Email address associated with the PayPal payment method. 
        paypalPreapprovalKey:
          type: string
          description: |
            The PayPal preapproval key.
        paypalType:
          type: string
          description: |
            The type of the PayPal payment method.
        phone:
          type: string
          description: >
            The phone number that the account holder registered with the bank.
            This

            field is used for credit card validation when passing to a gateway.
        postalCode:
          type: string
          description: >
            The zip code of the customer's address. Only applicable to direct
            debit

            payment methods.
        secondTokenId:
          description: >
            A gateway unique identifier that replaces sensitive payment method
            data.


            **Note:** This field is only returned for the Credit Card Reference
            Transaction payment type.
          type: string
        state:
          type: string
          description: |
            The state of the customer's address. Only applicable to direct debit
            payment methods.
        streetName:
          type: string
          description: >
            The street name of the customer's address. Only applicable to direct
            debit

            payment methods.
        streetNumber:
          type: string
          description: >
            The street number of the customer's address. Only applicable to
            direct

            debit payment methods.
        tokenId:
          type: string
          description: >
            A gateway unique identifier that replaces sensitive payment method
            data or

            represents a gateway's unique customer profile. Applicable to CC
            Reference

            Transaction payment methods.
        totalNumberOfErrorPayments:
          type: integer
          format: int32
          description: The number of error payments that used this payment method.
        totalNumberOfProcessedPayments:
          type: integer
          format: int32
          description: The number of successful payments that used this payment method.
        type:
          type: string
          description: |
            The type of the payment method. For example, `CreditCard`.
        useDefaultRetryRule:
          type: boolean
          description: >
            Indicates whether this payment method uses the default retry rules
            configured in the Zuora Payments settings.
        methodReferenceId:
          type: string
          description: >
            The identification reference of the custom payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Payment Method Data Source Exports and Data Query.
        userReferenceId:
          type: string
          description: >
            The identification reference of the user or customer account.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
        subType:
          type: string
          description: >
            The identification reference indicating the subtype of the custom
            payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
        methodSpecificData:
          type: string
          description: |
            Other method-specific data of the payment method.
        cardBrand:
          description: |
            The card brand, such as `Visa` and `MasterCard`.
          type: string
        cardClass:
          description: |
            The type of the card.
          type: string
          enum:
            - ChargeCard
            - Credit
            - Debit
            - DeferredDebit
            - Prepaid
        cardIssuingBank:
          type: string
          description: |
            The issuer bank of the card, such as `JPMORGAN CHASE BANK N.A.`.
        cardIssuingCountry:
          type: string
          description: |
            The issuing country code of the card, such as `US`.
        cardProductType:
          type: string
          description: |
            The product type of the card.
          enum:
            - Commercial_or_Corporate_Card
            - Consumer_Card
        account:
          type: object
          description: |
            The account to which the payment method belongs.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment Method object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentMethodResponse
    NestedSubscriptionOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the subscription.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the subscription.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the subscription was created in the Zuora
            system, in the `yyyy-mm-dd hh:mm:ss` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the subscription.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the subscription was last updated, in the
            `yyyy-mm-dd hh:mm:ss` format.
        accountId:
          type: string
          description: The ID of the account associated with this subscription.
        autoRenew:
          type: boolean
          description: |
            If `true`, the subscription automatically renews at the end of the
            term. 
          default: false
        cancelledDate:
          type: string
          format: date
          description: |
            The date on which the subscription was canceled.
        contractAcceptanceDate:
          type: string
          format: date
          description: >
            The date when the customer accepts the contract, in the `yyyy-mm-dd`
            format.


            If this field is not set:


            - If the `serviceActivationDate` field is not set, the value of this

            field is set to be the contract effective date.


            - If the `serviceActivationDate` field is set, the value of this
            field

            is set to be the service activation date.



            The billing trigger dates must follow this rule:


            contractEffectiveDate <= serviceActivationDate <=

            contractAcceptanceDate
        contractEffectiveDate:
          type: string
          format: date
          description: >
            The date when the subscription is activated, in the `yyyy-mm-dd`
            format.



            You must specify a Service Activation date if the Customer
            Acceptance

            date is set. If the Customer Acceptance date is not set, the value
            of

            the `serviceActivationDate` field defaults to be the Contract

            Effective Date.



            The billing trigger dates must follow this rule:



            contractEffectiveDate <= serviceActivationDate <=

            contractAcceptanceDate
        creatorAccountId:
          type: string
          description: >
            The ID of the account that created the subscription. This field is

            automatically populated with the ID of the account that creates the

            subscription.



            **Note**: This field is not available for single version
            subscriptions.
        creatorInvoiceOwnerId:
          type: string
          description: >
            The account ID that owns the invoices associated with the
            subscription or the amended subscription.



            **Note**: This field is not available for single version
            subscriptions.
        currentTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the current subscription term.
        currentTermPeriodType:
          type: string
          description: |
            The period type for the current subscription term.
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        initialTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the initial subscription term.
        initialTermPeriodType:
          type: string
          description: |
            The period type for the first subscription term.
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        invoiceOwnerId:
          type: string
          description: >
            The account ID that owns the invoices associated with the
            subscription. 
        isInvoiceSeparate:
          type: boolean
          default: false
          description: >
            Determines if the subscription is invoiced separately. 

            If `true`, then all charges for this subscription are collected into
            the subscription's own invoice.
        isSingleVersioned:
          type: boolean
          description: |
            If `true`, the subscription is a single version subscription.
        name:
          type: string
          description: |
            The name of the subscription.
        notes:
          type: string
          description: |
            Additional information about the subscription.
          maxLength: 65535
        originalCreatedDate:
          type: string
          description: >
            The date when the subscription was originally created. 

            This value is the same as the `createdDate` value until the
            subscription is amended.
        originalId:
          type: string
          description: >
            The original rate plan charge ID. Only available for update

            subscription.



            **Note**: This field is not available for single version
            subscriptions.
        previousSubscriptionId:
          type: string
          description: >
            The ID of the previous subscription. This field is only available if

            the subscription is a renewal subscription.



            **Note**: This field is not available for single version
            subscriptions.
        renewalSetting:
          type: string
          description: >
            Specifies whether a termed subscription will remain `TERMED` or
            change to `EVERGREEN` when it is renewed. 
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the subscription renewal term.
        renewalTermPeriodType:
          type: string
          description: |
            The period type for the subscription renewal term.
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        revision:
          type: string
          description: >
            An auto-generated decimal value uniquely tagged with a subscription.

            The value always contains one decimal place, for example, the
            revision

            of a new subscription is 1.0. If a further version of the
            subscription

            is created, the revision value will be increased by 1. Also, the

            revision value is always incremental regardless of deletion of

            subscription versions.
        serviceActivationDate:
          type: string
          format: date
          description: >
            The date on which the services or products within a subscription
            have been activated and access has been provided to the customer, in
            the `yyyy-mm-dd` format.
        status:
          type: string
          description: |
            Subscription status.
          enum:
            - Draft
            - Pending Activation
            - Pending Acceptance
            - Active
            - Cancelled
            - Suspended
        isLatestVersion:
          description: >
            If `true`, the current subscription object is the latest version.



            **Note**: This field is not available for single version
            subscriptions.
          type: boolean
        subscriptionEndDate:
          type: string
          format: date
          description: >
            The date when the subscription term ends, where the subscription
            ends

            at midnight the day before.


            For example, if the `subscriptionEndDate` is 12/31/2016, the

            subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.


            This date is the same as the term end date or the cancelation date,
            as

            appropriate.
        subscriptionStartDate:
          type: string
          format: date
          description: |
            Date the subscription becomes effective.
        subscriptionVersionAmendmentId:
          type: string
          description: >
            The ID of the amendment made to this subscription version.



            **Note**: This field is not available for single version
            subscriptions.
        termEndDate:
          type: string
          format: date
          description: |
            Date the subscription term ends. If the subscription is evergreen,
            this is null or is the cancellation date (if one has been set).
        termStartDate:
          type: string
          format: date
          description: >
            Date the subscription term begins. If this is a renewal
            subscription,

            this date is different from the subscription start date.
        termType:
          type: string
          description: |
            The type of the subscription term.
          enum:
            - TERMED
            - EVERGREEN
        version:
          type: integer
          format: int64
          description: >-
            This is the subscription version automatically generated by Zuora
            Billing. Each order or amendment creates a new version of the
            subscription, which incorporates the changes made in the order or
            amendment.
        cMRR:
          type: number
          description: |
            Monthly recurring revenue of the subscription.
        billToContactSnapshotId:
          type: string
          description: |
            The ID of the bill-to contact snapshot.
        billToContactId:
          type: string
          description: |
            The ID of the bill-to contact for the subscription.
        invoiceTemplateId:
          type: string
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          type: string
          description: |
            The ID of the ship-to contact for the subscription.
        shipToContactSnapshotId:
          type: string
          description: |
            The ID of the ship-to contact snapshot.
        soldToContactId:
          type: string
          description: |
            The ID of the sold-to contact for the subscription.
        soldToContactSnapshotId:
          type: string
          description: |
            The ID of the sold-to contact snapshot.
        externallyManagedBy:
          type: string
          description: >
            An enum field on the Subscription object to indicate the name of a

            third-party store. This field is used to represent subscriptions
            created

            through third-party stores.
          enum:
            - Amazon
            - Apple
            - Google
            - Roku
        lastBookingDate:
          description: >
            The last booking date of the subscription object. This field is

            writable only when the subscription is newly created as a first

            version subscription. You can override the date value when creating
            a

            subscription through the Subscribe and Amend API or the subscription

            creation UI (non-Orders). Otherwise, the default value `today` is
            set

            per the user's timezone. The value of this field is as follows:


            * For a new subscription created by the [Subscribe and Amend

            APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),

            this field has the value of the subscription creation date.


            * For a subscription changed by an amendment, this field has the
            value

            of the amendment booking date.


            * For a subscription created or changed by an order, this field has

            the value of the order date. 
          format: date
          type: string
        invoiceScheduleId:
          type: string
          description: >
            The ID of the invoice schedule associated with the subscription.



            If multiple invoice schedules are created for different terms of a

            subscription, this field stores the latest invoice schedule.



            **Note**: This field is available only if you have the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"

            target="_blank">Billing Schedule</a> feature enabled.
        cancelReason:
          type: string
          description: >
            The reason for a subscription cancellation copied from the

            `changeReason` field of a Cancel Subscription order action. 


            This field contains valid value only if a subscription is cancelled

            through the Orders UI or API. Otherwise, the value for this field
            will

            always be `null`.
        prepayment:
          type: boolean
          description: |
            Whether the subscription is prepaid.
        currency:
          description: >
            The currency of the subscription.

            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currencies</a> feature enabled.
          type: string
        orderId:
          description: >
            The ID of the order associated with the subscription.

              
            **Note**: This field is available only for orders that exist after
            the end of June 2023.
          type: string
        rampId:
          type: string
          description: >
            The ID of the ramp object associated with the subscription.


            **Note**: This field is available only if you have the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Ramp"

            target="_blank">Ramp</a> feature enabled.
        paymentTerm:
          type: string
          description: |
            Name of the payment term associated with the account. For example,
            "Net 30". The payment term determines the due dates of invoices.
        quoteNumber__QT:
          type: string
          description: >
            The unique identifier of the Quote. This field is used in Zuora data

            sources to report on Subscription metrics. If the subscription
            originated

            from Zuora Quotes, the value is populated with the value from Zuora

            Quotes.
          maxLength: 32
        quoteType__QT:
          description: >
            The Quote type that represents the subscription lifecycle stage such
            as

            New, Amendment, Renew or Cancel. This field is used in Zuora data
            sources

            to report on Subscription metrics. If the subscription originated
            from

            Zuora Quotes, the value is populated with the value from Zuora
            Quotes.
          maxLength: 32
          type: string
        quoteBusinessType__QT:
          type: string
          description: >
            The specific identifier for the type of business transaction the
            Quote

            represents such as New, Upsell, Downsell, Renewal or Churn. This
            field is

            used in Zuora data sources to report on Subscription metrics. If the

            subscription originated from Zuora Quotes, the value is populated
            with the

            value from Zuora Quotes.
          maxLength: 32
        opportunityName__QT:
          type: string
          description: >
            The unique identifier of the Opportunity. This field is used in
            Zuora data

            sources to report on Subscription metrics. If the subscription
            originated

            from Zuora Quotes, the value is populated with the value from Zuora

            Quotes.
          maxLength: 100
        opportunityCloseDate__QT:
          type: string
          format: date
        cpqBundleJsonId__QT:
          description: >
            The Bundle product structures from Zuora Quotes if you utilize
            Bundling in Salesforce. Do not change the value in this field.
          maxLength: 32
          type: string
        account:
          type: object
          description: |
            The subscription owner account associated with the subscription.
        invoiceOwner:
          type: object
          description: |
            The invoice owner account associated with the subscription.
        billToContact:
          type: object
          description: >
            The bill-to contact who pays the billing documents for this
            subscription.
        invoiceItems:
          type: array
          items:
            type: object
          description: |
            The invoice items associated with the subscription.
        ratePlans:
          type: array
          items:
            type: object
          description: |
            The rate plans associated with the subscription.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Subscription object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QuerySubscriptionResponse
    NestedPaymentOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the payment.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the payment gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the payment.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the payment gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        accountId:
          description: |
            The ID of the customer account that the payment is for.
          type: string
        accountingCode:
          type: string
          description: |
            The accounting code for the charge. Accounting codes group
            transactions that contain similar accounting attributes.
        amount:
          description: |
            The total amount of the payment.
          format: double
          type: number
        appliedAmount:
          description: |
            The applied amount of the payment.
          format: double
          type: number
        authTransactionId:
          description: |
            The authorization transaction ID from the payment gateway.
          type: string
        appliedCreditBalanceAmount:
          type: number
          description: |
            The amount of the payment to apply to a credit balance. 
        bankIdentificationNumber:
          type: string
          description: >
            The first six or eight digits of the credit card or debit card used
            for the payment, when applicable. 

            Use this field to <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DF_Reconciling_Payments_with_Merchant_Accounts"
            target="_blank">reconcile payments between the gateway and merchant
            banks</a>.
        cancelledOn:
          type: string
          description: |
            The date when the payment was canceled.
          format: date-time
        comment:
          type: string
          description: |
            Comments about the payment.
          nullable: true
        currency:
          description: >
            When Standalone Payment is not enabled, the `currency` of the
            payment must be the same as the payment currency defined in the
            customer account settings through Zuora UI.


            When Standalone Payment is enabled and `standalone` is `true`, the
            `currency` of the standalone payment can be different from the
            payment currency defined in the customer account settings. The
            amount will not be summed up to the account balance or key metrics
            regardless of currency.
          type: string
          example: USD
        effectiveDate:
          type: string
          format: date
          description: >
            The date and time when the payment takes effect, in `yyyy-mm-dd
            hh:mm:ss` format.
        gatewayOrderId:
          description: >
            A merchant-specified natural key value that can be passed to the
            electronic payment gateway when a payment is created.
          type: string
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: >
            The message returned from the payment gateway for the payment. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: >
            The code returned from the payment gateway for the payment. This
            code is gateway-dependent.
          type: string
        gatewayState:
          description: |
            The status of the payment in the gateway; use for reconciliation. 
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        gatewayTransactionState:
          type: string
        isStandalone:
          type: boolean
          description: |
            Indicates whether the payment is a standalone payment. A standalone
            payment is a payment that is not associated with any invoice or
            subscription.
        markedForSubmissionOn:
          type: string
          format: date-time
          description: |
            The date and time when a charge was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
        paymentMethodId:
          type: string
          description: >
            The unique ID of the payment method that the customer used to make
            the payment.
        paymentMethodSnapshotId:
          type: string
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular Payment Method used in a transaction.
        paymentOptionId:
          type: string
          description: >
            ID of the paymentOption object, which describe the transactional
            level rules for processing payments. 
        paymentNumber:
          type: string
          description: |
            The unique identification number of a payment. 
          example: P-00000028.
        payoutId:
          type: string
          description: |
            The payout ID of the payment from the gateway side.
        prepayment:
          description: >
            Indicates whether the payment is used as a reserved payment. 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
        referencedPaymentID:
          type: string
          description: |
            The ID of a referenced payment. 
        referenceId:
          description: >
            The transaction ID returned by the payment gateway. Use this field
            to reconcile payments between your gateway and Zuora Payments.
          type: string
        refundAmount:
          type: number
          description: |
            The amount of the payment that is refunded.
          format: double
        secondPaymentReferenceId:
          type: string
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional transaction for the payment. Use this field to reconcile
            payments between your gateway and Zuora Payments.
        settledOn:
          type: string
          format: date-time
          description: >
            The date and time when the payment was settled in the payment
            processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by
            the Spectrum gateway only and not applicable to other gateways.
        softDescriptor:
          type: string
          description: >
            A payment gateway-specific field that maps to Zuora for the
            gateways, Orbital, Vantiv and Verifi.
        softDescriptorPhone:
          type: string
          description: >
            A payment gateway-specific field that maps to Zuora for the
            gateways, Orbital, Vantiv and Verifi.
        source:
          type: string
          description: >
            Indicates how the payment was created, whether through API,
            manually, import, or payment run.
          enum:
            - PaymentRun
            - Import
            - Manually
            - API
        sourceName:
          type: string
          description: |
            Name of the source. It can be a payment run number or a file name.
        status:
          description: |
            The status of the payment.
          enum:
            - Draft
            - Processing
            - Processed
            - Error
            - Canceled
            - Posted
          type: string
        submittedOn:
          description: >
            The date and time when the payment was submitted, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        type:
          description: |
            The type of the payment.
          enum:
            - External
            - Electronic
          type: string
        transferredToAccounting:
          description: >
            Whether the payment was transferred to an external accounting
            system. Use this field for integration with accounting systems, such
            as NetSuite. 
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        transactionSource:
          type: string
          description: >
            Payment transaction source used to differentiate the transaction
            source in Stored Credential Transaction framework.
              - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
              - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.
              - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
              - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.
          enum:
            - C_Unscheduled
            - M_Recurring
            - M_Unscheduled
            - M_MOTO
        unappliedAmount:
          type: number
          description: |
            The unapplied amount of the payment.
        lastEmailDateTime:
          type: string
          description: >
            The date and time when the last email was sent to the customer for
            the payment.
        gateway:
          type: string
          description: |
            Name of the gateway instance that processes the payment. 
        account:
          type: object
          description: |
            The account associated with the payment.
        paymentMethod:
          type: object
          description: |
            The payment method used for this payment.
        paymentApplications:
          type: array
          items:
            type: object
          description: |
            The payment applications associated with the payment.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentResponse
    NestedRefundOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the refund.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the refund.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the refund.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund was last updated.
        accountId:
          description: >
            The ID of the account associated with this refund. Zuora associates
            the refund automatically with the account from the associated
            payment or credit memo.
          type: string
        amount:
          description: |
            The total amount of the refund.
          format: double
          type: number
        cancelledOn:
          description: >
            The date and time when the refund was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        comment:
          description: |
            Comments about the refund.
          type: string
          nullable: true
        paymentMethodSnapshotId:
          type: string
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular payment method used in a transaction.
        accountingCode:
          type: string
          description: >
            The accounting code that maps to this refund transaction in your
            accounting

            system.
        currency:
          type: string
          description: |
            The currency of the refund.
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: |
            The message returned from the payment gateway for the refund. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: |
            The code returned from the payment gateway for the refund. This code
            is gateway-dependent.
          type: string
        gatewayState:
          description: |
            The status of the refund in the gateway. 
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        markedForSubmissionOn:
          description: >
            The date and time when a refund was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        methodType:
          description: |
            How an external refund was issued to a customer. 
          enum:
            - ACH
            - Cash
            - Check
            - CreditCard
            - PayPal
            - WireTransfer
            - DebitCard
            - CreditCardReferenceTransaction
            - BankTransfer
            - Other
          type: string
        paymentMethodId:
          type: string
          description: >
            The unique ID of the payment method that the customer used to make
            the refund.
        payoutId:
          type: string
          description: |
            The payout ID of the refund from the gateway side.
        reasonCode:
          type: string
          description: |
            A code identifying the reason for the transaction.
        refundNumber:
          type: string
          description: |
            The number of the refund.
        referenceID:
          description: >
            The transaction ID returned by the payment gateway for an electronic
            refund. Use this field to reconcile refunds between your gateway and
            Zuora Payments.
          type: string
        refundDate:
          description: >
            The date when the refund takes effect, in `yyyy-mm-dd` format. For
            example, 2017-03-01.
          format: date
          type: string
        refundTransactionTime:
          description: >
            The date and time when the refund was issued, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        sourceType:
          type: string
          description: >
            Specifies whether the refund is a refund payment or a credit
            balance. 
          enum:
            - Payment
            - CreditBalance
            - CreditMemo
        secondRefundReferenceId:
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional transaction for the refund. Use this field to reconcile
            payments between your gateway and Zuora Payments.
          type: string
        settledOn:
          description: >
            The date and time when the refund was settled in the payment
            processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by
            the Spectrum gateway only and not applicable to other gateways.
          format: date-time
          type: string
        softDescriptor:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        softDescriptorPhone:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        status:
          description: |
            The status of the refund. 
          enum:
            - Processed
            - Canceled
            - Error
            - Processing
          type: string
        submittedOn:
          type: string
          description: >
            The date and time when the refund was submitted, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
        transferredToAccounting:
          description: >
            Whether the refund was transferred to an external accounting system.
            Use this field for integration with accounting systems, such as
            NetSuite. 
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        type:
          type: string
          description: |
            The type of the refund. 
          enum:
            - External
            - Electronic
        associatedTransactionNumber:
          type: string
          description: |
            The number of the associated transactions, such as payments.
        gateway:
          type: string
          description: >
            The gateway that processed the original payment. A gateway is an
            online service provider that connects an online shopping cart to a
            payment processor.

            Zuora uses this same gateway for the corresponding refund. 

            If this payment gateway is no longer active, then the electronic
            refund fails. 
        account:
          type: object
          description: |
            The account associated with the refund.
        paymentMethod:
          type: object
          description: |
            The payment method to which the refund is returned.
        refundApplications:
          type: array
          items:
            type: object
          description: |
            The refund applications associated with the refund.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Refund object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryRefundResponse
    NestedCreditMemoOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the credit memo.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the credit memo.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the credit memo.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo was last updated.
        appliedAmount:
          description: |
            The applied amount of the credit memo.
          format: double
          type: number
        balance:
          type: number
          description: |
            The remaining balance of credit memo.
        billToContactId:
          description: >
            The ID of the bill-to contact associated with the credit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the credit
            memo.


            The value of this field is `null` if the bill rule [Preserve
            snapshot of bill-to and sold-to contacts when billing documents are
            posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted)
            is disabled.
          type: string
        cancelledById:
          description: |
            The ID of the Zuora user who cancelled the credit memo.
          type: string
          nullable: true
        cancelledOn:
          description: >
            The date and time when the credit memo was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
          nullable: true
        comment:
          description: |
            Comments about the credit memo.
          type: string
          nullable: true
        currency:
          description: >
            The currency of the credit memo.


            **Note:** By default, the currency on a billing document matches the
            default currency set on the associated account. 

            However, Zuora now offers a Multiple Currencies feature to support
            different currencies for billing documents, allowing flexibility
            beyond the account-level currency. 

            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currency</a>.
          type: string
          nullable: true
        discountAmount:
          type: number
          description: |
            The amount of the discount on the credit memo.
        einvoiceErrorCode:
          description: >
            The error code returned when the e-invoice file status is `Failed`.
            This code can either be a Zuora-generated error code or one returned
            by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceErrorMessage:
          description: >
            The error message returned when the e-invoice file status is
            `Failed`. This message can either be a Zuora-generated error message
            or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceFileId:
          description: >
            The ID of the e-invoice file generated for the credit memo.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceStatus:
          description: >
            The status of the e-invoice file generation for the credit memo. 


            - If e-invoice file generation succeeds, this field is either
            `Generated` or `Success`, and both the error code and message are
            empty, and the `eInvoiceFileId` field stores the ID of the generated
            e-invoice file.

            - If a failure occurs during e-invoice file generation, this field
            is `Failed` and an error code and an error message are returned
            respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage`
            fields. 

            - If e-invoice file generation conditionally succeeds, this field is
            `ConditionalSuccess` and an error code and an error message are 
            returned respectively in the `einvoiceErrorCode` and
            `einvoiceErrorMessage` fields.

            - If the e-invoice file has been approved by the tax authority, this
            field is `ApprovedByAuthority`. The next status will be either
            `Success` or `Rejected`.

            - If the e-invoice file has been rejected by the government, this
            field is `Rejected`. You cannot resend this e-invoice; you must
            create a new invoice instead.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          enum:
            - Processing
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        excludeFromAutoApplyRules:
          description: >
            Whether the credit memo is excluded from the rule of automatically
            applying credit memos to invoices.
          type: boolean
        exchangeRateDate:
          type: string
          format: date
          description: >
            The date of the exchange rate used. The date is in `yyyy-mm-dd`
            format.

            Corresponds to the value specified in the Provider Exchange Rate
            Date column in the Import Foreign Exchange Rates template when you
            uploaded the rates through the Mass Updater.
        autoApplyUponPosting:
          description: |
            Whether the credit memo automatically applies to the invoice upon
            posting.
          type: boolean
        memoDate:
          type: string
          format: date
          description: |
            The date when the credit memo takes effect, in `yyyy-mm-dd` format.
            For example, `2024-01-01`.
        memoNumber:
          description: |
            The unique identification number of the credit memo.
          type: string
        postedById:
          description: |
            The ID of the Zuora user who posted the credit memo.
          type: string
        postedOn:
          description: |
            The date and time when the credit memo was posted, in
            `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        reasonCode:
          description: |
            A code identifying the reason for the transaction. The value
            must be an existing reason code or empty.
          type: string
        refundAmount:
          description: |
            The amount of the refund on the credit memo.
          format: double
          type: number
        revenueImpacting:
          description: >
            Indicates whether this write off operation impacts the revenue. If
            `revenueImpacting` = `Yes`, the deferred revenue accounting code
            will be automatically selected from the associated invoice.


            If `revenueImpacting` = `No`, users can select an accounting code
            such as bad-debt expense accounting code for the write off
            operation.
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        reversed:
          description: |
            Whether the credit memo is reversed.
          type: boolean
        sequenceSetId:
          description: >
            The ID of the sequence set associated with the credit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
          nullable: true
        source:
          description: >
            The source of the credit memo.


            Possible values:

            - `BillRun`: The credit memo is generated by a bill run.

            - `API`: The credit memo is created by calling the [Invoice and
            collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment)
            operation, or by calling the Orders, Order Line Items, or
            Fulfillments API operations.

            - `ApiSubscribe`: The credit memo is created by calling the [Create
            subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription)
            and [Create
            account](https://developer.zuora.com/api-references/api/operation/POST_Account)
            operation.

            - `ApiAmend`: The credit memo is created by calling the [Update
            subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription)
            operation.

            - `AdhocFromPrpc`: The credit memo is created from a product rate
            plan charge through the Zuora UI or by calling the [Create a credit
            memo from a
            charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc)
            operation.

            - `AdhocFromInvoice`: The credit memo is created from an invoice or
            created by reversing an invoice. You can create a credit memo from
            an invoice through the Zuora UI or by calling the [Create credit
            memo from
            invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice)
            operation. You can create a credit memo by reversing an invoice
            through the Zuora UI or by calling the [Reverse
            invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice)
            operation.
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        sourceId:
          description: |
            The ID of the credit memo source.

            If a credit memo is generated from a bill run, the value is the
            number of the corresponding bill run. Otherwise, the value is
            `null`.
          type: string
        sourceType:
          description: |
            The type of the credit memo source.
          enum:
            - Subscription
            - Standalone
            - Invoice
            - Order
            - CreditMemo
            - Consolidation
          type: string
        status:
          description: |
            The status of the credit memo.
          enum:
            - Draft
            - Posted
            - Canceled
            - Error
            - PendingForTax
            - Generating
            - CancelInProgress
          type: string
        targetDate:
          description: >
            The target date for the credit memo, in `yyyy-mm-dd` format. For
            example, `2024-01-01`.
          format: date
          type: string
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxMessage:
          description: >
            The message about the status of tax calculation related to the
            credit memo. If tax calculation fails in one credit memo, this field
            displays the reason for the failure.
          type: string
          nullable: true
        taxStatus:
          description: >
            The status of tax calculation related to the credit memo.


            **Note**: This field is only applicable to tax calculation by
            third-party tax engines. Also, the `Voided` status indicates that
            the tax transaction is successfully canceled on the tax vendor's
            side.  If a tax transaction was successfully committed to the
            third-party tax engine but the invoice failed to post, Zuora
            automatically detects the issue and voids the tax transaction on the
            vendor's side.
          enum:
            - Complete
            - Error
            - UnknownError
            - DuplicateDoc
            - InvalidRequest
            - InvalidResponse
            - TaxEngineError
            - ConcurrentModify
            - InternalServerError
            - TaxCodeTemplateError
            - Voided
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the
            credit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the
            credit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        taxAutoCalculation:
          default: true
          description: |
            Whether to automatically calculate taxes in the credit memo.
          type: boolean
        totalAmount:
          type: number
          format: double
          description: |
            The total amount of the credit memo, including taxes.
        totalAmountWithoutTax:
          type: number
          format: double
          description: |
            The total amount of the credit memo, excluding taxes.
        totalTaxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        transferredToAccounting:
          description: |
            Whether the credit memo was transferred to an external
            accounting system. This field is used for integration with
            accounting systems such as NetSuite.
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          description: |
            The ID of a referred invoice.
          type: string
        accountId:
          description: |
            The ID of the customer account associated with the credit memo.
          type: string
        account:
          type: object
          description: |
            The account associated with the credit memo.
        billToContact:
          type: object
          description: |
            The bill-to contact on the account.
        creditMemoItems:
          type: array
          items:
            type: object
          description: |
            The credit memo items on the current credit memo.
        creditMemoApplications:
          type: array
          items:
            type: object
          description: >
            The credit memo applications associated with the current credit
            memo.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Credit Memo object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryCreditMemoResponse
    NestedDebitMemoOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the debit memo.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the debit memo.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the debit memo.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo was last updated.
        autoPay:
          description: >
            Whether debit memos are automatically picked up for processing in
            the

            corresponding payment run.



            By default, debit memos are automatically picked up for processing
            in

            the corresponding payment run.
          type: boolean
        creditMemoId:
          type: string
          description: |
            The ID of the credit memo from which the debit memo was created.
          nullable: true
        balance:
          type: number
          description: |
            The remaining balance of debit memo.
        billToContactId:
          description: >
            The ID of the bill-to contact associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the debit
            memo.


            The value of this field is `null` if the bill rule [Preserve
            snapshot of bill-to and sold-to contacts when billing documents are
            posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted)
            is disabled.
          type: string
        cancelledById:
          description: |
            The ID of the Zuora user who cancelled the debit memo.
          type: string
          nullable: true
        cancelledOn:
          description: >
            The date and time when the debit memo was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
          nullable: true
        comments:
          description: |
            Comments about the debit memo.
          type: string
        currency:
          description: >
            The currency of the debit memo.


            **Note:** By default, the currency on a billing document matches the
            default currency set on the associated account. 

            However, Zuora now offers a Multiple Currencies feature to support
            different currencies for billing documents, allowing flexibility
            beyond the account-level currency. 

            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currency</a>.
          type: string
          nullable: true
        discountAmount:
          type: number
          description: |
            The amount of the discount on the debit memo.
        dueDate:
          type: string
          format: date
          description: |
            The date by which the payment for the debit memo is due, in
            `yyyy-mm-dd` format.
        einvoiceErrorCode:
          description: >
            The error code returned when the e-invoice file status is `Failed`.
            This code can either be a Zuora-generated error code or one returned
            by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceErrorMessage:
          description: >
            The error message returned when the e-invoice file status is
            `Failed`. This message can either be a Zuora-generated error message
            or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceFileId:
          description: >
            The ID of the e-invoice file generated for the debit memo.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceStatus:
          description: >
            The status of the e-invoice file generation for the credit memo. 


            - If e-invoice file generation succeeds, this field is either
            `Generated` or `Success`, and both the error code and message are
            empty, and the `eInvoiceFileId` field stores the ID of the generated
            e-invoice file.

            - If a failure occurs during e-invoice file generation, this field
            is `Failed` and an error code and an error message are returned
            respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage`
            fields. 

            - If e-invoice file generation conditionally succeeds, this field is
            `ConditionalSuccess` and an error code and an error message are 
            returned respectively in the `einvoiceErrorCode` and
            `einvoiceErrorMessage` fields.

            - If the e-invoice file has been approved by the tax authority, this
            field is `ApprovedByAuthority`. The next status will be either
            `Success` or `Rejected`.

            - If the e-invoice file has been rejected by the government, this
            field is `Rejected`. You cannot resend this e-invoice; you must
            create a new invoice instead.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          enum:
            - Processing
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        exchangeRateDate:
          type: string
          format: date
          description: >
            The date of the exchange rate used. The date is in `yyyy-mm-dd`
            format.

            Corresponds to the value specified in the Provider Exchange Rate
            Date column in the Import Foreign Exchange Rates template when you
            uploaded the rates through the Mass Updater.
        memoDate:
          type: string
          format: date
          description: |
            The date when the debit memo takes effect, in `yyyy-mm-dd` format.
            For example, `2024-01-01`.
        memoNumber:
          description: |
            The unique identification number of the debit memo.
          type: string
        postedById:
          description: |
            The ID of the Zuora user who posted the debit memo.
          type: string
        postedOn:
          description: |
            The date and time when the debit memo was posted, in
            `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        reasonCode:
          description: |
            A code identifying the reason for the transaction. The value
            must be an existing reason code or empty.
          type: string
        sequenceSetId:
          description: >
            The ID of the sequence set associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
          nullable: true
        source:
          description: >
            The source of the debit memo.

            Possible values:

            - `BillRun`: The debit memo is generated by a bill run.

            - `API`

            - `ApiSubscribe`: The debit memo is created by calling the [Create
            subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription)
            and [Create
            account](https://developer.zuora.com/api-references/api/operation/POST_Account)
            operation.

            - `ApiAmend`: The debit memo is created by calling the [Update
            subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription)
            operation.

            - `AdhocFromPrpc`: The debit memo is created from a product rate
            plan charge through the Zuora UI or by calling the [Create a debit
            memo from a
            charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc/)
            operation.

            - `AdhocFromInvoice`: The debit memo is created from an invoice or
            created by reversing an invoice. You can create a debit memo from an
            invoice through the Zuora UI or by calling the [Create a debit memo
            from an
            invoice](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice/)
            operation.
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        sourceId:
          description: |
            The ID of the debit memo source.

            If a debit memo is generated from a bill run, the value is the
            number of the corresponding bill run. Otherwise, the value is
            `null`.
          type: string
        sourceType:
          description: |
            The type of the debit memo source.
          enum:
            - Subscription
            - Standalone
            - Order
            - Consolidation
            - Invoice
            - CreditMemo
          type: string
        status:
          description: |
            The status of the debit memo.
          enum:
            - Draft
            - Posted
            - Canceled
            - Error
            - PendingForTax
            - Generating
            - CancelInProgress
          type: string
        targetDate:
          description: >
            The target date for the debit memo, in `yyyy-mm-dd` format. For
            example, `2024-01-01`.
          format: date
          type: string
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxMessage:
          description: |
            The message about the status of tax calculation related to the
            debit memo. If tax calculation fails in one debit memo, this
            field displays the reason for the failure.
          type: string
          nullable: true
        taxStatus:
          description: >
            The status of tax calculation related to the debit memo.



            **Note**: This field is only applicable to tax calculation by

            third-party tax engines. Also, the `Voided` status indicates that
            the tax transaction is successfully canceled on the tax vendor's
            side. 

            If a tax transaction was successfully committed to the third-party
            tax engine but the invoice failed to post, Zuora automatically
            detects

            the issue and voids the tax transaction on the vendor's side.
          enum:
            - Complete
            - Error
            - UnknownError
            - DuplicateDoc
            - InvalidRequest
            - InvalidResponse
            - TaxEngineError
            - ConcurrentModify
            - InternalServerError
            - TaxCodeTemplateError
            - Voided
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the
            debit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the
            debit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        taxAutoCalculation:
          default: true
          description: |
            Whether to automatically calculate taxes in the debit memo.
          type: boolean
        totalAmount:
          type: number
          format: double
          description: |
            The total amount of the debit memo, including taxes.
        totalAmountWithoutTax:
          type: number
          format: double
          description: |
            The total amount of the debit memo, excluding taxes.
        totalTaxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        transferredToAccounting:
          description: |
            Whether the debit memo was transferred to an external
            accounting system. This field is used for integration with
            accounting systems such as NetSuite.
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          description: |
            The ID of a referred invoice.
          type: string
        accountId:
          description: |
            The ID of the customer account associated with the debit memo.
          type: string
        paymentTerm:
          type: string
          description: >
            The name of the payment term assoicated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing

            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)

            feature disabled.
        account:
          type: object
          description: |
            The account associated with the debit memo.
        billToContact:
          type: object
          description: |
            The bill-to contact associated with the debit memo.
        debitMemoItems:
          type: array
          items:
            type: object
          description: |
            The debit memo items associated with the debit memo.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Debit Memo object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryDebitMemoResponse
    NestedInvoiceOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the invoice.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the invoice.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the invoice gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the invoice.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the invoice gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        accountId:
          description: |
            The ID of the customer account associated with the invoice.
          type: string
        adjustmentAmount:
          description: |
            The amount of the invoice adjustments associated with the invoice.
          format: double
          type: number
        amount:
          description: |
            The total amount of the invoice.
          format: double
          type: number
        amountWithoutTax:
          description: |
            The invoice amount excluding tax.
          format: double
          type: number
        autoPay:
          description: >
            Whether invoices are automatically picked up for processing in the
            corresponding payment run.
          type: boolean
        balance:
          description: >
            The remaining balance of the invoice after all payments,
            adjustments, and refunds are applied.
          type: number
          format: double
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the invoice.
          type: string
        billToContactSnapshotId:
          description: |
            The ID of the bill-to contact snapshot associated with the invoice.
          type: string
        comments:
          type: string
          description: |
            Comments about the invoice.
        creditBalanceAdjustmentAmount:
          description: >
            The currency amount of the adjustment applied to the customer's
            credit balance.

              **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.
          format: double
          type: number
        creditMemoAmount:
          description: >
            The currency amount of all credit memos applied to this invoice.


            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          format: double
          type: number
        currency:
          description: >
            The currency of the invoice.


            **Note:** By default, the currency on a billing document matches the
            default currency set on the associated account. 

            However, Zuora now offers a Multiple Currencies feature to support
            different currencies for billing documents, allowing flexibility
            beyond the account-level currency. 

            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currency</a>.
          nullable: true
          type: string
        dueDate:
          type: string
          format: date
          description: >
            The date by which the payment for this invoice is due, in
            `yyyy-mm-dd` format.
        includesOneTime:
          description: |
            Specifies whether the invoice includes one-time charges.
          type: boolean
        includesRecurring:
          description: |
            Specifies whether the invoice includes recurring charges.
          type: boolean
        includesUsage:
          description: |
            Specifies whether the invoice includes usage charges.
          type: boolean
        invoiceDate:
          description: |
            The date that appears on the invoice being created.
          format: date
          type: string
        invoiceNumber:
          description: |
            The unique identification number of the invoice.
          type: string
        lastEmailSentDate:
          description: |
            The date when the invoice was last emailed.
          type: string
        organizationId:
          type: string
          description: |
            ID of the organization this object belongs to.
        paymentAmount:
          description: |
            The amount of payments applied to the invoice.
          format: double
          type: number
        postedBy:
          description: |
            The user ID of the person who moved the invoice to Posted status.
          type: string
        postedDate:
          description: |
            The date when the invoice was posted.
          format: date-time
          type: string
        refundAmount:
          description: >
            Specifies the amount of a refund that was applied against an earlier
            payment on the invoice.
          format: double
          type: number
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the invoice.
          type: string
        communicationProfileId:
          description: |
            The ID of the communication profile associated with the invoice.
          type: string
          nullable: true
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the invoice.
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the invoice.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the invoice.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the invoice.
          type: string
        source:
          description: |
            The source of the invoice.
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
          type: string
        sourceId:
          description: >
            The ID of the invoice source.

            If an invoice is generated from a bill run, the value is the number
            of the corresponding bill run.Otherwise, the value is `null`.
          type: string
        reversed:
          type: boolean
          description: |
            Whether the invoice is reversed.
        sourceType:
          description: |
            The type of the invoice source.
          enum:
            - Subscription
            - Standalone
            - Order
            - Consolidation
          type: string
        status:
          description: |
            The status of the invoice.
          enum:
            - Draft
            - Posted
          type: string
        targetDate:
          description: >
            This date is used to determine which charges are to be billed. All
            charges that are to be billed on this date or prior will be included
            in this bill run.
          format: date
          type: string
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        taxMessage:
          description: >
            The message that the tax engine return if it calculates the taxes of
            this invoice fails.
          type: string
          nullable: true
        taxStatus:
          description: >
            The status that the tax engine return after it calculates the taxes
            of this invoice.


            **Note:** The `Voided` status indicates that the tax transaction is
            successfully canceled on the tax vendor's side.  If a tax
            transaction was successfully committed to the third-party tax engine
            but the invoice failed to post, Zuora automatically detects the
            issue and voids the tax transaction on the vendor's side.
          enum:
            - Complete
            - Error
            - UnknownError
            - DuplicateDoc
            - InvalidRequest
            - InvalidResponse
            - TaxEngineError
            - ConcurrentModify
            - InternalServerError
            - TaxCodeTemplateError
            - Voided
          type: string
        templateId:
          description: >
            The ID of the invoice template.


            - If you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Flexible_Billing_Attributes"
            target="_blank">Flexible Billing Attributes</a> feature enabled, the
            value of this field depends on the configuration of the invoice
            template. 
              - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.
              - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.
            - If you have the Flexible Billing Attributes feature disabled, the
            value of this field is `null`.
          type: string
        transferredToAccounting:
          description: >
            Whether the invoice was transferred to an external accounting
            system.
          enum:
            - Processing
            - Error
            - Ignore
            - 'Yes'
            - 'No'
          type: string
        eInvoiceStatus:
          description: >
            It could be Processing, RetrieveTimeOut, Generated, Success,
            ConditionalSuccess, ApprovedByAuthority, Failed, or Rejected. If
            it’s Failed, it will have an error code and message. If it’s
            Generated or Success, both error code and message are empty, and
            eInvoiceFileId stores the file id of e-invoice.
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        eInvoiceFileId:
          type: string
          description: |
            The ID of the e-invoice file.
        eInvoiceErrorCode:
          type: string
          description: >
            The error code when status is `Failed`. This code can either be a
            Zuora-generated error code or one returned by a third-party
            e-invoice vendor.
        eInvoiceErrorMessage:
          type: string
          description: >
            The error message when status is "Failed". This message can either
            be a Zuora-generated error code or one returned by a third-party
            e-invoice vendor.
        paymentLink:
          type: string
          description: >
            A link to the Payment Link page where the customer can pay the
            invoice.


            The link is generated only if the invoice is posted after enabling
            the Payment Link feature on your tenant.


            **Note**: The Payment Link feature is in the Early Adopter phase. 

            You can enable the Payment Link feature through a self-service
            configuration in the **Manage Features** setting for Zuora Payments.
        paymentTerm:
          type: string
          description: |
            The payment term associated with the invoice. For
            example, `Net 30`. The payment term determines the due dates of
            invoices.
        account:
          type: object
          description: |
            The account associated with the invoice.
        billToContact:
          type: object
          description: |
            The bill-to contact who pays the invoice.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Invoice object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryInvoiceResponse
    NestedUsageOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the usage.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the usage.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the usage was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the usage.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the usage was last updated.
        accountId:
          type: string
          description: |
            The ID of the customer account associated with the usage.
        accountNumber:
          type: string
          description: |
            The number of the customer account associated with the usage.
        ratePlanChargeId:
          type: string
          description: |
            ID of the rate plan charge that pays for this usage.
        endDateTime:
          type: string
          description: |
            End date of the time period in which usage is tracked. Zuora uses
            this field value to determine the usage date.
          format: date-time
        productRatePlanChargeId:
          type: string
          description: >
            The product rate plan charge number that you use for a dynamic usage
            charge.
        quantity:
          type: number
          description: |
            Number of units used.
        rbeStatus:
          type: string
          description: >
            Indicates if the rating and billing engine (RBE) processed usage
            data for an invoice.
          enum:
            - Importing
            - Pending
            - Processed
        sourceType:
          type: string
          description: >
            Indicates if the usage records were imported from the web-based UI
            or the API.
          enum:
            - API
            - Import
        startDateTime:
          description: |
            Start date of the time period in which usage is tracked. Zuora uses
            this field value to determine the usage date.
          format: date-time
          type: string
        subscriptionId:
          type: string
          description: >
            The original ID of the subscription that contains the fees related
            to the usage data.
        submissionDateTime:
          type: string
          format: date-time
          description: |
            The date and time when the usage was submitted.
        uOM:
          type: string
          description: >
            The units to measure usage. Units of measure are configured in the
            web-based UI. Your values depend on your configuration in **Billing
            Settings**.
        description:
          type: string
          description: |
            A description of the usage record.
        importId:
          type: string
          description: |
            The unique identifier of the import.
        uniqueKey:
          description: >
            a customer-defined specific identifier of a usage record.


            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature or the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a> feature enabled. See [Upload
            usage record with unique

            key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key)

            for more information.
          type: string
        fileId:
          description: >
            File ID of the uploaded usage records file. You can use this file ID
            with [Get
            files](https://developer.zuora.com/api-references/api/operation/GET_Files)
            to download the file.
          type: string
        fileName:
          type: string
          description: >
            The name of the import file when the usage record is imported from
            the file.
        account:
          type: object
          description: |
            The account associated with the usage.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Usage object. Only the indexed custom fields with
          a specified value (not null) are returned. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryUsageResponse
    ExpandedAccount:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the account.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the account.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the account was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the account.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the account was last updated.
        accountNumber:
          type: string
          description: |
            The account number that identifies the account.
        additionalEmailAddresses:
          type: string
          description: |
            An additional email addresse to receive email notifications.
        allowInvoiceEdit:
          type: boolean
          description: |
            Indicates whether associated invoices can be edited.
          default: false
        autoPay:
          type: boolean
          description: >
            Indicates whether future payments are automatically collected when
            they are due

            during a payment run.
        balance:
          type: number
          format: double
          description: |
            The customer's total invoice balance minus credit balance.
        batch:
          type: string
          description: |
            The alias name given to a batch. A string of 50 characters or less.
        bcdSettingOption:
          description: >
            Bill cycle day setting option. Indicates whether the account’s bill
            cycle day is managed manually or automatically.
              - `ManualSet`: The bill cycle day is explicitly set to a specific day of the month (1–31).
              - `AutoSet`: The bill cycle day is automatically determined by Zuora. The bill cycle day is assigned when the first subscription is created for the account.

            This field is system-derived and read-only. Its value is
            automatically determined based on the `billCycleDay` field.
          type: string
          enum:
            - ManualSet
            - AutoSet
        billCycleDay:
          type: integer
          format: int64
          description: |
            Billing cycle day (BCD), the day of the month when a bill run
            generates invoices for the account.
        billToId:
          type: string
          description: >
            The unique identifier of the bill-to contact associated with the
            account.
        communicationProfileId:
          type: string
          description: >
            The unique identifier of the communication profile that Zuora uses
            when sending notifications to the account's contacts.
        creditBalance:
          type: number
          format: double
          description: |
            The current credit balance on the account.
        crmId:
          description: |
            External identifier of the account in a CRM system.
          maxLength: 100
          type: string
        currency:
          type: string
          description: |
            A currency defined in the web-based UI administrative settings.
        customerServiceRepName:
          description: >
            Name of the account's customer service representative, if
            applicable.
          maxLength: 50
          type: string
        defaultPaymentMethodId:
          type: string
          description: |
            ID of the default payment method for the account.
        eInvoiceProfileId:
          type: string
          description: >
            ID of the e-invoice profile for this account.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
        invoiceDeliveryPrefsEmail:
          description: >
            Indicates whether the customer wants to receive invoices through
            email. 
          type: boolean
        invoiceDeliveryPrefsPrint:
          description: >
            Whether the customer wants to receive printed invoices, such as
            through postal mail.
          type: boolean
        invoiceTemplateId:
          description: |
            Invoice template ID, configured in Billing Settings in the Zuora UI.
          type: string
        lastInvoiceDate:
          type: string
          format: date
          description: >
            Date of the most recent invoice for the account; null if no invoice
            has ever been generated.
        lastMetricsUpdate:
          description: >
            The date and time when account metrics are last updated, if the
            account is a partner account.


            **Note**: 

            - This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"
            target="_blank">Reseller Account</a> feature enabled.

            - If you ever set the `partnerAccount` field to `true` for an
            account, the value of `lastMetricsUpdate` field is the time when the
            account metrics are last updated.
          format: date-time
          type: string
        name:
          type: string
          description: |
            The name of the account.
        notes:
          type: string
          description: |
            A string of up to 65,535 characters.
        organizationId:
          type: string
          description: >
            The unique identifier of the organization to which the account
            belongs.
        parentId:
          description: >
            Identifier of the parent customer account for this Account object.
            The

            length is 32 characters. Use this field if you have <a

            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"

            target="_blank">Customer Hierarchy</a> enabled.
          type: string
        partnerAccount:
          type: boolean
          description: >
            Whether the customer account is a partner, distributor, or
            reseller. 


            **Note**: This field is available only if you have the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"

            target="_blank">Reseller Account</a> feature enabled.
        paymentMethodCascadingConsent:
          type: boolean
          description: >
            `true` indicates the consent from your customer to use the Cascading
            Payment Method feature was collected. 

            `false` indicates the consent was not collected and the Cascading
            Payment Method feature is not enabled.
        purchaseOrderNumber:
          type: string
          description: |
            The purchase order number provided by your customer for services,
            products, or both purchased.
        salesRepName:
          type: string
          description: |
            Name of the account's sales representative, if applicable.
        sequenceSetId:
          type: string
          nullable: true
          description: >
            The ID of the billing document sequence set to assign to the
            customer account. 

            The billing documents to generate for this account will adopt the
            prefix and starting document number configured in the sequence set.

            If a customer account has no assigned billing document sequence set,
            billing documents generated for this account adopt the prefix and
            starting document number from the default sequence set.
        shipToId:
          type: string
          description: >
            The unique identifier of the ship-to contact associated with the
            account.
        soldToId:
          type: string
          description: >
            The unique identifier of the sold-to contact associated with the
            account.
        status:
          description: |
            The account status.
          type: string
          enum:
            - Active
            - Draft
            - Canceled
        taxCompanyCode:
          type: string
          description: >
            Unique code that identifies a company account in Avalara. 

            **Note:** This feature is in Limited Availability. If you wish to
            have access to the feature, submit a request at [Zuora Global
            Support](https://support.zuora.com).
          maxLength: 50
        taxExemptCertificateID:
          type: string
          description: >
            ID of the customer tax exemption certificate. Applicable if you use
            Zuora Tax or Connect tax engines.
          maxLength: 32
        taxExemptCertificateType:
          type: string
          description: >
            Type of tax exemption certificate that the customer holds.
            Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 32
        taxExemptDescription:
          type: string
          description: >
            Description of the tax exemption certificate that the customer
            holds.

            Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 500
        taxExemptEffectiveDate:
          type: string
          format: date
          description: >
            Date when the customer tax exemption starts, in `YYYY-MM-DD` format.
            Applicable if you use Zuora Tax or Connect tax engines.
        taxExemptEntityUseCode:
          type: string
          description: >
            A unique entity use code to apply exemptions in Avalara AvaTax. See
            <a
            href="https://developer.avalara.com/avatax/handling-tax-exempt-customers/"
            target="_blank">Exempt Transactions</a> for more details.
          maxLength: 64
        taxExemptExpirationDate:
          type: string
          format: date
          description: >
            Date when the customer tax exemption expires, in `YYYY-MM-DD`
            format. Applicable if you use Zuora Tax or Connect tax engines.
        taxExemptIssuingJurisdiction:
          type: string
          description: >
            Jurisdiction in which the customer tax exemption certificate was
            issued.
          maxLength: 32
        taxExemptStatus:
          type: string
          default: 'No'
          description: >
            Status of the account tax exemption. Applicable if you use Zuora Tax
            or Connect tax engines. Required if you use Zuora Tax. 
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
        totalInvoiceBalance:
          type: number
          description: |
            Total balance of all posted invoices.
          format: double
        unappliedBalance:
          type: number
          description: |
            Total unapplied balance in this currency.
        vATId:
          type: string
          description: EU Value Added Tax ID.
        mrr:
          type: number
          description: |
            Monthly recurring revenue for the account.
        totalDebitMemoBalance:
          type: number
          description: |
            Total balance of all posted debit memos.
          format: double
        unappliedCreditMemoAmount:
          type: number
          description: >
            The total unapplied amount of all posted credit memos in this
            currency.
          format: double
        creditMemoTemplateId:
          type: string
          description: >
            ID of the credit memo template that is used to generate credit memos
            for the account.
        debitMemoTemplateId:
          type: string
          description: >
            ID of the debit memo template that is used to generate debit memos
            for the account.
        paymentGateway:
          type: string
          description: >
            The name of the payment gateway instance. If null or left
            unassigned,

            the account will use the default gateway.
        paymentTerm:
          type: string
          description: |
            A payment-terms indicator defined in the web-based UI administrative
            settings, for example, `Net 30`.
        billTo:
          $ref: '#/components/schemas/ExpandedContact'
        shipTo:
          $ref: '#/components/schemas/ExpandedContact'
        soldTo:
          $ref: '#/components/schemas/ExpandedContact'
        defaultPaymentMethod:
          $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/NestedPaymentOnExpand'
        refunds:
          type: array
          items:
            $ref: '#/components/schemas/NestedRefundOnExpand'
        creditMemos:
          type: array
          items:
            $ref: '#/components/schemas/NestedCreditMemoOnExpand'
        debitMemos:
          type: array
          items:
            $ref: '#/components/schemas/NestedDebitMemoOnExpand'
        invoices:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceOnExpand'
        usages:
          type: array
          items:
            $ref: '#/components/schemas/NestedUsageOnExpand'
        paymentMethods:
          type: array
          items:
            $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Account object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryAccountResponse
    CommonOQErrorResponse:
      properties:
        reasons:
          description: >
            The container of the error code and message. This field is available
            only if the `success` field is `false`.
          items:
            properties:
              code:
                description: |
                  The error code of response.
                type: integer
              message:
                description: |
                  The detail information of the error response
                type: string
            type: object
          type: array
        requestId:
          description: |
            The unique identifier of the request.
          format: uuid
          maxLength: 36
          minLength: 36
      type: object
    ExpandedAmendment:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the amendment.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the amendment.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the amendment gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the amendment.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the amendment gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        autoRenew:
          type: boolean
          description: |
            Indicates whether the amendment is automatically renewed.
        code:
          type: string
          description: |
            The amendment code.
        contractEffectiveDate:
          type: string
          format: date
          description: |
            The date when the amendment becomes effective for billing purposes,
            as `yyyy-mm-dd`.
        currentTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the current subscription term.
        currentTermPeriodType:
          type: string
          description: |
            The period type for the current subscription term.
          enum:
            - Month
            - Year
            - Day
            - Week
        customerAcceptanceDate:
          type: string
          format: date
          description: |
            The date when the customer accepts the amendment changes to
            the subscription, as `yyyy-mm-dd`.
        description:
          type: string
          description: |
            Description of the amendment.
        effectiveDate:
          type: string
          format: date
          description: |
            The date when the amendment changes take effective.
        effectivePolicy:
          type: string
          description: >
            Effective Policy for the subscription. 


            The value depends on the following conditions:

            * If the rate plan change (from old to new) is an upgrade, the
            effective policy is `EffectiveImmediately` by default.

            * If the rate plan change (from old to new) is a downgrade, the
            effective policy is `EffectiveEndOfBillingPeriod` by default.

            * Otherwise, the effective policy is `SpecificDate` by default.


            **Note:** This feature is in the **Early Adopter** phase. We are
            actively soliciting feedback from a small set of early adopters
            before releasing it as generally available. If you want to join this
            early adopter program, submit a request at [Zuora Global
            Support](http://support.zuora.com/).
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
        name:
          type: string
          description: |
            The name of the amendment.
        newRatePlanId:
          type: string
          description: |
            The ID of the rate plan charge on which amendment is made. Only
            the Add or Update amendment returns a new rate plan ID.
        removedRatePlanId:
          type: string
          description: >
            The ID of the rate plan charge that is removed from the
            subscription. Only

            the Remove Product amendment returns a removed rate plan ID.
        renewalSetting:
          type: string
          description: >
            Specifies whether a termed subscription will remain termed or change
            to evergreen when it is renewed.
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
        renewalTerm:
          description: |
            The term of renewal for the amended subscription.
          format: int64
          type: integer
        renewalTermPeriodType:
          description: |
            The period type for the subscription renewal term.
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
        resumeDate:
          description: >
            The date when the subscription resumption takes effect, as
            `yyyy-mm-dd`.


            **Note:** This feature is in **Limited Availability**. If you wish
            to have access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/).
          format: date
          type: string
        serviceActivationDate:
          type: string
          format: date
          description: |
            The date when service is activated, as `yyyy-mm-dd`.
        specificUpdateDate:
          type: string
          format: date
          description: |
            The date when the Update Product amendment takes effect.

            Only for the Update Product amendments if there is already 
            a future-dated Update Product amendment on the subscription.
        status:
          type: string
          description: |
            The status of the amendment.
          enum:
            - Draft
            - Pending Activation
            - Pending Acceptance
            - Completed
        subscriptionId:
          type: string
          description: |
            The ID of the subscription based on which the amendment is created.
        suspendDate:
          type: string
          description: >
            The date when the subscription suspension takes effect, as
            `yyyy-mm-dd`.


            **Note:** This feature is in **Limited Availability**. If you wish
            to have access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/).
          format: date
        termStartDate:
          type: string
          format: date
          description: |
            The date when the new terms and conditions take effect.
        termType:
          type: string
          description: |
            Indicates if the subscription is termed or evergreen.
          enum:
            - TERMED
            - EVERGREEN
        type:
          description: |
            Type of the amendment.
          type: string
          enum:
            - Cancellation
            - NewProduct
            - OwnerTransfer
            - RemoveProduct
            - Renewal
            - UpdateProduct
            - TermsAndConditions
            - ChangePlan
            - Composite
        subType:
          type: string
          description: >
            The sub type for the change plan order action.


            If this field was not set by user, the field is automatically
            generated by the system according to the following rules:


            When the old and new rate plans are within the same Grading catalog
            group:

            * If the grade of new plan is greater than that of the old plan,
            this is an "Upgrade".

            * If the grade of new plan is less than that of the old plan, this
            is a "Downgrade".

            * If the grade of new plan equals that of the old plan, this is a
            "Crossgrade".


            When the old and new rate plans are not in the same Grading catalog
            group, or either has no group, this is "PlanChanged".
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
        bookingDate:
          type: string
          format: date
      additionalProperties:
        type: object
        description: >
          Custom fields of the Amendment object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryAmendmentResponse
    ExpandedBillingRun:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the bill run.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the bill run.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the bill run was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the bill run.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the bill run was last updated.
        billingRunNumber:
          type: string
          description: |
            The number of the bill run.
        billingRunType:
          type: string
          description: |
            The type of the bill run. 

            - You can use this field only if the Catch-Up Bill Run feature is
            enabled. 

            - You must specify this field to create a catch up bill run.
          enum:
            - Regular
            - CatchUp
          default: Regular
        endDate:
          type: string
          format: date-time
          description: |
            The end date and time when the bill run completes.
        errorMessage:
          type: string
          description: |
            The error message generated by a failed billing run.
        executedDate:
          type: string
          format: date-time
          description: |
            The date and time when the bill run was executed.
        invoiceDate:
          type: string
          format: date
          description: >
            The date that appears on the invoice being created, in the
            `yyyy-mm-dd` format. 

            The value cannot fall in a closed accounting period.
        name:
          type: string
          description: |
            The name of the bill run.
        numberOfAccounts:
          type: integer
          format: int64
          description: |
            The number of accounts included in this bill run processing.
        numberOfInvoices:
          type: integer
          format: int64
          description: |
            The number of invoices generated from this bill run.
        numberOfCreditMemos:
          type: integer
          format: int64
          description: |
            The number of credit memos generated from this bill run.
        postedDate:
          type: string
          format: date-time
          description: |
            The date when the bill run was posted.
        startDate:
          type: string
          format: date-time
          description: |
            The start date and time of the bill run.
        status:
          description: |
            The status of the bill run.
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Canceled
            - Posted
            - PostInProgress
            - CancelInProgress
            - RemoveInProgress
            - Paused
          type: string
        targetDate:
          type: string
          format: date
          description: |
            The target date for this bill run, only valid for ad-hoc bill runs.
        targetType:
          type: string
          description: |
            The target type for this bill run.
          enum:
            - SingleAccount
            - AllAccount
        totalTime:
          type: integer
          format: int64
          description: |
            The total time in milliseconds for the bill run to complete.
        accountId:
          type: string
          description: |
            The unique identifier of the account included in the bill run.
        batches:
          description: >
            The batch of accounts for this bill run, this field can not exist
            with

            `billRunFilters` together.


            **Values:** `AllBatches` or an array of `Batch`*n* where *n* is a

            number between 1 and 50, for example, `Batch7`.
          items:
            type: string
          type: array
        billCycleDay:
          description: >
            The day of the bill cycle. This field is only valid when `batches`
            is

            specified.


            **Values:** 


            - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run


            - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a
            scheduled bill run
          type: string
          enum:
            - AllBillCycleDays
            - AsRunDay
        noEmailForZeroAmountInvoice:
          description: |
            Whether to suppress emails for invoices with zero total amount
            generated in this bill run after the bill run is complete. 
          type: boolean
        autoEmail:
          description: |
            Whether to automatically send emails after Auto-Post is complete.
          type: boolean
        autoPost:
          description: >
            Whether to automatically post the bill run after the bill run is
            created.
          type: boolean
        autoRenewal:
          description: >
            Whether to automatically renew auto-renew subscriptions that are up
            for renewal.
          type: boolean
        invoicesEmailed:
          type: boolean
          description: >
            Whether the invoices have been emailed after the bill run is
            complete.
        lastEmailSentTime:
          type: string
          format: date-time
          description: |
            The date and time when the last email was sent.
        targetDateOffSet:
          type: integer
          format: int32
          description: >
            The offset compared to bill run execution date, only valid for
            scheduled bill runs.
        invoiceDateOffSet:
          type: integer
          format: int32
          description: >
            The offset compared to bill run execution date, only valid for
            scheduled bill runs.
        chargeTypeToExclude:
          description: >
            The types of the charges to be excluded from the generation of
            billing

            documents.
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        scheduledExecutionTime:
          description: |
            The scheduled execution time for a bill run.
          format: date-time
          type: string
        repeatType:
          description: |
            The repeat type of the bill run.
          enum:
            - None
            - Daily
            - Weekly
            - Monthly
          type: string
        repeatFrom:
          description: |
            The start date of the scheduled bill run.
          format: date
          type: string
        repeatTo:
          description: |
            The end date of of the scheduled bill run.
          format: date
          type: string
        runTime:
          type: integer
          format: int32
          description: |
            The scheduled run time (hour) of day.
          maximum: 23
          minimum: 0
        timeZone:
          type: string
          description: |
            Timezone of the scheduled bill run.
        monthlyOnDay:
          type: string
          description: |
            The repeat day in a month.
        weeklyOnDay:
          description: |
            The repeat day in a week.
          enum:
            - Mon
            - Tue
            - Wed
            - Thu
            - Fri
            - Sat
            - Sun
          type: string
        includeSubscriptions:
          default: true
          description: |
            Indicates whether to bill subscriptions in the bill run.
          type: boolean
        includeOrderLineItems:
          default: true
          description: |
            Indicates whether to bill order line items in the bill run.
          type: boolean
      additionalProperties:
        type: object
        description: >
          Custom fields of the Bill Run object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryBillingRunResponse
    NestedAccountOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the account.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the account.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the account was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the account.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the account was last updated.
        accountNumber:
          type: string
          description: |
            The account number that identifies the account.
        additionalEmailAddresses:
          type: string
          description: |
            An additional email address to receive email notifications.
        allowInvoiceEdit:
          type: boolean
          description: |
            Indicates whether associated invoices can be edited.
          default: false
        autoPay:
          type: boolean
          description: >
            Indicates whether future payments are automatically collected when
            they are due

            during a payment run.
        balance:
          type: number
          format: double
          description: |
            The customer's total invoice balance minus credit balance.
        batch:
          type: string
          description: |
            The alias name given to a batch. A string of 50 characters or less.
        bcdSettingOption:
          type: string
          description: |
            The billing cycle day setting option for the account.
          enum:
            - ManualSet
            - AutoSet
        billCycleDay:
          type: integer
          format: int64
          description: |
            Billing cycle day (BCD), the day of the month when a bill run
            generates invoices for the account.
        billToId:
          type: string
          description: >
            The unique identifier of the bill-to contact associated with the
            account.
        communicationProfileId:
          type: string
          description: >
            The unique identifier of the communication profile that Zuora uses
            when sending notifications to the account's contacts.
        creditBalance:
          type: number
          format: double
          description: |
            The current credit balance on the account.
        crmId:
          description: |
            External identifier of the account in a CRM system.
          maxLength: 100
          type: string
        currency:
          type: string
          description: |
            A currency defined in the web-based UI administrative settings.
        customerServiceRepName:
          description: >
            Name of the account's customer service representative, if
            applicable.
          maxLength: 50
          type: string
        defaultPaymentMethodId:
          type: string
          description: |
            ID of the default payment method for the account.
        eInvoiceProfileId:
          type: string
          description: >
            ID of the e-invoice profile for this account.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
        invoiceDeliveryPrefsEmail:
          description: >
            Indicates whether the customer wants to receive invoices through
            email. 
          type: boolean
        invoiceDeliveryPrefsPrint:
          description: >
            Whether the customer wants to receive printed invoices, such as
            through postal mail.
          type: boolean
        invoiceTemplateId:
          description: |
            Invoice template ID, configured in Billing Settings in the Zuora UI.
          type: string
        lastInvoiceDate:
          type: string
          format: date
          description: >
            Date of the most recent invoice for the account; null if no invoice
            has ever been generated.
        lastMetricsUpdate:
          description: >
            The date and time when account metrics are last updated, if the
            account is a partner account.


            **Note**: 

            - This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"
            target="_blank">Reseller Account</a> feature enabled.

            - If you ever set the `partnerAccount` field to `true` for an
            account, the value of `lastMetricsUpdate` field is the time when the
            account metrics are last updated.
          format: date-time
          type: string
        name:
          type: string
          description: |
            The name of the account.
        notes:
          type: string
          description: |
            A string of up to 65,535 characters.
        organizationId:
          type: string
          description: >
            The unique identifier of the organization to which the account
            belongs.
        parentId:
          description: >
            Identifier of the parent customer account for this Account object.
            The

            length is 32 characters. Use this field if you have <a

            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"

            target="_blank">Customer Hierarchy</a> enabled.
          type: string
        partnerAccount:
          type: boolean
          description: >
            Whether the customer account is a partner, distributor, or
            reseller. 


            **Note**: This field is available only if you have the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_customer_accounts/AAA_Overview_of_customer_accounts/Reseller_Account"

            target="_blank">Reseller Account</a> feature enabled.
        paymentMethodCascadingConsent:
          type: boolean
          description: >
            `true` indicates the consent from your customer to use the Cascading
            Payment Method feature was collected. 

            `false` indicates the consent was not collected and the Cascading
            Payment Method feature is not enabled.
        purchaseOrderNumber:
          type: string
          description: |
            The purchase order number provided by your customer for services,
            products, or both purchased.
        salesRepName:
          type: string
          description: |
            Name of the account's sales representative, if applicable.
        sequenceSetId:
          type: string
          nullable: true
          description: >
            The ID of the billing document sequence set to assign to the
            customer account. 

            The billing documents to generate for this account will adopt the
            prefix and starting document number configured in the sequence set.

            If a customer account has no assigned billing document sequence set,
            billing documents generated for this account adopt the prefix and
            starting document number from the default sequence set.
        shipToId:
          type: string
          description: >
            The unique identifier of the ship-to contact associated with the
            account.
        soldToId:
          type: string
          description: >
            The unique identifier of the sold-to contact associated with the
            account.
        status:
          description: |
            The account status.
          type: string
          enum:
            - Active
            - Draft
            - Canceled
        taxCompanyCode:
          type: string
          description: >
            Unique code that identifies a company account in Avalara. 

            **Note:** This feature is in Limited Availability. If you wish to
            have access to the feature, submit a request at [Zuora Global
            Support](https://support.zuora.com).
          maxLength: 50
        taxExemptCertificateID:
          type: string
          description: >
            ID of the customer tax exemption certificate. Applicable if you use
            Zuora Tax or Connect tax engines.
          maxLength: 32
        taxExemptCertificateType:
          type: string
          description: >
            Type of tax exemption certificate that the customer holds.
            Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 32
        taxExemptDescription:
          type: string
          description: >
            Description of the tax exemption certificate that the customer
            holds.

            Applicable if you use Zuora Tax or Connect tax engines.
          maxLength: 500
        taxExemptEffectiveDate:
          type: string
          format: date
          description: >
            Date when the customer tax exemption starts, in `YYYY-MM-DD` format.
            Applicable if you use Zuora Tax or Connect tax engines.
        taxExemptEntityUseCode:
          type: string
          description: >
            A unique entity use code to apply exemptions in Avalara AvaTax. See
            <a
            href="https://developer.avalara.com/avatax/handling-tax-exempt-customers/"
            target="_blank">Exempt Transactions</a> for more details.
          maxLength: 64
        taxExemptExpirationDate:
          type: string
          format: date
          description: >
            Date when the customer tax exemption expires, in `YYYY-MM-DD`
            format. Applicable if you use Zuora Tax or Connect tax engines.
        taxExemptIssuingJurisdiction:
          type: string
          description: >
            Jurisdiction in which the customer tax exemption certificate was
            issued.
          maxLength: 32
        taxExemptStatus:
          type: string
          default: 'No'
          description: >
            Status of the account tax exemption. Applicable if you use Zuora Tax
            or Connect tax engines. Required if you use Zuora Tax. 
          enum:
            - 'No'
            - 'Yes'
            - PendingVerification
        totalInvoiceBalance:
          type: number
          description: |
            Total balance of all posted invoices.
          format: double
        unappliedBalance:
          type: number
          description: |
            Total unapplied balance in this currency.
        vATId:
          type: string
          description: EU Value Added Tax ID.
        mrr:
          type: number
          description: |
            Monthly recurring revenue for the account.
        totalDebitMemoBalance:
          type: number
          description: |
            Total balance of all posted debit memos.
          format: double
        unappliedCreditMemoAmount:
          type: number
          description: >
            The total unapplied amount of all posted credit memos in this
            currency.
          format: double
        creditMemoTemplateId:
          type: string
          description: >
            ID of the credit memo template that is used to generate credit memos
            for the account.
        debitMemoTemplateId:
          type: string
          description: >
            ID of the debit memo template that is used to generate debit memos
            for the account.
        paymentGateway:
          type: string
          description: >
            The name of the payment gateway instance. If null or left
            unassigned,

            the account will use the default gateway.
        paymentTerm:
          type: string
          description: |
            A payment-terms indicator defined in the web-based UI administrative
            settings, for example, `Net 30`.
        billTo:
          type: object
          description: |
            The bill-to contact on this account.
        shipTo:
          type: object
          description: |
            The ship-to contact on the account.
        soldTo:
          type: object
          description: |
            The sold-to contact on the account.
        defaultPaymentMethod:
          type: object
          description: |
            The default payment method associated with the account.
        subscriptions:
          type: array
          items:
            type: object
          description: |
            The subscriptions associated with the account.
        payments:
          type: array
          items:
            type: object
          description: |
            The payments associated with the account.  
        refunds:
          type: array
          items:
            type: object
          description: |
            The refunds associated with the account.  
        creditMemos:
          type: array
          items:
            type: object
          description: |
            The credit memos associated with the account.  
        debitMemos:
          type: array
          items:
            type: object
          description: |
            The debit memos associated with the account.  
        invoices:
          type: array
          items:
            type: object
          description: |
            The invoices associated with the account.  
        usages:
          type: array
          items:
            type: object
          description: |
            The usage records associated with the account.        
        paymentMethods:
          type: array
          items:
            type: object
          description: |
            The payment methods associated with the account.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Account object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryAccountResponse
    NestedCreditMemoItemOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the credit memo item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the credit memo item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo item was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the credit memo
            item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo item was last updated.
        amount:
          type: number
          description: >
            The amount of the credit memo item. For tax-inclusive credit memo

            items, the amount indicates the credit memo item amount including
            tax.

            For tax-exclusive credit memo items, the amount indicates the credit

            memo item amount excluding tax.
        amountWithoutTax:
          description: |
            The credit memo item amount excluding tax.
          format: double
          type: number
        appliedToItemId:
          description: >
            The unique ID of the credit memo item that the discount charge is
            applied to.
          type: string
        appliedToOthersAmount:
          type: number
          description: |
            The amount of the credit memo that is applied to other credit memo
            items.
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          description: >
            The date when the credit memo item is charged, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
        description:
          description: >
            The description of the credit memo item.


            **Note**: This field is only available if you set the
            `Zuora-Version` request header to `257.0` or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude the credit memo item from revenue accounting.


            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: boolean
        fulfillmentId:
          description: >
            The reference ID of the fulfillment associated with the credit memo
            item.
          type: string
        invoiceScheduleId:
          description: >
            The ID of the invoice schedule associated with the credit memo
            item. 


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
          type: string
        invoiceScheduleItemId:
          description: >
            The ID of the invoice schedule item associated with the credit memo
            item. The credit memo item is generated during the processing of the
            invoice schedule item.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
          type: string
        itemShipToContactId:
          description: >
            The ID of the ship-to contact associated with the credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemSoldToContactId:
          description: >
            The ID of the sold-to contact associated with the credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemSoldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the credit
            memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemType:
          type: string
          description: |
            The type of the credit memo item.
        orderLineItemId:
          type: string
          description: >
            The ID of the order line item associated with the credit memo item,
            if applicable.
        processingType:
          description: |
            The type of the charge for the credit memo item. 
            - `0`: Charge - `1`: Discount
          type: string
          enum:
            - '0'
            - '1'
        quantity:
          description: |
            The number of units for the credit memo item.
          format: double
          type: number
        purchaseOrderNumber:
          type: string
          description: |
            The purchase order number associated the credit memo item.
        creditFromItemSource:
          description: |
            The type of the credit from item.
          enum:
            - InvoiceItem
            - CreditMemoItem
          type: string
        creditFromItemId:
          type: string
          description: |
            The ID of the credit from item.
        reflectDiscountInNetAmount:
          type: boolean
          default: false
          description: >
            When you apply percentage discounts to either of the following
            charges, you need to set the `reflectDiscountInNetAmount` field on
            your discount charge to `true`, to enable calculating and displaying
            the net amount of the following charges in Zuora Revenue.

            * delivery pricing charge

            * prepayment charge

            * drawdown charge


            Note the following:

            * If you are an <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> customer, when you set the
            `reflectDiscountInNetAmount` field to `true`, you must also set the
            `excludeItemBillingFromRevenueAccounting` field to `true`. 

            * If you are a <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> customer, you must
            set the `reflectDiscountInNetAmount` field to `false`, otherwise an
            error will be returned. Billing - Revenue Integration does not
            support discounts on the preceding charges.

            * If you are a Zuora Billing customer who does not enable the Order
            to Revenue or Billing - Revenue Integration feature, when you apply
            percentage discounts to the preceding charges, you also need to set
            the `reflectDiscountInNetAmount` field to `true`.  
        serviceEndDate:
          description: |
            The service end date of the credit memo item. 
          format: date
          type: string
        serviceStartDate:
          description: |
            The service start date of the credit memo item.
          format: date
          type: string
        sku:
          description: |
            The SKU for the product associated with the credit memo item.
          type: string
        sourceItemType:
          description: >
            The type of the source item.


            - If a credit memo is not created from an invoice or a product rate
            plan charge or a return order line item, the value of this field is
            `SubscriptionComponent`. 

            - If a credit memo is created from an invoice, the value of this
            field is `InvoiceDetail`.

            - If a credit memo is created from a product rate plan charge, the
            value of this field is `ProductRatePlanCharge`.

            - If a credit memo is created from a return order line item, the
            value of this field is `OrderLineItem`.
                          
          enum:
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
            - OrderLineItem
          type: string
        subscriptionId:
          description: |
            The ID of the subscription associated with the credit memo item.
          type: string
        taxMode:
          description: >
            The tax mode of the credit memo item, indicating whether the amount
            of the credit memo item includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        chargeName:
          type: string
          description: |
            The name of the charge associated with the credit memo item. 
        chargeNumber:
          type: string
          description: >
            The number of the product rate plan charge that the credit memo is
            created from.
        commitmentChargeSegmentNumber:
          type: string
        commitmentChargeNumber:
          type: string
        taxAmount:
          description: |
            The amount of the tax applied to the credit memo item.
          format: double
          type: number
        taxCodeName:
          type: string
          description: >
            The tax code identifies which tax rules and tax rates to apply to a
            specific credit memo item.
        taxExemptAmount:
          type: number
          description: |
            The calculated tax amount excluded due to the exemption.
        unappliedAmount:
          description: |
            The unapplied amount of the credit memo item.
          format: double
          type: number
        unitOfMeasure:
          description: |
            The units to measure usage.
          type: string
        unitPrice:
          description: |
            The per-unit price of the credit memo item.
          format: double
          type: number
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription associated with the credit memo item.
        invoiceItemId:
          type: string
          description: |
            The ID of the invoice item associated with the credit memo item.
        productRatePlanChargeId:
          type: string
          description: >
            The ID of the product rate plan charge that the credit memo is
            created

            from.
        ratePlanChargeId:
          type: string
          description: |
            The ID of the rate plan charge associated with the credit memo item.
        revenueRecognitionRuleName:
          type: string
          description: >
            The name of the revenue recognition rule governing the revenue
            schedule.
        revenueImpacting:
          description: >
            Indicates whether this write off operation impacts the revenue. If
            `revenueImpacting` = `Yes`, the deferred revenue accounting code
            will be automatically selected from the associated invoice.


            If `revenueImpacting` = `No`, users can select an accounting code
            such as bad-debt expense accounting code for the write off
            operation.
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        creditMemoId:
          type: string
          description: |
            The ID of the credit memo to which this credit memo item belongs.
        numberOfDeliveries:
          description: >
            The number of deliveries dedicated to the Delivery Pricing charges.
            The value might be different, as follows:

            - For the credit memo generated by a bill run, this field has a
            value. 

            - For the credit memo generated from an invoice, this field is
            blank.

            **Note**: This field is available only if you have the Delivery
            Pricing feature enabled.
          type: number
        recognizedRevenueAccountingCodeId:
          type: string
          description: |
            The Recognized Revenue accounting code for the credit memo item.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The Account Receivable accounting code for the credit memo item.
        onAccountAccountingCodeId:
          type: string
          description: |
            The On Account accounting code for the credit memo item.
        deferredRevenueAccountingCodeId:
          type: string
          description: |
            The Deferred Revenue accounting code for the credit memo item.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        shipToContactSnapshotId:
          description: >
            The ID of the ship-to contact snapshot associated with the credit
            memo.
          type: string
        soldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the credit
            memo.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the credit
            memo.
          type: string
        subscription:
          type: object
          description: |
            The subscription associated with the credit memo item.
        ratePlanCharge:
          type: object
          description: |
            The rate plan charge associated with the credit memo item.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Credit Memo Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryCreditMemoItemResponse
    NestedCreditMemoApplicationOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the credit memo application.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the credit memo
            application.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo application was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the credit memo
            application.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo application was last updated.
        amount:
          type: number
          format: double
          description: |
            The application amount of the credit memo.
        effectiveDate:
          type: string
          format: date
          description: |
            The date when the credit memo application becomes effective.
        creditMemoId:
          type: string
          description: >
            The ID of the credit memo associated with the credit memo
            application.
        accountId:
          type: string
          description: |
            The ID of the customer account associated with the credit memo.
        applicationGroupId:
          type: string
          description: >
            The ID of the application group to which this credit memo
            application belongs.
        debitMemoId:
          type: string
          description: |
            The ID of the debit memo to which the credit memo is applied.
        invoiceId:
          type: string
          description: |
            The ID of the invoice to which the credit memo is applied.
        creditMemo:
          type: object
          description: |
            The credit memo associated with the credit memo application.
      type: object
      title: QueryCreditMemoApplicationResponse
      additionalProperties: false
    NestedContactSnapshotOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the contact snapshot.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the snapshot.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the contact snapshot was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the snapshot.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the contact snapshot was last updated.
        accountId:
          type: string
          description: |
            The unique identifier of the associated billing account.
        contactId:
          type: string
          description: |
            The unique identifier of the original contact.
        firstName:
          type: string
          description: |
            The first name of the contact.
        lastName:
          type: string
          description: |
            The last name of the contact.
        nickName:
          type: string
          description: |
            The nickname of the contact.
        address1:
          type: string
          description: |
            The first line of the address.
        address2:
          type: string
          description: |
            The second line of the address.
        city:
          type: string
          description: |
            The city of the contact's address.
        state:
          type: string
          description: |
            The state or province of the contact's address.
        postalCode:
          type: string
          description: |
            The postal or ZIP code.
        county:
          type: string
          description: |
            The county or region of the contact.
        country:
          type: string
          description: |
            The county or region of the contact.
        taxRegion:
          type: string
          description: |
            The tax region applicable to the contact.
        description:
          type: string
          description: |
            The free-form description of the contact snapshot.
        homePhone:
          type: string
          description: |
            The home phone number.
        otherPhone:
          type: string
          description: |
            Any other phone number.
        otherPhoneType:
          type: string
          description: |
            The type of the other phone number.
        fax:
          type: string
          description: |
            The fax number.
        personalEmail:
          type: string
          description: |
            The personal email address.
        workEmail:
          type: string
          description: |
            The personal email address.
        deleted:
          type: boolean
          description: |
            Indicates whether the contact snapshot is marked as deleted.
      additionalProperties:
        type: object
        description: >
          Custom fields of the ContactSnapshot object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryContactSnapshotResponse
    ExpandedCreditMemo:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the credit memo.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the credit memo.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the credit memo.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo was last updated.
        appliedAmount:
          description: |
            The applied amount of the credit memo.
          format: double
          type: number
        balance:
          type: number
          description: |
            The remaining balance of credit memo.
        billToContactId:
          description: >
            The ID of the bill-to contact associated with the credit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the credit
            memo.


            The value of this field is `null` if the bill rule [Preserve
            snapshot of bill-to and sold-to contacts when billing documents are
            posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted)
            is disabled.
          type: string
        cancelledById:
          description: |
            The ID of the Zuora user who cancelled the credit memo.
          type: string
          nullable: true
        cancelledOn:
          description: >
            The date and time when the credit memo was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
          nullable: true
        comment:
          description: |
            Comments about the credit memo.
          type: string
          nullable: true
        currency:
          description: >
            The currency of the credit memo.


            **Note:** By default, the currency on a billing document matches the
            default currency set on the associated account. 

            However, Zuora now offers a Multiple Currencies feature to support
            different currencies for billing documents, allowing flexibility
            beyond the account-level currency. 

            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currency</a>.
          type: string
          nullable: true
          example: USD
        discountAmount:
          type: number
          description: |
            The amount of the discount on the credit memo.
        einvoiceErrorCode:
          description: >
            The error code returned when the e-invoice file status is `Failed`.
            This code can either be a Zuora-generated error code or one returned
            by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceErrorMessage:
          description: >
            The error message returned when the e-invoice file status is
            `Failed`. This message can either be a Zuora-generated error message
            or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceFileId:
          description: >
            The ID of the e-invoice file generated for the credit memo.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceStatus:
          description: >
            The status of the e-invoice file generation for the credit memo. 


            - If e-invoice file generation succeeds, this field is either
            `Generated` or `Success`, and both the error code and message are
            empty, and the `eInvoiceFileId` field stores the ID of the generated
            e-invoice file.

            - If the responses from tax vendors such as Sovos or Avalara are 
              taking too long, this field becomes `RetrieveTimeOut`. Once the 
              vendor responds successfully, you can use the 'Resync E-Invoice Status' 
              action to update the status automatically.  You can view these updates 
              in System Health telemetry.

            - If a failure occurs during e-invoice file generation, this field
            is `Failed` and an error code and an error message are returned
            respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage`
            fields. 

            - If e-invoice file generation conditionally succeeds, this field is
            `ConditionalSuccess` and an error code and an error message are 
            returned respectively in the `einvoiceErrorCode` and
            `einvoiceErrorMessage` fields.

            - If the e-invoice file has been approved by the tax authority, this
            field is `ApprovedByAuthority`. The next status will be either
            `Success` or `Rejected`.

            - If the e-invoice file has been rejected by the government, this
            field is `Rejected`. You cannot resend this e-invoice; you must
            create a new invoice instead.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        excludeFromAutoApplyRules:
          description: >
            Whether the credit memo is excluded from the rule of automatically
            applying credit memos to invoices.
          type: boolean
        exchangeRateDate:
          type: string
          format: date
          description: >
            The date of the exchange rate used. The date is in `yyyy-mm-dd`
            format.

            Corresponds to the value specified in the Provider Exchange Rate
            Date column in the Import Foreign Exchange Rates template when you
            uploaded the rates through the Mass Updater.
        autoApplyUponPosting:
          description: |
            Whether the credit memo automatically applies to the invoice upon
            posting.
          type: boolean
        memoDate:
          type: string
          format: date
          description: |
            The date when the credit memo takes effect, in `yyyy-mm-dd` format.
            For example, `2024-01-01`.
        memoNumber:
          description: |
            The unique identification number of the credit memo.
          type: string
        postedById:
          description: |
            The ID of the Zuora user who posted the credit memo.
          type: string
        postedOn:
          description: |
            The date and time when the credit memo was posted, in
            `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        reasonCode:
          description: |
            A code identifying the reason for the transaction. The value
            must be an existing reason code or empty.
          type: string
        refundAmount:
          description: |
            The amount of the refund on the credit memo.
          format: double
          type: number
        reversed:
          description: |
            Whether the credit memo is reversed.
          type: boolean
        revenueImpacting:
          description: >
            Indicates whether this write off operation impacts the revenue. If
            `revenueImpacting` = `Yes`, the deferred revenue accounting code
            will be automatically selected from the associated invoice


            If `revenueImpacting` = `No`, users can select an accounting code
            such as bad-debt expense accounting code for the write off
            operation.
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        sequenceSetId:
          description: >
            The ID of the sequence set associated with the credit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
          nullable: true
        source:
          description: >
            The source of the credit memo.


            Possible values:

            - `BillRun`: The credit memo is generated by a bill run.

            - `API`: The credit memo is created by calling the [Invoice and
            collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment)
            operation, or by calling the Orders, Order Line Items, or
            Fulfillments API operations.

            - `ApiSubscribe`: The credit memo is created by calling the [Create
            subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription)
            and [Create
            account](https://developer.zuora.com/api-references/api/operation/POST_Account)
            operation.

            - `ApiAmend`: The credit memo is created by calling the [Update
            subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription)
            operation.

            - `AdhocFromPrpc`: The credit memo is created from a product rate
            plan charge through the Zuora UI or by calling the [Create a credit
            memo from a
            charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc)
            operation.

            - `AdhocFromInvoice`: The credit memo is created from an invoice or
            created by reversing an invoice. You can create a credit memo from
            an invoice through the Zuora UI or by calling the [Create credit
            memo from
            invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice)
            operation. You can create a credit memo by reversing an invoice
            through the Zuora UI or by calling the [Reverse
            invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice)
            operation.
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        sourceId:
          description: |
            The ID of the credit memo source.

            If a credit memo is generated from a bill run, the value is the
            number of the corresponding bill run. Otherwise, the value is
            `null`.
          type: string
        sourceType:
          description: |
            The type of the credit memo source.
          enum:
            - Subscription
            - Standalone
            - Invoice
            - Order
            - CreditMemo
            - Consolidation
          type: string
        status:
          description: |
            The status of the credit memo.
          enum:
            - Draft
            - Posted
            - Canceled
            - Error
            - PendingForTax
            - Generating
            - CancelInProgress
          type: string
        targetDate:
          description: >
            The target date for the credit memo, in `yyyy-mm-dd` format. For
            example, `2024-01-01`.
          format: date
          type: string
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxMessage:
          description: >
            The message about the status of tax calculation related to the
            credit memo. If tax calculation fails in one credit memo, this field
            displays the reason for the failure.
          type: string
          nullable: true
        taxStatus:
          description: >
            The status of tax calculation related to the credit memo.


            **Note**: This field is only applicable to tax calculation by
            third-party tax engines. Also, the `Voided` status indicates that
            the tax transaction is successfully canceled on the tax vendor's
            side.  If a tax transaction was successfully committed to the
            third-party tax engine but the invoice failed to post, Zuora
            automatically detects the issue and voids the tax transaction on the
            vendor's side.
          enum:
            - Complete
            - Error
            - UnknownError
            - DuplicateDoc
            - InvalidRequest
            - InvalidResponse
            - TaxEngineError
            - ConcurrentModify
            - InternalServerError
            - TaxCodeTemplateError
            - Voided
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the
            credit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the
            credit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        taxAutoCalculation:
          default: true
          description: |
            Whether to automatically calculate taxes in the credit memo.
          type: boolean
        totalAmount:
          type: number
          format: double
          description: |
            The total amount of the credit memo, including taxes.
        totalAmountWithoutTax:
          type: number
          format: double
          description: |
            The total amount of the credit memo, excluding taxes.
        totalTaxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        transferredToAccounting:
          description: |
            Whether the credit memo was transferred to an external
            accounting system. This field is used for integration with
            accounting systems such as NetSuite.
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          description: |
            The ID of a referred invoice.
          type: string
        accountId:
          description: |
            The ID of the customer account associated with the credit memo.
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        creditMemoItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedCreditMemoItemOnExpand'
        creditMemoApplications:
          type: array
          items:
            $ref: '#/components/schemas/NestedCreditMemoApplicationOnExpand'
        billToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        soldToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        shipToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Credit Memo object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryCreditMemoResponse
    ExpandedCreditMemoApplication:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the credit memo application.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the credit memo
            application.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo application was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the credit memo
            application.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo application was last updated.
        amount:
          type: number
          format: double
          description: |
            The application amount of the credit memo.
        effectiveDate:
          type: string
          format: date
          description: |
            The date when the credit memo application becomes effective.
        creditMemoId:
          type: string
          description: >
            The ID of the credit memo associated with the credit memo
            application.
        accountId:
          type: string
          description: |
            The ID of the customer account associated with the credit memo.
        applicationGroupId:
          type: string
          description: >
            The ID of the application group to which this credit memo
            application belongs.
        debitMemoId:
          type: string
          description: |
            The ID of the debit memo to which the credit memo is applied.
        invoiceId:
          type: string
          description: |
            The ID of the invoice to which the credit memo is applied.
        creditMemo:
          $ref: '#/components/schemas/NestedCreditMemoOnExpand'
      type: object
      title: QueryCreditMemoApplicationResponse
      additionalProperties: false
    NestedRatePlanChargeOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the rate plan charge.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the rate plan charge.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan charge was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the rate plan
            charge.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan charge was last updated.
        ratePlanId:
          type: string
          description: >
            The unique identifier of the rate plan to which this rate plan
            charge belongs.
        productRatePlanChargeId:
          type: string
          description: >
            The unique identifier of the product rate plan charge associated
            with this product rate plan charge.
        accountingCode:
          description: >
            The accounting code for the charge. Accounting codes group
            transactions that contain similar accounting attributes.


            **Values**: inherited from `ProductRatePlanCharge.AccountingCode`


            **Note**: This value changes if
            `ProductRatePlanCharge.AccountingCode` is updated. The values of
            `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not
            change when `ProductRatePlanCharge.AccountingCode` is updated. 
          type: string
        applyDiscountTo:
          description: |
            Specifies the type of charges a specific discount applies to. 
            **Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` 
          type: string
        billCycleDay:
          type: integer
          format: int64
          description: >
            Indicates the charge's billing cycle day (BCD), which is when bill
            runs generate invoices for charges associated with the product rate
            plan charge or the account. 


            **Values**: inherited from `ProductRatePlanCharge.BillCycleDay` 
        billCycleType:
          type: string
          description: >
            Specifies how to determine the billing day for the charge.\n\


            **Values**: inherited from `ProductRatePlanCharge.BillCycleType`


            **Note:** You can override the value inherited from the Product Rate
            Plan Charge, but only when creating a new subscription or a New
            Product amendment. 
        billingPeriod:
          type: string
          description: >
            Allows billing period to be overridden on rate plan charge.


            **Values**: **inherited from `ProductRatePlanCharge.BillingPeriod`


            **Note:** You can override the value inherited from the Product Rate
            Plan Charge, but only when creating a new subscription or a New
            Product amendment. 
        billingPeriodAlignment:
          type: string
          description: >
            Aligns charges within the same subscription if multiple charges
            begin on different dates.


            **Values**: inherited from
            `ProductRatePlanCharge.BillingPeriodAlignment` 
        billingTiming:
          type: string
          description: >
            The billing timing for the charge. You can choose to bill in advance
            or in arrears for recurring charge types. This field is not used in
            one-time or usage based charge types.


            **Note:** You can override the value inherited from the Product Rate
            Plan Charge when a subscription has a recurring charge type.
          enum:
            - In Advance
            - In Arrears
        chargedThroughDate:
          type: string
          format: date
          description: |
            The date through which a customer has been billed for the charge.
          maxLength: 29
        chargeModel:
          type: string
          description: >
            Determines how to evaluate charges. Charge models must be
            individually activated in the web-based UI.


            **Values**: inherited from `ProductRatePlanCharge.ChargeModel` 
        chargeNumber:
          description: >
            A unique number that identifies the charge. This number is returned
            as a string.


            **Values**: one of the following:

            - automatically generated if left `null`

            - a unique number of 50 characters or fewer
          type: string
        chargeType:
          type: string
          description: |
            Specifies the type of charge.

            **Values**: inherited from `ProductRatePlanCharge.ChargeType`
        description:
          type: string
          description: |
            A description of the rate plan charge. 
        discountLevel:
          type: string
          description: >
            Application scope of the discount charge. For example, if the value
            of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
        dMRC:
          type: number
          description: |
            A delta monthly recurring charge is the change in monthly
            recurring revenue caused by an amendment or a new subscription. 

            **Values**: automatically generated
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
        dTCV:
          type: number
          description: >
            After an Amendment, the change in the total contract value (TCV)
            amount for this charge, compared with its previous value.


            **Values**: automatically generated 
        effectiveEndDate:
          type: string
          format: date
          description: >
            Start date when the rate plan charge becomes active, as
            `yyyy-mm-dd`.
        effectiveStartDate:
          type: string
          format: date
          description: |
            Final date the rate plan is active, as `yyyy-mm-dd`.
        endDateCondition:
          description: >
            Condition for the charge to become inactive.


            - If the value of this field is `FixedPeriod`, the charge is active
            for a predefined duration based on the value of the
            `upToPeriodsType` and `upToPeriods` fields.

            - If the value of this field is `SpecificEndDate`, use the
            `specificEndDate` field to specify the date when the charge becomes
            inactive.
          enum:
            - SubscriptionEnd
            - FixedPeriod
            - SpecificEndDate
            - OneTime
          type: string
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charge related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBillingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge. In addition, if the
            `excludeItemBookingFromRevenueAccounting` field in an Create
            Subscription or Add Product order action is set to `false`, you must
            also set the `excludeItemBillingFromRevenueAccounting` field in this
            order action to `false`.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charges from revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBookingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        invoiceScheduleId:
          type: string
          description: >
            The unique identifier of the invoice schedule associated with the
            subscription.
        isLastSegment:
          type: boolean
          description: >
            Indicates if the segment of the rate plan charge is the most recent
            segment. **Values**: automatically generated.
        isPrepaid:
          type: boolean
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Indicates whether this charge is a prepayment (topup) charge or a

            drawdown charge. 
        isRollover:
          type: boolean
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a> feature enabled.


            It determines whether the rollover fields are needed.
        rolloverPeriods:
          type: integer
          format: int64
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
        rolloverPeriodLength:
          type: integer
          format: int32
          nullable: true
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. In this
            case, you must set the `rolloverPeriods` field to 1. For example,
            you can define the rollover fund's period length as 5 months,
            shorter than the prepayment charge's validity period: a year.
        rolloverApply:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
        isProcessed:
          type: boolean
          description: |
            Indicates whether the rate plan charge has been processed.
        listPriceBase:
          type: string
          description: |
            The list price base for the product rate plan charge.
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
        specificListPriceBase:
          type: integer
          format: int32
          description: >
            The number of months for the list price base of the charge. This
            field is required if you set the value of the `ListPriceBase` field
            to `Per Specific Months`.


            **Notes**: 
              - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
              - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
          maximum: 200
          minimum: 1
          nullable: true
        priceUpsellQuantityStacked:
          type: boolean
        commitmentType:
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a> feature enabled.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to `133` or higher. Otherwise, an error occurs. 


            This field defines the type of commitment. A prepaid charge can be
            `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can
            only be `CURRENCY` type. For topup(recurring or one-time) charges,
            this field indicates what type of funds are created. 

            * If UNIT, it will create a fund with given prepaidUom.

            * If CURRENCY, it will create a fund with the currency amount
            calculated in list price.
              
            For drawdown(usage) charges, this field indicates what type of funds
            are drawdown from that created from topup charges.
          enum:
            - UNIT
            - CURRENCY
          type: string
        isCommitted:
          type: boolean
          description: |
            Indicates whether the rate plan charge is commited.
        mRR:
          type: number
          description: >
            Monthly recurring revenue (MRR) is the amount of recurring

            charges in a given month. The MRR calculation doesn't include
            one-time

            charges nor usage charges. **Values**: automatically

            generated 
        name:
          type: string
          maxLength: 100
          description: >
            The name of the rate plan charge. **Values**: automatically
            generated 
        numberOfPeriods:
          type: integer
          format: int64
          description: >
            Specifies the number of periods to use when calculating charges in
            an overage smoothing charge model. **Values**: inherited from
            `ProductRatePlanCharge.NumberOfPeriod`.
        originalId:
          type: string
          maxLength: 32
          description: >
            The original ID of the rate plan charge. **Values**: automatically
            generated.
        overageCalculationOption:
          type: string
          maxLength: 20
          description: >
            Determines when to calculate overage charges. If the value of the
            SmoothingMode field is null (not specified and not inherited from
            ProductRatePlanCharge.SmoothingMode), the value of this field is
            ignored.

            **Values**: inherited from
            `ProductRatePlanCharge.OverageCalculationOption`.
        overageUnusedUnitsCreditOption:
          type: string
          maxLength: 20
          description: >
            Determines whether to credit the customer with unused units of
            usage. **Values**: inherited from
            `ProductRatePlanCharge.OverageUnusedUnitsCreditOption`.
        prepaidOperationType:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The type of this charge. It is either a prepayment (topup) charge or
            a drawdown charge. 
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          type: number
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          nullable: true
        prepaidTotalQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The total amount of units that end customers can use during a
            validity period when they subscribe to a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: number
          nullable: true
        priceChangeOption:
          type: string
          description: >
            Applies an automatic price change when a termed subscription is
            renewed.


            **Values**: one of the following:


            - `NoChange` (default)

            - `SpecificPercentageValue`

            - `UseLatestProductCatalogPricing`
        priceIncreasePercentage:
          type: number
          format: double
          description: >
            Specifies the percentage to increase or decrease the price of
            renewed subscriptions. **Values**: a decimal value between -100 and
            100.
        processedThroughDate:
          type: string
          format: date
          maxLength: 29
          description: >
            The date until when charges have been processed. When billing in
            arrears, such as usage, this field value is the the same as the
            `ChargedThroughDate` value. This date is the earliest date when a
            charge can be amended.

            **Values**: automatically generated.
        prorationOption:
          type: string
          description: >
            Determines how to prorate charges when a subscription is created or
            amended.
        quantity:
          type: number
          description: >
            The default quantity of units, such as the number of authors in a
            hosted wiki service. Valid for all charge models except for Flat Fee
            pricing. **Values**: a valid quantity value.
        numberOfDeliveries:
          type: number
          description: >
            Number of deliveries in the billing period for the charge segment.


            The `numberOfDeliveries` is used for the Delivery Pricing charge
            model only. 


            **Note**: The Delivery Pricing charge model is in the **Early
            Adopter** phase. We are actively soliciting feedback from a small
            set of early adopters before releasing it as generally available. To
            manage and access this feature through the self-service interface,
            see [Enable billing features by
            yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
            in the Knowledge Center. You can check **Delivery Pricing** in
            **Billing Settings** > **Enable Charge Types / Models**.
        ratingGroup:
          type: string
          description: >
            A rating group based on which usage records are rated. Only
            applicable to Usage charges.


            Possible values:


            - `ByBillingPeriod`: The rating is based on all the usages in a
            billing period.

            - `ByUsageStartDate`: The rating is based on all the usages on the
            same usage start date.

            - `ByUsageRecord`: The rating is based on each usage record.

            - `ByUsageUpload`: The rating is based on all the  usages in a
            uploaded usage file (`.xls` or `.csv`).

            - `ByGroupId`: The rating is based on all the usages in a custom
            group.


            For more information, see [Usage rating by
            group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group).
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
        revenueRecognitionRuleName:
          type: string
          description: >
            Specifies the Revenue Recognition Rule that you want the Rate Plan
            Charge to use. This field can be updated when **Status** is `Draft`.

            By default, the Revenue Recognition Rule is inherited from the
            Product Rate Plan Charge. For Amend calls, you can use this field
            only for NewProduct amendments.

            For Update calls, you can use this field only to update
            subscriptions in draft status. Note that if you use this field to
            specify a Revenue Recognition Rule for the Rate Plan Charge, 

            the rule will remain as specified even if you later change the rule
            used by the corresponding Product Rate Plan Charge.


            **Values**: inherited from
            `ProductRatePlanCharge.RevenueRecognitionRuleName` or the name of an
            active Revenue Recognition Rule


            **Note**: Unless overridden, this value changes if
            `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. 

            The values of `UpdatedById` and `UpdatedDate` for the
            `RatePlanCharge` do not change when
            `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated.
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        revRecCode:
          type: string
          maxLength: 70
          description: >
            Associates this product rate plan charge with a specific revenue
            recognition code.


            **Values**: inherited from `ProductRatePlanCharge.RevRecCode` or a
            valid revenue recognition code


            **Note**: Unless overridden, this value changes if
            `ProductRatePlanCharge.RevRecCode` is updated. The values of
            `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not
            change when `ProductRatePlanCharge.RevRecCode` is updated.
        revRecTriggerCondition:
          type: string
          maxLength: 22
          description: >
            Specifies when revenue recognition begins.


            **Values**: inherited from
            `ProductRatePlanCharge.RevRecTriggerCondition` or one of the
            following:

            - `ContractEffectiveDate`

            - `ServiceActivationDate`

            - `CustomerAcceptanceDate`


            Note: Unless overridden, this value changes if
            `ProductRatePlanCharge.RevRecTriggerCondition` is updated. The
            values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge`
            do not change when `ProductRatePlanCharge.RevRecTriggerCondition` is
            updated.
        segment:
          type: integer
          format: int32
          description: >
            The identifying number of the subscription rate plan segment.
            Segments are numbered sequentially, starting with 1.


            **Values**: automatically generated
        specificBillingPeriod:
          type: integer
          format: int64
          description: >
            Customizes the number of months or weeks for the charges billing
            period. This field is required if you set the value of the
            BillingPeriod field to `Specific Months` or `Specific Weeks`.


            **Values**: inherited from `ProductRatePlanCharge.BillingPeriod`


            **Note:** You can override the value inherited from the Product Rate
            Plan Charge, but only when creating a new subscription or a New
            Product amendment.
        specificEndDate:
          type: string
          format: date
          description: >
            The specific date on which the charge ends, in `yyyy-mm-dd` format.


            **Note**:


            - This field is only applicable when the `EndDateCondition` field is
            set to `SpecificEndDate`.

            - If the subscription ends before the specific end date, the charge
            ends when the subscription ends. But if the subscription end date is
            subsequently changed through a Renewal, or Terms and Conditions
            amendment, the charge will end on the specific end date.
        tCV:
          description: |2-
             The total contract value (TCV) is the value of a single rate plan charge in a subscription over the lifetime of the subscription. This value does not represent all charges on the subscription. The TCV includes recurring charges and one-time charges, but it doesn't include usage charge.
            **Values**: automatically generated 
          format: double
          type: number
        triggerDate:
          description: >
            The date when the charge becomes effective and billing begins, in
            `yyyy-mm-dd` format. This field is required if the `TriggerEvent`
            field value is `SpecificDate`.
          format: date
          type: string
        triggerEvent:
          description: >
            Specifies when to start billing the customer for the charge.

            **Note: **This field can be passed through the Subscribe and Amend
            calls and will override the default value set on the Product Rate
            Plan Charge.


            **Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and
            can be one of the following values:


            - `ContractEffective` is the date when the subscription's contract
            goes into effect and the charge is ready to be billed.

            - `ServiceActivation` is when the services or products for a
            subscription have been activated and the customers have access.

            - `CustomerAcceptance` is when the customer accepts the services or
            products for a subscription.

            - `SpecificDate` is valid only on the RatePlanCharge.
          type: string
          maxLength: 18
        uOM:
          description: |
            Specifies the units to measure usage. 

            **Values**: inherited from `ProductRatePlanCharge.UOM`
          type: string
          maxLength: 25
        upToPeriods:
          type: integer
          format: int64
          description: >
            Specifies the length of the period during which the charge is
            active. If this period ends before the subscription ends, the charge
            ends when this period ends.


            **Values**: inherited from `ProductRatePlanCharge.UpToPeriods`
            **Note**:


            - You must use this field together with the `UpToPeriodsType` field
            to specify the time period. This field is only applicable only when
            the `EndDateCondition` field is set to `FixedPeriod`.

            - You can override the value inherited from the Product Rate Plan
            Charge, but only when creating a new subscription or a New Product
            amendment.

            - Use this field to override the value in
            `ProductRatePlanCharge.UpToPeriod`.

            - If you override the value in this field, enter a whole number
            between 0 and 65535, exclusive.

            - If the subscription end date is subsequently changed through a
            Renewal, or Terms and Conditions amendment, the charge end date will
            change accordingly up to the original period end.
        upToPeriodsType:
          type: string
          description: >
            The period type used to define when the charge ends. This field can
            be updated when **Status** is `Draft`. 


            **Note**:


            - You must use this field together with the `UpToPeriods` field to
            specify the time period.

            - This field is only applicable only when the `EndDateCondition`
            field is set to `FixedPeriod`.
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
          default: Billing Periods
        version:
          type: integer
          format: int64
          description: >
            The version of the rate plan charge. Each time a charge is amended,
            Zuora creates a new version of the rate plan charge. **Values**:
            automatically generated.
        weeklyBillCycleDay:
          description: >
            Specifies which day of the week as the bill cycle day (BCD) for the
            charge.
          type: string
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
        subscriptionId:
          type: string
          description: >
            The unique identifier of the subscription to which the rate plan
            charge belongs.
        subscriptionOwnerId:
          type: string
          description: |
            ID of the account that owns the subscription.
        invoiceOwnerId:
          type: string
          description: >
            ID of the account that will pay the billing documents for the
            subscription.
        originalOrderDate:
          type: string
          format: date
          description: >
            The date when the rate plan charge is created through an order or
            amendment. This field is to standardize the booking date information
            to increase audit ability and traceability of data between Zuora
            Billing and Zuora Revenue. It is mapped as the booking date for a
            sales order line in Zuora Revenue.
        amendedByOrderOn:
          type: string
          format: date
          description: |
            The date when the rate plan charge is amended through an order
            or amendment. This field is to standardize the booking date
            information to increase audit ability and traceability of data
            between Zuora Billing and Zuora Revenue. It is mapped as the
            booking date for a sale order line in Zuora Revenue.
        validityPeriodType:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The period in which the prepayment units are valid to use as defined
            in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
        creditOption:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled. 


            The way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        applyToBillingPeriodPartially:
          type: boolean
          description: >
            Allow the discount duration to be aligned with the billing period
            partially.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
        productChargeDefinitionId:
          type: string
          description: |
            The unique ID of the product charge definition.
        accountReceivableAccountingCodeId:
          description: >
            ID of the accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
          type: string
        deferredRevenueAccountingCodeId:
          description: >
            ID of the deferredRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        recognizedRevenueAccountingCodeId:
          description: >
            ID of the recognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        prepaidUOM:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            Unit of measurement for a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: string
        drawdownUom:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            Unit of measurement for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
          type: string
        ratePlan:
          type: object
          description: |
            The rate plan to which this charge belongs.
        productRatePlanCharge:
          type: object
          description: |
            The product rate plan charge associated with this rate plan charge.
        salesPrice:
          type: number
          description: >
            The sales price associated with the rate plan charge expressed as a
            decimal.

                
            **Notes**:

              - This field is only available to subscriptions that are created through orders and exist after 2023-01-10.
              
              - This field applies to the following charge models, and the values vary with the charge models:
                  - Flat fee: the value equals the value of the `price` field.
                  - Per unit: the value equals `price` multiplied by `quantity`.
                  - Fixed amount discount: the value equals the value of the `discountAmount` field.
                  - Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit.
                  - Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit.
        taxable:
          type: boolean
          description: |
            Indicates whether the rate plan charge is taxable.
        reverted:
          type: boolean
          description: |
            Indicates whether the rate plan charge has been reverted.
        reflectDiscountInNetAmount:
          type: boolean
          description: |
            Indicates whether the discount is reflected in the net amount.
                
      additionalProperties:
        type: object
        description: >
          Custom fields of the Rate Plan Charge object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryRatePlanChargeResponse
    NestedCreditTaxationItemOnExpand:
      properties:
        appliedAmount:
          description: |
            The applied amount of the taxation item.
          format: double
          type: number
        axemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        jurisdiction:
          description: >
            The jurisdiction that applies the tax or VAT. This value is
            typically a state, province, county, or city. 
          type: string
        locationCode:
          description: >
            The identifier for the location based on the value of the `taxCode`
            field. 
          type: string
        name:
          description: |
            The name of the taxation item.
          type: string
        refundAmount:
          description: |
            The amount of the refund on the taxation item.
          format: double
          type: number
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxCode:
          description: >
            The tax code identifies which tax rules and tax rates to apply to a
            specific credit memo.
          type: string
        taxCodeDescription:
          description: |
            The description of the tax code.
          type: string
        taxDate:
          description: >
            The date that the tax is applied to the credit memo, in yyyy-mm-dd
            format.
          type: string
          format: date
        taxMode:
          description: >
            The tax mode of the credit memo, indicating whether the amount of
            the credit memo includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxRate:
          description: |
            The tax rate applied to the credit memo.
          format: decimal
          type: string
        taxRateDescription:
          description: |
            The description of the tax rate.
          type: string
        taxRateType:
          description: |
            The type of the tax rate.
          enum:
            - Percentage
            - FlatFee
          type: string
        unappliedAmount:
          description: |
            The unapplied amount of the taxation item.
          format: double
          type: number
        creditMemoItemId:
          description: |
            The ID of the credit memo item.
          type: string
        taxableItemSnapshotId:
          type: string
          description: |
            The unique identifier of the taxable item snapshot.
        id:
          type: string
          description: |
            The unique identifier of the taxation item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the taxation item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the taxation item was created in the Zuora
            system, in the `yyyy-mm-dd hh:mm:ss` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the taxation
            item.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the taxation item was last updated, in the
            `yyyy-mm-dd hh:mm:ss` format. 
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The accounting code for Account Receivable.
      type: object
      title: QueryCreditTaxationItemResponse
    ExpandedCreditMemoItem:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the credit memo item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the credit memo item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo item was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the credit memo
            item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the credit memo item was last updated.
        amount:
          type: number
          description: >
            The amount of the credit memo item. For tax-inclusive credit memo

            items, the amount indicates the credit memo item amount including
            tax.

            For tax-exclusive credit memo items, the amount indicates the credit

            memo item amount excluding tax.
        amountWithoutTax:
          description: |
            The credit memo item amount excluding tax.
          format: double
          type: number
        appliedToItemId:
          description: >
            The unique ID of the credit memo item that the discount charge is
            applied to.
          type: string
        appliedToOthersAmount:
          type: number
          description: |
            The amount of the credit memo that is applied to other credit memo
            items.
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          description: >
            The date when the credit memo item is charged, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
        description:
          description: >
            The description of the credit memo item.


            **Note**: This field is only available if you set the
            `Zuora-Version` request header to `257.0` or later [available
            versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version).
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude the credit memo item from revenue accounting.


            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: boolean
        fulfillmentId:
          description: >
            The reference ID of the fulfillment associated with the credit memo
            item.
          type: string
        invoiceScheduleId:
          description: >
            The ID of the invoice schedule associated with the credit memo
            item. 


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
          type: string
        invoiceScheduleItemId:
          description: >
            The ID of the invoice schedule item associated with the credit memo
            item. The credit memo item is generated during the processing of the
            invoice schedule item.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
          type: string
        itemShipToContactId:
          description: >
            The ID of the ship-to contact associated with the credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemSoldToContactId:
          description: >
            The ID of the sold-to contact associated with the credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemSoldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the credit
            memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemType:
          type: string
          description: |
            The type of the credit memo item.
        orderLineItemId:
          type: string
          description: >
            The ID of the order line item associated with the credit memo item,
            if applicable.
        processingType:
          description: |
            The type of the charge for the credit memo item. 
            - `0`: Charge - `1`: Discount
          type: string
          enum:
            - '0'
            - '1'
        revenueImpacting:
          description: >
            Indicates whether this write off operation impacts the revenue. If
            `revenueImpacting` = `Yes`, the deferred revenue accounting code
            will be automatically selected from the associated invoice.


            If `revenueImpacting` = `No`, users can select an accounting code
            such as bad-debt expense accounting code for the write off
            operation.
          enum:
            - 'Yes'
            - 'No'
          default: 'Yes'
          type: string
        quantity:
          description: |
            The number of units for the credit memo item.
          format: double
          type: number
        purchaseOrderNumber:
          type: string
          description: |
            The purchase order number associated the credit memo item.
        creditFromItemSource:
          description: |
            The type of the credit from item.
          enum:
            - InvoiceItem
            - CreditMemoItem
          type: string
        creditFromItemId:
          type: string
          description: |
            The ID of the credit from item.
        reflectDiscountInNetAmount:
          type: boolean
          default: false
          description: >
            When you apply percentage discounts to either of the following
            charges, you need to set the `reflectDiscountInNetAmount` field on
            your discount charge to `true`, to enable calculating and displaying
            the net amount of the following charges in Zuora Revenue.

            * delivery pricing charge

            * prepayment charge

            * drawdown charge


            Note the following:

            * If you are an <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> customer, when you set the
            `reflectDiscountInNetAmount` field to `true`, you must also set the
            `excludeItemBillingFromRevenueAccounting` field to `true`. 

            * If you are a <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> customer, you must
            set the `reflectDiscountInNetAmount` field to `false`, otherwise an
            error will be returned. Billing - Revenue Integration does not
            support discounts on the preceding charges.

            * If you are a Zuora Billing customer who does not enable the Order
            to Revenue or Billing - Revenue Integration feature, when you apply
            percentage discounts to the preceding charges, you also need to set
            the `reflectDiscountInNetAmount` field to `true`.  
        serviceEndDate:
          description: |
            The service end date of the credit memo item. 
          format: date
          type: string
        serviceStartDate:
          description: |
            The service start date of the credit memo item.
          format: date
          type: string
        sku:
          description: |
            The SKU for the product associated with the credit memo item.
          type: string
        sourceItemType:
          description: >
            The type of the source item.


            - If a credit memo is not created from an invoice or a product rate
            plan charge or a return order line item, the value of this field is
            `SubscriptionComponent`. 

            - If a credit memo is created from an invoice, the value of this
            field is `InvoiceDetail`.

            - If a credit memo is created from a product rate plan charge, the
            value of this field is `ProductRatePlanCharge`.

            - If a credit memo is created from a return order line item, the
            value of this field is `OrderLineItem`.
                          
          enum:
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
            - OrderLineItem
          type: string
        subscriptionId:
          description: |
            The ID of the subscription associated with the credit memo item.
          type: string
        taxMode:
          description: >
            The tax mode of the credit memo item, indicating whether the amount
            of the credit memo item includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        chargeName:
          type: string
          description: |
            The name of the charge associated with the credit memo item. 
        chargeNumber:
          type: string
          description: >
            The number of the product rate plan charge that the credit memo is
            created from.
        commitmentChargeSegmentNumber:
          type: string
        commitmentChargeNumber:
          type: string
        taxAmount:
          description: |
            The amount of the tax applied to the credit memo item.
          format: double
          type: number
        taxCodeName:
          type: string
          description: >
            The tax code identifies which tax rules and tax rates to apply to a
            specific credit memo item.
        taxExemptAmount:
          type: number
          description: |
            The calculated tax amount excluded due to the exemption.
        unappliedAmount:
          description: |
            The unapplied amount of the credit memo item.
          format: double
          type: number
        unitOfMeasure:
          description: |
            The units to measure usage.
          type: string
        unitPrice:
          description: |
            The per-unit price of the credit memo item.
          format: double
          type: number
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription associated with the credit memo item.
        invoiceItemId:
          type: string
          description: |
            The ID of the invoice item associated with the credit memo item.
        productRatePlanChargeId:
          type: string
          description: >
            The ID of the product rate plan charge that the credit memo is
            created

            from.
        ratePlanChargeId:
          type: string
          description: |
            The ID of the rate plan charge associated with the credit memo item.
        revenueRecognitionRuleName:
          type: string
          description: >
            The name of the revenue recognition rule governing the revenue
            schedule.
        creditMemoId:
          type: string
          description: |
            The ID of the credit memo to which this credit memo item belongs.
        numberOfDeliveries:
          description: >
            The number of deliveries dedicated to the Delivery Pricing charges.
            The value might be different, as follows:

            - For the credit memo generated by a bill run, this field has a
            value. 

            - For the credit memo generated from an invoice, this field is
            blank.

            **Note**: This field is available only if you have the Delivery
            Pricing feature enabled.
          type: number
        recognizedRevenueAccountingCodeId:
          type: string
          description: |
            The Recognized Revenue accounting code for the credit memo item.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The Account Receivable accounting code for the credit memo item.
        onAccountAccountingCodeId:
          type: string
          description: |
            The On Account accounting code for the credit memo item.
        deferredRevenueAccountingCodeId:
          type: string
          description: |
            The Deferred Revenue accounting code for the credit memo item.
        journalEntryId:
          type: string
          description: >
            The ID of the journal entry that corresponds to this credit memo
            item.
        shipToContactSnapshotId:
          description: >
            The ID of the ship-to contact snapshot associated with the credit
            memo.
          type: string
        soldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the credit
            memo.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the credit
            memo.
          type: string
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        subscriptionOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        creditTaxationItems:
          $ref: '#/components/schemas/NestedCreditTaxationItemOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Credit Memo Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryCreditMemoItemResponse
    ExpandedDailyConsumptionSummary:
      properties:
        id:
          type: string
          description: The unique identifier of the daily consumption summary.
        originChargeId:
          type: string
          description: The unique identifier of the charge.
        chargeSegmentNumber:
          type: integer
          format: int32
          description: |
            The charge segment number.
        fundId:
          type: string
          description: |
            The unique identifier of the fund.
        dailyConsumptionAmount:
          type: number
          description: |
            The daily consumption amount.
        dailyTotalQuantity:
          type: number
          description: |
            The total quantity consumed daily.
        transactionDate:
          type: string
          format: date
          description: |
            The date of the transaction.
        ratingResultId:
          type: string
          description: |
            The unique identifier of the rating result.
        dailyGroupSummaryId:
          type: string
          description: |
            The unique identifier of the daily group summary.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the daily consumption
            summary.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the daily consumption summary was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the daily
            consumption summary.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the daily consumption summary was last
            updated.
        drawdownOriginChargeId:
          type: string
          description: |
            The unique identifier of the original drawdown charge.
        drawdownChargeSegmentNumber:
          type: integer
          format: int32
          description: |
            The charge segment number of the drawdown charge.
        drawdownRecognizedRevenueGlAccountNumber:
          type: string
          description: >
            The GL account number of the recognized revenue for the drawdown
            charge.
        drawdownAdjustmentRevenueGlAccountNumber:
          type: string
          description: >
            The GL account number of the adjusted revenue for the drawdown
            charge.
        usageChargeName:
          type: string
          description: |
            The name of the usage charge.
        usageChargeNumber:
          type: string
          description: |
            The number of the usage charge.
      type: object
      title: QueryDailyConsumptionSummaryResponse
    NestedDebitMemoItemOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the debit memo item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the debit memo item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo item was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the debit memo
            item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo item was last updated.
        amount:
          description: >
            The amount of the debit memo item. For tax-inclusive debit memo
            items, the amount indicates the debit memo item amount including
            tax. For tax-exclusive debit memo items, the amount indicates the
            debit memo item amount excluding tax.
          format: double
          type: number
        amountWithoutTax:
          description: |
            The debit memo item amount excluding tax.
          format: double
          type: number
        appliedToItemId:
          type: string
          description: >
            The parent debit memo item that this debit memo items is applied to
            if this item is discount.
        appliedToOthersAmount:
          type: number
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          description: >
            The date when the debit memo item is charged, in `yyyy-mm-dd
            hh:mm:ss`

            format.
          format: date-time
        creditMemoItemId:
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude the debit memo item from revenue accounting.


            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: boolean
        description:
          type: string
          description: |
            The description of the debit memo item.
        itemShipToContactId:
          description: >
            The ID of the ship-to contact associated with the debit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
        itemSoldToContactId:
          description: >
            The ID of the sold-to contact associated with the debit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemSoldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the debit
            memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        processingType:
          description: |
            The type of the charge for the debit memo item. 
            - `0`: charge - `1`: discount
          type: string
          enum:
            - '0'
            - '1'
        quantity:
          description: |
            The number of units for the debit memo item.
          format: double
          type: number
        reflectDiscountInNetAmount:
          type: boolean
          default: false
          description: >
            When you apply percentage discounts to either of the following
            charges, you need to set the `reflectDiscountInNetAmount` field on
            your discount charge to `true`, to enable calculating and displaying
            the net amount of the following charges in Zuora Revenue.

            * delivery pricing charge

            * prepayment charge

            * drawdown charge


            Note the following:

            * If you are an <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> customer, when you set the
            `reflectDiscountInNetAmount` field to `true`, you must also set the
            `excludeItemBillingFromRevenueAccounting` field to `true`. 

            * If you are a <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> customer, you must
            set the `reflectDiscountInNetAmount` field to `false`, otherwise an
            error will be returned. Billing - Revenue Integration does not
            support discounts on the preceding charges.

            * If you are a Zuora Billing customer who does not enable the Order
            to Revenue or Billing - Revenue Integration feature, when you apply
            percentage discounts to the preceding charges, you also need to set
            the `reflectDiscountInNetAmount` field to `true`.  
        serviceEndDate:
          description: >
            The end date of the service period associated with this debit memo
            item. Service ends one second before the date specified in this
            field.
          format: date
          type: string
        serviceStartDate:
          description: >
            The start date of the service period associated with this debit memo
            item. If the associated charge is a one-time fee, this date is the
            date of that charge.
          format: date
          type: string
        sku:
          type: string
          description: |
            The SKU for the product associated with the debit memo item.
        sourceItemType:
          description: |
            The type of the source item.
          enum:
            - CreditMemoItem
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
          type: string
        chargeName:
          type: string
          description: |
            The name of the charge associated with the debit memo item.
        chargeNumber:
          type: string
          description: |
            The number of the charge associated with the debit memo item.
        taxAmount:
          type: number
          description: |
            The amount of tax on this debit memo.
          format: double
        taxCodeName:
          type: string
          description: >
            Name of the tax code identifies which tax rules and tax rates to
            apply to a specific debit memo item.
        taxExemptAmount:
          type: number
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
        taxMode:
          description: >
            The tax mode of the debit memo item, indicating whether the amount
            of the debit memo item includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitOfMeasure:
          description: |
            The units to measure usage.
          type: string
        unitPrice:
          description: |
            The per-unit price of the debit memo item.
          format: double
          type: number
        subscriptionId:
          type: string
          description: |
            The ID of the subscription associated with the debit memo item.
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription associated with the debit memo item.
        invoiceItemId:
          type: string
          description: |
            The ID of the invoice item associated with the debit memo item.
        productRatePlanChargeId:
          type: string
          description: >
            The ID of the product rate plan charge based on which the debit memo
            item is created.
        ratePlanChargeId:
          type: string
          description: |
            The ID of the rate plan charge associated with the debit memo item.
        debitMemoId:
          type: string
          description: |
            The ID of the debit memo to which this debit memo item belongs.
        balance:
          type: number
          description: |
            The balance of the debit memo item.
          format: double
        recognizedRevenueAccountingCodeId:
          type: string
          description: |
            The Recognized Revenue accounting code for the credit memo item.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The Account Receivable accounting code for the credit memo item.
        deferredRevenueAccountingCodeId:
          type: string
          description: |
            The Deferred Revenue accounting code for the credit memo item.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        soldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the credit
            memo.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the credit
            memo.
          type: string
        subscription:
          type: object
          description: |
            The subscription associated with the debit memo item.
        ratePlanCharge:
          type: object
          description: |
            The rate plan charge associated with the debit memo item.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Debit Memo Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryDebitMemoItemResponse
    ExpandedDebitMemo:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the debit memo.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the debit memo.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the debit memo.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo was last updated.
        autoPay:
          description: >
            Whether debit memos are automatically picked up for processing in
            the

            corresponding payment run.



            By default, debit memos are automatically picked up for processing
            in

            the corresponding payment run.
          type: boolean
        creditMemoId:
          type: string
          description: |
            The ID of the credit memo from which the debit memo was created.
          nullable: true
        balance:
          type: number
          description: |
            The remaining balance of debit memo.
        billToContactId:
          description: >
            The ID of the bill-to contact associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the debit
            memo.


            The value of this field is `null` if the bill rule [Preserve
            snapshot of bill-to and sold-to contacts when billing documents are
            posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted)
            is disabled.
          type: string
        cancelledById:
          description: |
            The ID of the Zuora user who cancelled the debit memo.
          type: string
          nullable: true
        cancelledOn:
          description: >
            The date and time when the debit memo was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
          nullable: true
        comments:
          description: |
            Comments about the debit memo.
          type: string
        currency:
          description: >
            The currency of the debit memo.


            **Note:** By default, the currency on a billing document matches the
            default currency set on the associated account. 

            However, Zuora now offers a Multiple Currencies feature to support
            different currencies for billing documents, allowing flexibility
            beyond the account-level currency. 

            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currency</a>.
          type: string
          nullable: true
        discountAmount:
          type: number
          description: |
            The amount of the discount on the debit memo.
        dueDate:
          type: string
          format: date
          description: |
            The date by which the payment for the debit memo is due, in
            `yyyy-mm-dd` format.
        einvoiceErrorCode:
          description: >
            The error code returned when the e-invoice file status is `Failed`.
            This code can either be a Zuora-generated error code or one returned
            by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceErrorMessage:
          description: >
            The error message returned when the e-invoice file status is
            `Failed`. This message can either be a Zuora-generated error message
            or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceFileId:
          description: >
            The ID of the e-invoice file generated for the debit memo.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          type: string
        einvoiceStatus:
          description: >
            The status of the e-invoice file generation for the credit memo. 


            - If e-invoice file generation succeeds, this field is either
            `Generated` or `Success`, and both the error code and message are
            empty, and the `eInvoiceFileId` field stores the ID of the generated
            e-invoice file.

            - If the responses from tax vendors such as Sovos or Avalara are 
              taking too long, this field becomes `RetrieveTimeOut`. Once the 
              vendor responds successfully, you can use the 'Resync E-Invoice Status' 
              action to update the status automatically.  You can view these updates 
              in System Health telemetry.

            - If a failure occurs during e-invoice file generation, this field
            is `Failed` and an error code and an error message are returned
            respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage`
            fields. 

            - If e-invoice file generation conditionally succeeds, this field is
             `ConditionalSuccess` and an error code and an error message are 
             returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields.

            - If the e-invoice file has been approved by the tax authority, this
             field is `ApprovedByAuthority`. The next status will be either
              `Success` or `Rejected`.

            - If the e-invoice file has been rejected by the government, this
            field
             is `Rejected`. You cannot resend this e-invoice; you must create a
              new invoice instead.


            **Note**: This field is available only if you have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/e-invoicing/e-invoicing-overview"
            target="_blank">E-Invoicing</a> feature in **Early Adopter** phase
            enabled.
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        exchangeRateDate:
          type: string
          format: date
          description: >
            The date of the exchange rate used. The date is in `yyyy-mm-dd`
            format.

            Corresponds to the value specified in the Provider Exchange Rate
            Date column in the Import Foreign Exchange Rates template when you
            uploaded the rates through the Mass Updater.
        memoDate:
          type: string
          format: date
          description: |
            The date when the debit memo takes effect, in `yyyy-mm-dd` format.
            For example, `2024-01-01`.
        memoNumber:
          description: |
            The unique identification number of the debit memo.
          type: string
        postedById:
          description: |
            The ID of the Zuora user who posted the debit memo.
          type: string
        postedOn:
          description: |
            The date and time when the debit memo was posted, in
            `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        reasonCode:
          description: |
            A code identifying the reason for the transaction. The value
            must be an existing reason code or empty.
          type: string
        sequenceSetId:
          description: >
            The ID of the sequence set associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled.
          type: string
          nullable: true
        source:
          description: >
            The source of the debit memo.

            Possible values:

            - `BillRun`: The debit memo is generated by a bill run.

            - `API`

            - `ApiSubscribe`: The debit memo is created by calling the [Create
            subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription)
            and [Create
            account](https://developer.zuora.com/api-references/api/operation/POST_Account)
            operation.

            - `ApiAmend`: The debit memo is created by calling the [Update
            subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription)
            operation.

            - `AdhocFromPrpc`: The debit memo is created from a product rate
            plan charge through the Zuora UI or by calling the [Create a debit
            memo from a
            charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc/)
            operation.

            - `AdhocFromInvoice`: The debit memo is created from an invoice or
            created by reversing an invoice. You can create a debit memo from an
            invoice through the Zuora UI or by calling the [Create a debit memo
            from an
            invoice](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice/)
            operation.
          type: string
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
            - AdhocFromPrpc
            - AdhocFromInvoice
        sourceId:
          description: |
            The ID of the debit memo source.

            If a debit memo is generated from a bill run, the value is the
            number of the corresponding bill run. Otherwise, the value is
            `null`.
          type: string
        sourceType:
          description: |
            The type of the debit memo source.
          enum:
            - Subscription
            - Standalone
            - Order
            - Consolidation
            - Invoice
            - CreditMemo
          type: string
        status:
          description: |
            The status of the debit memo.
          enum:
            - Draft
            - Posted
            - Canceled
            - Error
            - PendingForTax
            - Generating
            - CancelInProgress
          type: string
        targetDate:
          description: >
            The target date for the debit memo, in `yyyy-mm-dd` format. For
            example, `2024-01-01`.
          format: date
          type: string
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxMessage:
          description: |
            The message about the status of tax calculation related to the
            debit memo. If tax calculation fails in one debit memo, this
            field displays the reason for the failure.
          type: string
          nullable: true
        taxStatus:
          description: >
            The status of tax calculation related to the debit memo.



            **Note**: This field is only applicable to tax calculation by

            third-party tax engines. Also, the `Voided` status indicates that
            the tax transaction is successfully canceled on the tax vendor's
            side. 

            If a tax transaction was successfully committed to the third-party
            tax engine but the invoice failed to post, Zuora automatically
            detects

            the issue and voids the tax transaction on the vendor's side.
          enum:
            - Complete
            - Error
            - UnknownError
            - DuplicateDoc
            - InvalidRequest
            - InvalidResponse
            - TaxEngineError
            - ConcurrentModify
            - InternalServerError
            - TaxCodeTemplateError
            - Voided
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the
            debit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the
            debit memo.

            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        taxAutoCalculation:
          default: true
          description: |
            Whether to automatically calculate taxes in the debit memo.
          type: boolean
        totalAmount:
          type: number
          format: double
          description: |
            The total amount of the debit memo, including taxes.
        totalAmountWithoutTax:
          type: number
          format: double
          description: |
            The total amount of the debit memo, excluding taxes.
        totalTaxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        transferredToAccounting:
          description: |
            Whether the debit memo was transferred to an external
            accounting system. This field is used for integration with
            accounting systems such as NetSuite.
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        invoiceId:
          description: |
            The ID of a referred invoice.
          type: string
        accountId:
          description: |
            The ID of the customer account associated with the debit memo.
          type: string
        paymentTerm:
          type: string
          description: >
            The name of the payment term assoicated with the debit memo.



            The value of this field is `null` if you have the [Flexible Billing

            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)

            feature disabled.
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        debitMemoItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedDebitMemoItemOnExpand'
        billToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        soldToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        shipToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Debit Memo object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryDebitMemoResponse
    NestedDebitTaxationItemOnExpand:
      properties:
        balance:
          description: |
            The balance of the taxation item.
          format: double
          type: number
        creditAmount:
          description: |
            The amount of credit memos applied to the debit memo.
          format: double
          type: number
        exemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        jurisdiction:
          description: >
            The jurisdiction that applies the tax or VAT. This value is
            typically a state, province, county, or city. 
          type: string
        locationCode:
          description: >
            The identifier for the location based on the value of the `taxCode`
            field. 
          type: string
        name:
          description: |
            The name of the taxation item.
          type: string
        paymentAmount:
          description: |
            The amount of payments applied to the debit memo.
          format: double
          type: number
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxCode:
          description: >
            The tax code identifies which tax rules and tax rates to apply to a
            specific debit memo.
          type: string
        taxCodeDescription:
          description: |
            The description of the tax code.
          type: string
        taxDate:
          description: >
            The date that the tax is applied to the debit memo, in yyyy-mm-dd
            format.
          type: string
          format: date
        taxMode:
          description: >
            The tax mode of the debit memo, indicating whether the amount of the
            debit memo includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        taxRate:
          description: |
            The tax rate applied to the debit memo.
          format: decimal
          type: string
        taxRateDescription:
          description: |
            The description of the tax rate.
          type: string
        taxRateType:
          description: |
            The type of the tax rate.
          enum:
            - Percentage
            - FlatFee
          type: string
        debitMemoItemId:
          description: |
            The ID of the debit memo item.
          type: string
        taxableItemSnapshotId:
          type: string
          description: |
            The unique identifier of the taxable item snapshot.
        taxationItemId:
          description: |
            The Id of the taxation item.
          type: string
        id:
          type: string
          description: |
            The unique identifier of the taxation item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the taxation item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the taxation item was created in the Zuora
            system, in the `yyyy-mm-dd hh:mm:ss` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the taxation
            item.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the taxation item was last updated, in the
            `yyyy-mm-dd hh:mm:ss` format. 
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The accounting code for Account Receivable.
      type: object
      title: QueryDebitTaxationItemResponse
    ExpandedDebitMemoItem:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the debit memo item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the debit memo item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo item was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the debit memo
            item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the debit memo item was last updated.
        amount:
          description: >
            The amount of the debit memo item. For tax-inclusive debit memo
            items, the amount indicates the debit memo item amount including
            tax. For tax-exclusive debit memo items, the amount indicates the
            debit memo item amount excluding tax.
          format: double
          type: number
        amountWithoutTax:
          description: |
            The debit memo item amount excluding tax.
          format: double
          type: number
        appliedToItemId:
          type: string
          description: >
            The parent debit memo item that this debit memo items is applied to
            if this item is discount.
        appliedToOthersAmount:
          type: number
        beAppliedByOthersAmount:
          type: number
        chargeDate:
          type: string
          description: >
            The date when the debit memo item is charged, in `yyyy-mm-dd
            hh:mm:ss`

            format.
          format: date-time
        creditMemoItemId:
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude the debit memo item from revenue accounting.


            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: boolean
        description:
          type: string
          description: |
            The description of the debit memo item.
        itemShipToContactId:
          description: >
            The ID of the ship-to contact associated with the debit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemSoldToContactId:
          description: >
            The ID of the sold-to contact associated with the debit memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        itemSoldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the debit
            memo item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
          type: string
        processingType:
          description: |
            The type of the charge for the debit memo item. 
            - `0`: charge - `1`: discount
          type: string
          enum:
            - '0'
            - '1'
        quantity:
          description: |
            The number of units for the debit memo item.
          format: double
          type: number
        reflectDiscountInNetAmount:
          type: boolean
          default: false
          description: >
            When you apply percentage discounts to either of the following
            charges, you need to set the `reflectDiscountInNetAmount` field on
            your discount charge to `true`, to enable calculating and displaying
            the net amount of the following charges in Zuora Revenue.

            * delivery pricing charge

            * prepayment charge

            * drawdown charge


            Note the following:

            * If you are an <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> customer, when you set the
            `reflectDiscountInNetAmount` field to `true`, you must also set the
            `excludeItemBillingFromRevenueAccounting` field to `true`. 

            * If you are a <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> customer, you must
            set the `reflectDiscountInNetAmount` field to `false`, otherwise an
            error will be returned. Billing - Revenue Integration does not
            support discounts on the preceding charges.

            * If you are a Zuora Billing customer who does not enable the Order
            to Revenue or Billing - Revenue Integration feature, when you apply
            percentage discounts to the preceding charges, you also need to set
            the `reflectDiscountInNetAmount` field to `true`.  
        serviceEndDate:
          description: >
            The end date of the service period associated with this debit memo
            item. Service ends one second before the date specified in this
            field.
          format: date
          type: string
        serviceStartDate:
          description: >
            The start date of the service period associated with this debit memo
            item. If the associated charge is a one-time fee, this date is the
            date of that charge.
          format: date
          type: string
        sku:
          type: string
          description: |
            The SKU for the product associated with the debit memo item.
        sourceItemType:
          description: |
            The type of the source item.
          enum:
            - CreditMemoItem
            - SubscriptionComponent
            - InvoiceDetail
            - ProductRatePlanCharge
          type: string
        chargeName:
          type: string
          description: |
            The name of the charge associated with the debit memo item.
        chargeNumber:
          type: string
          description: |
            The number of the charge associated with the debit memo item.
        taxAmount:
          type: number
          description: |
            The amount of tax on this debit memo.
          format: double
        taxCodeName:
          type: string
          description: >
            Name of the tax code identifies which tax rules and tax rates to
            apply to a specific debit memo item.
        taxExemptAmount:
          type: number
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
        taxMode:
          description: >
            The tax mode of the debit memo item, indicating whether the amount
            of the debit memo item includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitOfMeasure:
          description: |
            The units to measure usage.
          type: string
        unitPrice:
          description: |
            The per-unit price of the debit memo item.
          format: double
          type: number
        subscriptionId:
          type: string
          description: |
            The ID of the subscription associated with the debit memo item.
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription associated with the debit memo item.
        invoiceItemId:
          type: string
          description: |
            The ID of the invoice item associated with the debit memo item.
        productRatePlanChargeId:
          type: string
          description: >
            The ID of the product rate plan charge based on which the debit memo
            item is created.
        ratePlanChargeId:
          type: string
          description: |
            The ID of the rate plan charge associated with the debit memo item.
        debitMemoId:
          type: string
          description: |
            The ID of the debit memo to which this debit memo item belongs.
        balance:
          type: number
          description: |
            The balance of the debit memo item.
          format: double
        recognizedRevenueAccountingCodeId:
          type: string
          description: |
            The Recognized Revenue accounting code for the debit memo item.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The Account Receivable accounting code for the debit memo item.
        deferredRevenueAccountingCodeId:
          type: string
          description: |
            The Deferred Revenue accounting code for the debit memo item.
        journalEntryId:
          type: string
          description: >
            The ID of the journal entry that corresponds to this debit memo
            item.
        shipToContactSnapshotId:
          description: >
            The ID of the ship-to contact snapshot associated with the debit
            memo.
          type: string
        soldToContactSnapshotId:
          description: >
            The ID of the sold-to contact snapshot associated with the debit
            memo.
          type: string
        billToContactSnapshotId:
          description: >
            The ID of the bill-to contact snapshot associated with the debit
            memo.
          type: string
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        subscriptionOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        debitTaxationItems:
          $ref: '#/components/schemas/NestedDebitTaxationItemOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Debit Memo Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryDebitMemoItemResponse
    ExpandedDeliveryAdjustment:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the delivery adjustment.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the delivery
            adjustment.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the delivery adjustment was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the delivery
            adjustment.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the delivery adjustment was last updated.
        adjustmentNumber:
          type: string
          description: |
            The system-generated delivery adjustment number.
        creditMemoNumber:
          type: string
          description: |
            Number of the credit memo generated for the delivery adjustment.
        debitMemoNumber:
          description: >
            The Debit Memo generated to write off the Credit Memo for the
            delivery adjustment.    
          type: string
        creditMemoId:
          type: string
          description: |
            The ID of the credit memo generated for the delivery adjustment.
        segmentId:
          type: string
          description: >
            The ID of the segment on the subscription for which the delivery
            adjustment is created.
        chargeId:
          type: string
          description: |
            The charge ID in the subscription for which the delivery
            adjustment is created.
        chargeNumber:
          description: |
            The charge number in the subscription for which the delivery
            adjustment is created.
          type: string
        subscriptionId:
          type: string
          description: |
            The ID of the subscription for which the delivery
            adjustment is created.
        subscriptionNumber:
          description: >
            The number of the subscription for which the delivery adjustment is
            created.
          type: string
        originalSubId:
          type: string
          description: |
            The original subscription ID.
        status:
          description: |
            The status of the delivery adjustment.              
          type: string
          enum:
            - Billed
            - Cancelled
        numberOfDeliveries:
          description: |
            The total number of all delivery adjustments.
          type: number
        amountPerUnit:
          type: number
          description: |
            The actual charged amount per unit for the delivery adjustment.
        amount:
          description: |
            The amount of the delivery adjustment.
          type: number
        date:
          type: string
          description: |
            The delivery adjustment date, in `yyyy-mm-dd` format.
          format: date
        deliveryDay:
          type: string
          description: |
            The delivery adjustment day of the week.
        reason:
          description: |
            The reason for the delivery adjustment.
          type: string
        type:
          type: string
          description: |
            The type of delivery adjustment.
          enum:
            - DeliveryCredit
        accountId:
          type: string
          description: |
            The ID of the account who owns the delivery adjustment.
        invoiceOwnerAccountId:
          type: string
          description: >
            The account ID of the invoice owner who owns the delivery
            adjustment.
        accountingCode:
          type: string
          description: |
            The accounting code associated with the delivery adjustment.
        deferredAccountingCode:
          type: string
          description: >
            The accounting code for the deferred revenue, such as Monthly
            Recurring Liability. 


            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
        recognizedRevenueAccountingCode:
          type: string
          description: >
            The accounting code for the recognized revenue, such as Monthly

            Recurring Charges or Overage Charges.



            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
        revenueRecognitionRuleName:
          description: >
            The name of the revenue recognition rule governing the revenue

            schedule.


            **Note**: For the credit memo generated by the delivery adjustment,
            if this field is not specified, the value inherits from the
            subscription rate plan charge.
          type: string
        billingDate:
          description: >
            The billing date is same as the delivery date of the delivery
            adjustment, in `yyyy-mm-dd` format.
          format: date
          type: string
      additionalProperties:
        type: object
        description: >
          Custom fields of the Delivery Adjustment object. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryDeliveryAdjustmentResponse
    ExpandedFulfillment:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the fulfillment.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the fulfillment.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the fulfillment was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the fulfillment.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the fulfillment was last updated.
        orderLineItemId:
          type: string
          description: |
            ID of the order line item.
        fulfillmentNumber:
          description: The sytem generated number for the fulfillment.
          type: string
        fulfillmentType:
          description: |
            The type of the fulfillment. 
          enum:
            - Delivery
            - Return
          type: string
        fulfillmentDate:
          description: |
            The date of the fulfillment.
          format: date
          type: string
        quantity:
          description: |
            The quantity of the fulfillment.
          type: number
        state:
          description: >
            The state of the fulfillment. See <a
            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States"
            target="_blank">Order Line Item states, Order states, and state
            transitions</a> for more information.
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        trackingNumber:
          description: |
            The tracking number of the fulfillment.
          type: string
        billTargetDate:
          description: >
            The target date for the fulfillment to be picked up by bill run for
            billing.
          format: date
          type: string
        description:
          description: The description of the fulfillment.
          type: string
        carrier:
          description: >
            The carrier of the fulfillment. The available values can be managed
            in the Fulfillment Settings page under Billing Settings.
          type: string
        fulfillmentLocation:
          description: >
            The location of the fulfillment. The available values can be managed
            in the Fulfillment Settings page under Billing Settings.
          type: string
        fulfillmentSystem:
          description: >
            The system of the fulfillment. The available values can be managed
            in the Fulfillment Settings page under Billing Settings.
          type: string
        externalId:
          description: |
            The external ID of the fulfillment.
          type: string
        excludeItemBookingFromRevenueAccounting:
          description: >
            The flag to exclude fulfillment item from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature
            enabled. 
          type: boolean
        excludeItemBillingFromRevenueAccounting:
          description: >
            The flag to exclude fulfillment item from revenue accounting.


            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Zuora Billing - Revenue Integration</a> feature
            enabled. 
          type: boolean
      additionalProperties:
        type: object
        description: >
          Custom fields of the Fulfillment object. The name of each custom field
          has the form <code>*customField*__c</code>. Custom field names are
          case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryFulfillmentResponse
    NestedInvoiceItemOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the invoice item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the invoice item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice item was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the invoice item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice item was last updated.
        invoiceId:
          type: string
          description: >
            The unique identifier of the invoice to which this invoice item
            belongs.
        invoiceScheduleId:
          description: >
            The ID of the invoice schedule associated with the rate plan charge
            on the subscription.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
          type: string
        invoiceScheduleItemId:
          type: string
          description: >
            The ID of the invoice schedule item that generates this invoice
            item.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
        ratePlanChargeId:
          type: string
          description: |
            The ID of the rate plan charge associated with the invoice item.
        accountingCode:
          description: The accounting code associated with the invoice item.
          type: string
        appliedToInvoiceItemId:
          description: >
            The unique ID of the invoice item that the discount charge is
            applied

            to.
          type: string
        chargeAmount:
          description: >
            The amount of the charge. 


            **Note**: This amount does not include taxes regardless if the
            charge's tax mode is inclusive or exclusive. This is the discount
            amount actually applied when the invoice item is a discount charge.
          format: double
          type: number
        chargeDate:
          description: >
            The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss`
            format.
          format: date-time
          type: string
        chargeName:
          description: The name of the charge.
          type: string
        chargeNumber:
          type: string
          description: |
            Number of the charge.
        commitmentChargeNumber:
          type: string
        commitmentChargeSegmentNumber:
          type: string
        description:
          description: The description of the invoice item.
          type: string
        discountAmount:
          type: number
          description: |
            The amount of the discount.
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            The flag to exclude the invoice item from revenue accounting.


            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
        fulfillmentId:
          type: string
          description: >
            The reference ID of the fulfillment associated with the invoice
            item.
        itemShipToContactId:
          type: string
          description: >
            The ID of the ship-to contact associated with the invoice item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
        itemSoldToContactId:
          type: string
          description: >
            The ID of the sold-to contact associated with the invoice item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
        itemSoldToContactSnapshotId:
          type: string
          description: >
            The ID of the sold-to contact snapshot associated with the invoice
            item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
        processingType:
          type: string
          description: |
            The kind of the charge for the invoice item. 

            - `0`: charge
            - `1`: discount
            - `2`: prepayment
            - `3`: tax
          enum:
            - '0'
            - '1'
            - '2'
            - '3'
        quantity:
          type: number
          description: |
            The quantity of this item, in the configured unit of measure for the
            charge.
        reflectDiscountInNetAmount:
          type: boolean
          default: false
          description: >
            When you apply percentage discounts to either of the following
            charges, you need to set the `reflectDiscountInNetAmount` field on
            your discount charge to `true`, to enable calculating and displaying
            the net amount of the following charges in Zuora Revenue.

            * delivery pricing charge

            * prepayment charge

            * drawdown charge


            Note the following:

            * If you are an <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> customer, when you set the
            `reflectDiscountInNetAmount` field to `true`, you must also set the
            `excludeItemBillingFromRevenueAccounting` field to `true`. 

            * If you are a <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> customer, you must
            set the `reflectDiscountInNetAmount` field to `false`, otherwise an
            error will be returned. Billing - Revenue Integration does not
            support discounts on the preceding charges.

            * If you are a Zuora Billing customer who does not enable the Order
            to Revenue or Billing - Revenue Integration feature, when you apply
            percentage discounts to the preceding charges, you also need to set
            the `reflectDiscountInNetAmount` field to `true`.  
        revRecStartDate:
          type: string
          format: date
        serviceEndDate:
          description: |
            The end date of the service period for this item, i.e., the last day
            of the service period, as _yyyy-mm-dd_.
          format: date
          type: string
        serviceStartDate:
          description: |
            The start date of the service period for this item, as _yyyy-mm-dd_.
            For a one-time fee item, the date of the charge.
          format: date
          type: string
        sKU:
          type: string
          description: |
            The SKU of the product associated with the invoice item.
        sourceItemType:
          description: |
            The type of the source item.
          enum:
            - SubscriptionComponent
            - Rounding
            - ProductRatePlanCharge
            - None
            - OrderLineItem
          type: string
        subscriptionId:
          type: string
          description: |
            ID of the subscription associated with the invoice item.
        subscriptionNumber:
          type: string
          description: |
            Number of the subscription associated with the invoice item.
        taxAmount:
          description: |
            The amount of tax applied to the charge.
          format: double
          type: number
        taxCode:
          description: >
            The tax code of the invoice item.

            **Note** Only when taxation feature is enabled, this field can be
            presented.
          type: string
        taxExemptAmount:
          type: number
        taxMode:
          description: >
            The tax mode of the invoice item, indicating whether the amount of
            the invoice item includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitPrice:
          description: >
            The per-unit price of the invoice item.


            **Note**: For discount charges, this represents the discount
            percentage (for percentage-based discounts)  or the discount amount
            (for fixed-amount discounts). 
          format: double
          type: number
        uOM:
          type: string
          description: >
            The unit of measure (UOM) that is configured in **Settings >
            Billing** for the product rate plan charge.
        balance:
          type: number
          description: >
            The balance of the invoice item.


            **Note**: This field is only available if you have the Invoice
            Settlement feature enabled.
        numberOfDeliveries:
          type: number
          description: >
            The number of deliveries dedicated to the Delivery Pricing charges. 

            **Note**: This field is available only if you have the Delivery
            Pricing feature enabled. 
        accountReceivableAccountingCodeId:
          type: string
          description: >
            ID of the account receivable accounting code associated with the
            invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
        recognizedRevenueAccountingCodeId:
          type: string
          description: >
            ID of the recognized revenue accounting code associated with the
            invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
        deferredRevenueAccountingCodeId:
          description: >
            ID of the deferred revenue accounting code associated with the
            invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
          type: string
        contractAssetAccountingCodeId:
          description: >
            ID of the accounting code for contract asset. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        contractLiabilityAccountingCodeId:
          type: string
          description: >
            ID of the accounting code for contract liability. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
        contractRecognizedRevenueAccountingCodeId:
          description: >
            ID of the accounting code for contract recognized revenue. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          description: >
            The accounting code for adjustment revenue. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        adjustmentLiabilityAccountingCodeId:
          description: >
            ID of the accounting code for adjustment liability. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this invoice item.
        accountId:
          type: string
          description: |
            The ID of the account associated with the invoice item.
        billToContactSnapshotId:
          description: |
            The ID of the bill-to contact snapshot associated with the invoice.
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the invoice.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the invoice.
          type: string
        parentAccountId:
          type: string
          description: >
            The parent account of the account associated with the invoice.


            **Note**: This field is available only if you have <a

            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"

            target="_blank">Customer Hierarchy</a> enabled for your tenant.
        billToContactId:
          type: string
          description: |
            The ID of the bill-to contact associated with the invoice.
        shipToContactId:
          type: string
          description: |
            The ID of the ship-to contact associated with the invoice.
        soldToContactId:
          type: string
          description: |
            The ID of the sold-to contact associated with the invoice.
        defaultPaymentMethodId:
          type: string
          description: |
            The ID of the default payment method on the associated account.
        ratePlanId:
          type: string
          description: |
            The ID of the rate plan that the invoice is created from.
        amendmentId:
          type: string
          description: >
            The ID of the amendment associated with the subscription. 


            **Note**: This field is available only if you do not have Orders
            enabled for your tenant.
        productRatePlanChargeId:
          description: >
            The ID of the product rate plan charge that the invoice item is
            created from.
          type: string
        productRatePlanId:
          description: >
            The ID of the product rate plan that the invoice item is created
            from.
          type: string
        productId:
          description: |
            The ID of the product that the invoice item is created from.
          type: string
        bookingReference:
          type: string
          description: |
            The booking reference of the invoice item.
        itemType:
          type: string
          description: |
            The type of the invoice item.
        purchaseOrderNumber:
          description: |
            The purchase order number associated with the invoice item.
          type: string
        revRecCode:
          description: |
            The revenue recognition code.
          type: string
        revRecTriggerCondition:
          description: |
            The date when revenue recognition is triggered.
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          description: >
            The revenue recognition rule of the invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
          type: string
        subscriptionOwnerId:
          description: |
            The ID of the subscription owner associated with the invoice item.
          type: string
        orderLineItemId:
          description: >
            The reference ID of the oder line item associated with the invoice
            item.
          type: string
        invoice:
          type: object
          description: |
            The invoices to which the invoice item belongs.
        subscription:
          type: object
          description: |
            The invoice to which the invoice item belongs.
        ratePlanCharge:
          type: object
          description: |
            The rate plan charge associated with the invoice item.
        orderLineItem:
          type: object
          description: |
            The order line item associated with the invoice item.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Invoice Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryInvoiceItemResponse
    ExpandedInvoice:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the invoice.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the invoice.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the invoice gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the invoice.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the invoice gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        accountId:
          description: |
            The ID of the customer account associated with the invoice.
          type: string
        adjustmentAmount:
          description: |
            The amount of the invoice adjustments associated with the invoice.
          format: double
          type: number
        amount:
          description: |
            The total amount of the invoice.
          format: double
          type: number
        amountWithoutTax:
          description: |
            The invoice amount excluding tax.
          format: double
          type: number
        autoPay:
          description: >
            Whether invoices are automatically picked up for processing in the
            corresponding payment run.
          type: boolean
        balance:
          description: >
            The remaining balance of the invoice after all payments,
            adjustments, and refunds are applied.
          type: number
          format: double
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the invoice.
          type: string
        billToContactSnapshotId:
          description: |
            The ID of the bill-to contact snapshot associated with the invoice.
          type: string
        comments:
          type: string
          description: |
            Comments about the invoice.
        creditBalanceAdjustmentAmount:
          description: >
            The currency amount of the adjustment applied to the customer's
            credit balance.

              **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.
          format: double
          type: number
        creditMemoAmount:
          description: >
            The currency amount of all credit memos applied to this invoice.


            **Note:** This field is only available if you have [Invoice
            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)
            enabled. The Invoice Settlement feature is generally available as of
            Zuora Billing Release 296 (March 2021). This feature includes
            Unapplied Payments, Credit and Debit Memo, and Invoice Item
            Settlement. If you want to enable Invoice Settlement, see [Invoice
            Settlement Enablement and Checklist
            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)
            for more information.
          format: double
          type: number
        currency:
          description: >
            The currency of the invoice.


            **Note:** By default, the currency on a billing document matches the
            default currency set on the associated account. 

            However, Zuora now offers a Multiple Currencies feature to support
            different currencies for billing documents, allowing flexibility
            beyond the account-level currency. 

            For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currency</a>.
          nullable: true
          type: string
        dueDate:
          type: string
          format: date
          description: >
            The date by which the payment for this invoice is due, in
            `yyyy-mm-dd` format.
        includesOneTime:
          description: |
            Specifies whether the invoice includes one-time charges.
          type: boolean
        includesRecurring:
          description: |
            Specifies whether the invoice includes recurring charges.
          type: boolean
        includesUsage:
          description: |
            Specifies whether the invoice includes usage charges.
          type: boolean
        invoiceDate:
          description: |
            The date that appears on the invoice being created.
          format: date
          type: string
        invoiceNumber:
          description: |
            The unique identification number of the invoice.
          type: string
        lastEmailSentDate:
          description: |
            The date when the invoice was last emailed.
          type: string
        organizationId:
          type: string
          description: |
            ID of the organization this object belongs to.
        paymentAmount:
          description: |
            The amount of payments applied to the invoice.
          format: double
          type: number
        postedBy:
          description: |
            The user ID of the person who moved the invoice to Posted status.
          type: string
        postedDate:
          description: |
            The date when the invoice was posted.
          format: date-time
          type: string
        refundAmount:
          description: >
            Specifies the amount of a refund that was applied against an earlier
            payment on the invoice.
          format: double
          type: number
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the invoice.
          type: string
          nullable: true
        communicationProfileId:
          description: |
            The ID of the communication profile associated with the invoice.
          type: string
          nullable: true
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the invoice.
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the invoice.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the invoice.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the invoice.
          type: string
        source:
          description: |
            The source of the invoice.
          enum:
            - BillRun
            - API
            - ApiSubscribe
            - ApiAmend
          type: string
        sourceId:
          description: >
            The ID of the invoice source.

            If an invoice is generated from a bill run, the value is the number
            of the corresponding bill run.Otherwise, the value is `null`.
          type: string
        reversed:
          type: boolean
          description: |
            Whether the invoice is reversed.
        sourceType:
          description: |
            The type of the invoice source.
          enum:
            - Subscription
            - Standalone
            - Order
            - Consolidation
          type: string
        status:
          description: |
            The status of the invoice.
          enum:
            - Draft
            - Posted
          type: string
        targetDate:
          description: >
            This date is used to determine which charges are to be billed. All
            charges that are to be billed on this date or prior will be included
            in this bill run.
          format: date
          type: string
        taxAmount:
          description: |
            The amount of taxation.
          format: double
          type: number
        taxExemptAmount:
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
          type: number
        taxMessage:
          description: >
            The message that the tax engine return if it calculates the taxes of
            this invoice fails.
          type: string
          nullable: true
        taxStatus:
          description: >
            The status that the tax engine return after it calculates the taxes
            of this invoice. Also, the `Voided` status indicates that the tax
            transaction is successfully canceled on the tax vendor's side.  If a
            tax transaction was successfully committed to the third-party tax
            engine but the invoice failed to post, Zuora automatically detects
            the issue and voids the tax transaction on the vendor's side.
          enum:
            - Complete
            - Error
            - UnknownError
            - DuplicateDoc
            - InvalidRequest
            - InvalidResponse
            - TaxEngineError
            - ConcurrentModify
            - InternalServerError
            - TaxCodeTemplateError
            - Voided
          type: string
        templateId:
          description: >
            The ID of the invoice template.


            - If you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Flexible_Billing_Attributes"
            target="_blank">Flexible Billing Attributes</a> feature enabled, the
            value of this field depends on the configuration of the invoice
            template. 
              - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.
              - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.
            - If you have the Flexible Billing Attributes feature disabled, the
            value of this field is `null`.
          type: string
        transferredToAccounting:
          description: >
            Whether the invoice was transferred to an external accounting
            system.
          enum:
            - Processing
            - Error
            - Ignore
            - 'Yes'
            - 'No'
          type: string
        eInvoiceStatus:
          description: >
            It could be Processing, RetrieveTimeOut, Generated, Success,
            ConditionalSuccess, ApprovedByAuthority, Failed, and Rejected. If
            it’s Failed, it will have an error code and message. If it’s
            Generated or Success, both error code and message are empty, and
            eInvoiceFileId stores the file id of e-invoice.
          enum:
            - Processing
            - RetrieveTimeOut
            - Generated
            - Success
            - Failed
            - ConditionalSuccess
            - ApprovedByAuthority
            - Rejected
          type: string
        eInvoiceFileId:
          type: string
          description: |
            The ID of the e-invoice file.
        eInvoiceErrorCode:
          type: string
          description: >
            The error code when status is `Failed`. This code can either be a
            Zuora-generated error code or one returned by a third-party
            e-invoice vendor.
        eInvoiceErrorMessage:
          type: string
          description: >
            The error message when status is "Failed". This message can either
            be a Zuora-generated error code or one returned by a third-party
            e-invoice vendor.
        paymentLink:
          type: string
          description: >
            A link to the Payment Link page where the customer can pay the
            invoice.


            The link is generated only if the invoice is posted after enabling
            the Payment Link feature on your tenant.


            **Note**: The Payment Link feature is in the Early Adopter phase. 

            You can enable the Payment Link feature through a self-service
            configuration in the **Manage Features** setting for Zuora Payments.
        paymentTerm:
          type: string
          description: >
            The payment term associated with the invoice. The payment term
            determines the due dates of

            invoices.
          example: Net 30
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        invoiceItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
        billToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        soldToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
        shipToContactSnapshot:
          $ref: '#/components/schemas/NestedContactSnapshotOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Invoice object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryInvoiceResponse
    ExpandedTaxationItem:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the taxation item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the taxation item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the taxation item was created in the Zuora
            system, in the `yyyy-mm-dd hh:mm:ss` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the taxation
            item.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the taxation item was last updated, in the
            `yyyy-mm-dd hh:mm:ss` format. 
        creditAmount:
          type: number
          description: |
            The amount of credit memos applied to the taxation item. 
          format: double
        accountingCode:
          type: string
          description: >
            The accounting code that maps to the taxation item in your
            accounting system.
        exemptAmount:
          type: number
          description: |
            The calculated tax amount excluded due to the exemption.
          format: double
        invoiceItemId:
          type: string
          description: >
            The unique identifier of the invoice item to which the taxation item
            belongs.
        jurisdiction:
          type: string
          description: >
            The jurisdiction that applies the tax or VAT. This value is
            typically

            a state, province, county, or city.
        locationCode:
          type: string
          description: >
            The identifier for the location based on the value of the `taxCode`
            field. 
        name:
          type: string
          description: |
            The name of the taxation item. 
        paymentAmount:
          type: number
          description: |
            The amount of payment applied to the invoice or debit memo. 
          format: double
        taxAmount:
          type: number
          description: |
            The amount of the tax applied to the billing document.
          format: double
        taxAmountUnrounded:
          type: number
          description: >
            The amount of the tax applied to the billing document before
            rounding.
        countryCode:
          type: string
          description: |
            The code of country to which the taxation item.
        taxCodeDescription:
          type: string
          description: |
            The description of the tax code.
        customerCode:
          type: string
          description: >
            The customer code. This field is only available if you are using one
            of the Vertex Tax Connector apps.
        exemptCertificate:
          type: string
          description: >
            The tax exemption certificate that the customer holds. Applicable if
            you use Zuora Tax or Connect tax engines.
        sellerRegistration:
          type: string
          description: >
            Your seller registration code. This field is only available if you
            are using the OneSource Determination app.
        taxDescription:
          type: string
          description: |
            The description of the tax.
        taxRuleId:
          type: string
          description: |
            The unique identifier of the tax rule.
        taxCode:
          type: string
          description: |
            The tax code identifies which tax rules and tax rates to apply to a
            specific billing document.
        taxMode:
          type: string
          description: |
            The mode of the tax.
          enum:
            - TaxExclusive
            - TaxInclusive
        taxDate:
          type: string
          format: date
          description: |
            The date when the tax is applied to the billing document.
        taxRate:
          type: number
          description: |
            The tax rate applied to the billing document.
          format: double
        taxRateDescription:
          type: string
          description: |
            The description of the tax rate.
        taxRateType:
          type: string
          description: |
            The type of the tax rate applied to the billing document.
          enum:
            - Percentage
            - FlatFee
        balance:
          type: number
          description: |
            The remaining balance on the taxation item.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        salesTaxPayableAccountingCodeId:
          type: string
          description: |
            The accounting code for Sales Tax Payable.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The accounting code for Account Receivable.
        taxableItemSnapshotId:
          type: string
          description: |
            The unique identifier of the taxable item snapshot.
        periodEndDate:
          type: string
          format: date
          description: |
            The end date of the period to which the taxation item belongs.
        periodStartDate:
          type: string
          format: date
          description: |
            The start date of the period to which the taxation item belongs.
        taxableAmount:
          type: number
          format: double
          description: |
            The taxable amount of the taxation item.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Taxation Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryTaxationItemResponse
    NestedOrderLineItemOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the order line item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the order line item.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the order line item gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the order line
            item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the order line item was last updated.
        accountingCode:
          type: string
          description: >
            The accountingCode for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          nullable: true
        billTargetDate:
          description: >
            The target date for the Order Line Item (OLI) to be picked up by
            bill run for generating billing documents.


            To generate billing documents for an OLI, you must set this field
            and set the `itemState` field to `SentToBilling`.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        amountPerUnit:
          type: number
          description: >
            The actual charged amount per unit for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
        description:
          description: |
            The description of the Order Line Item.
          type: string
        amount:
          type: number
          description: |
            The total amount for the Order Line Item (OLI).
        amountWithoutTax:
          type: number
          description: |
            The total amount for the Order Line Item (OLI) excluding tax.
        itemName:
          description: >
            The name of the Order Line Item (OLI).


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          type: string
        itemNumber:
          description: >
            The number for the Order Line Item (OLI).


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          type: string
        itemState:
          description: >
            The state of the Order Line Item (OLI). See [State transitions for
            an order, order line item, and
            fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.


            To generate invoice for an OLI, you must set this field to
            `SentToBilling` and set the `billTargetDate` field .


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` or 'Booked' or `SentToBilling`state (when
            the `itemState` field is set as `Executing` or `SentToBilling`).
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          description: >
            The type of the Order Line Item (OLI). 


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          description: >
            The list price per unit for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: number
        listPrice:
          description: >
            The extended list price for an order line item, calculated by the
            formula:

            listPrice = listPricePerUnit * quantity
          type: number
        orderId:
          type: string
          description: |
            The ID of the order that the order line item belongs to.
        productCode:
          description: >
            The product code for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        purchaseOrderNumber:
          description: >
            Used by customers to specify the Purchase Order Number provided by
            the buyer.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        quantity:
          description: >
            The quantity of units, such as the number of authors in a hosted
            wiki service.


            You can update this field for a sales or return OLI only when the
            OLI in the `Executing` state (when the `itemState` field is set as
            `Executing`).
          type: number
        revenueRecognitionRule:
          type: string
          description: |
            The Revenue Recognition rule for the Order Line Item.
        productRatePlanChargeId:
          description: >
            ID of a Product Rate Plan Charge. Only one-time charges are
            supported.
          type: string
        billToId:
          description: >
            The ID of a contact that belongs to the billing account of the order
            line item. Use this field to assign an existing account as the
            bill-to contact of an order line item.
          type: string
        billToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the bill-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `billToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        shipTo:
          description: >
            The ID of a contact that belongs to the owner acount or billing
            account of the order line item. Use this field to assign an existing
            account as the ship-to contact of an order line item.
          type: string
        shipToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the ship-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `shipToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        soldTo:
          description: >
            The ID of a contact that belongs to the owner acount or billing
            account of the order line item. Use this field to assign an existing
            account as the sold-to contact of an order line item.
          type: string
        soldToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the sold-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `soldToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        soldToOrderContactId:
          type: string
          description: |
            The ID of the sold-to contact for the order.
        ownerAccountId:
          description: |
            The account ID of the owner of the order line item.
          type: string
        invoiceOwnerAccountId:
          description: |
            The account ID of the invoice owner of the order line item.
          type: string
        taxCode:
          description: >
            The tax code for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        taxMode:
          description: >
            The tax mode for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionDate:
          type: string
          format: date
          description: |
            The date when the transaction occurs.
        uOM:
          description: >
            Specifies the units to measure usage.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        relatedSubscriptionNumber:
          description: >
            This field is used to relate an order line item to an subscription. 


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        transactionEndDate:
          description: >
            The date a transaction is completed. The default value of this field
            is the transaction start date. Also, the value of this field should
            always equal or be later than the value of the
            `transactionStartDate` field.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        transactionStartDate:
          description: >
            The date a transaction starts. The default value of this field is
            the order date.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled. 
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related rate plan charges and order
            line items from revenue accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled.
        originalOrderDate:
          type: string
          format: date
          description: |
            The date of the original sale order for a return order line item.
        amendedByOrderOn:
          type: string
          format: date
          description: |
            The date of the amended order for a return order line item.
        itemCategory:
          default: Sales
          description: >
            The category of the Order Line Item, to indicate a product sale or
            return.
          enum:
            - Sales
            - Return
          type: string
        originalOrderId:
          description: |
            The ID of the original sale order for a return order line item. 
          type: string
        originalOrderLineItemId:
          description: >
            The ID of the original sale order line item for a return order line
            item. 
          type: string
        originalOrderLineItemNumber:
          description: >
            The number of the original sale order line item for a return order
            line item. 
          type: string
        originalOrderNumber:
          description: |
            The number of the original sale order for a return order line item. 
          type: string
        quantityAvailableForReturn:
          description: |
            The quantity that can be returned for an order line item. 
          type: number
        quantityFulfilled:
          description: |
            The fulfilled quantity for an order line item.
          type: number
        quantityPendingFulfillment:
          description: |
            The quantity to fulfill for an order line item. 
          type: number
        requiresFulfillment:
          description: >
            The flag to show whether fulfillment is needed or not. It's derived
            from billing rule of the Order Line Item.
          type: boolean
        billingRule:
          description: |
            The billing rule of the Order Line Item.
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        inlineDiscountPerUnit:
          description: >
            This field is used in accordance with the `inlineDiscountType`
            field, in the following manner:

            * If the `inlineDiscountType` field is set as `Percentage`, this
            field specifies the discount percentage for each unit of the order
            line item. For exmaple, if you specify `5` in this field, the
            discount percentage is 5%.

            * If the `inlineDiscountType` field is set as `FixedAmount`, this
            field specifies the discount amount on each unit of the order line
            item. For exmaple, if you specify `10` in this field, the discount
            amount on each unit of the order line item is 10.


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          type: number
        inlineDiscountType:
          description: >
            This field is used to specify the inline discount type, which can be
            `Percentage`, `FixedAmount`, or `None`. The default value is
            `Percentage`.


            This field is used together with the `inlineDiscountPerUnit` field
            to specify inline discounts for order line items. The inline
            discount is applied to the list price of an order line item. 


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        discount:
          type: number
          description: >
            This field shows the total discount amount that is applied to an
            order line item after the `inlineDiscountType`,
            `inlineDiscountPerUnit` and `quantity` fields are set.


            The inline discount is applied to the list price of an order line
            item.
        recognizedRevenueAccountingCodeId:
          type: string
          description: |
            The recognized revenue accounting code for the Order Line Item.
        deferredRevenueAccountingCodeId:
          description: |
            The deferred revenue accounting code for the Order Line Item.
          type: string
        contractAssetAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractRecognizedRevenueAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        unbilledReceivablesAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        adjustmentRevenueAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        adjustmentLiabilityAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        invoiceItems:
          type: array
          items:
            type: object
          description: The invoice item associated with the order line item.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Order Line Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryOrderLineItemResponse
    ExpandedInvoiceItem:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the invoice item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the invoice item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice item was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the invoice item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice item was last updated.
        invoiceId:
          type: string
          description: >
            The unique identifier of the invoice to which this invoice item
            belongs.
        invoiceScheduleId:
          description: >
            The ID of the invoice schedule associated with the rate plan charge
            on the subscription.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
          type: string
        invoiceScheduleItemId:
          type: string
          description: >
            The ID of the invoice schedule item that generates this invoice
            item.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"
            target="_blank">Billing Schedule</a> feature enabled.
        ratePlanChargeId:
          type: string
          description: |
            The ID of the rate plan charge associated with the invoice item.
        accountingCode:
          description: The accounting code associated with the invoice item.
          type: string
        appliedToInvoiceItemId:
          description: >
            The unique ID of the invoice item that the discount charge is
            applied

            to.
          type: string
        chargeAmount:
          description: >
            The amount of the charge. 


            **Note**: This amount does not include taxes regardless if the
            charge's tax mode is inclusive or exclusive. This is the discount
            amount actually applied when the invoice item is a discount charge.
          format: double
          type: number
        chargeDate:
          description: >
            The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss`
            format.
          format: date-time
          type: string
        chargeName:
          description: The name of the charge.
          type: string
        chargeNumber:
          type: string
          description: |
            Number of the charge.
        commitmentChargeNumber:
          type: string
        commitmentChargeSegmentNumber:
          type: string
        description:
          description: The description of the invoice item.
          type: string
        discountAmount:
          type: number
          description: |
            The amount of the discount.
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            The flag to exclude the invoice item from revenue accounting.


            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
        fulfillmentId:
          type: string
          description: >
            The reference ID of the fulfillment associated with the invoice
            item.
        itemShipToContactId:
          type: string
          description: >
            The ID of the ship-to contact associated with the invoice item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
        itemSoldToContactId:
          type: string
          description: >
            The ID of the sold-to contact associated with the invoice item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
        itemSoldToContactSnapshotId:
          type: string
          description: >
            The ID of the sold-to contact snapshot associated with the invoice
            item.


            **Note**: If you have the Flexible Billing Attributes feature
            disabled, the value of this field is `null`.
        processingType:
          type: string
          description: |
            The kind of the charge for the invoice item. 

            - `0`: charge
            - `1`: discount
            - `2`: prepayment
            - `3`: tax
          enum:
            - '0'
            - '1'
            - '2'
            - '3'
        quantity:
          type: number
          description: |
            The quantity of this item, in the configured unit of measure for the
            charge.
        reflectDiscountInNetAmount:
          type: boolean
          default: false
          description: >
            When you apply percentage discounts to either of the following
            charges, you need to set the `reflectDiscountInNetAmount` field on
            your discount charge to `true`, to enable calculating and displaying
            the net amount of the following charges in Zuora Revenue.

            * delivery pricing charge

            * prepayment charge

            * drawdown charge


            Note the following:

            * If you are an <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> customer, when you set the
            `reflectDiscountInNetAmount` field to `true`, you must also set the
            `excludeItemBillingFromRevenueAccounting` field to `true`. 

            * If you are a <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> customer, you must
            set the `reflectDiscountInNetAmount` field to `false`, otherwise an
            error will be returned. Billing - Revenue Integration does not
            support discounts on the preceding charges.

            * If you are a Zuora Billing customer who does not enable the Order
            to Revenue or Billing - Revenue Integration feature, when you apply
            percentage discounts to the preceding charges, you also need to set
            the `reflectDiscountInNetAmount` field to `true`.  
        revRecStartDate:
          type: string
          format: date
        serviceEndDate:
          description: |
            The end date of the service period for this item, i.e., the last day
            of the service period, as _yyyy-mm-dd_.
          format: date
          type: string
        serviceStartDate:
          description: |
            The start date of the service period for this item, as _yyyy-mm-dd_.
            For a one-time fee item, the date of the charge.
          format: date
          type: string
        sKU:
          type: string
          description: |
            The SKU of the product associated with the invoice item.
        sourceItemType:
          description: |
            The type of the source item.
          enum:
            - SubscriptionComponent
            - Rounding
            - ProductRatePlanCharge
            - None
            - OrderLineItem
          type: string
        subscriptionId:
          type: string
          description: |
            ID of the subscription associated with the invoice item.
        subscriptionNumber:
          type: string
          description: |
            Number of the subscription associated with the invoice item.
        taxAmount:
          description: |
            The amount of tax applied to the charge.
          format: double
          type: number
        taxCode:
          description: >
            The tax code of the invoice item.

            **Note** Only when taxation feature is enabled, this field can be
            presented.
          type: string
        taxExemptAmount:
          type: number
        taxMode:
          description: >
            The tax mode of the invoice item, indicating whether the amount of
            the invoice item includes tax.
          enum:
            - TaxExclusive
            - TaxInclusive
          type: string
        unitPrice:
          description: >
            The per-unit price of the invoice item.


            **Note**: For discount charges, this represents the discount
            percentage (for percentage-based discounts) 
              or the discount amount (for fixed-amount discounts).
          format: double
          type: number
        uOM:
          type: string
          description: >
            The unit of measure (UOM) that is configured in **Settings >
            Billing** for the product rate plan charge.
        balance:
          type: number
          description: >
            The balance of the invoice item.


            **Note**: This field is only available if you have the Invoice
            Settlement feature enabled.
        numberOfDeliveries:
          type: number
          description: >
            The number of deliveries dedicated to the Delivery Pricing charges. 

            **Note**: This field is available only if you have the Delivery
            Pricing feature enabled. 
        accountReceivableAccountingCodeId:
          type: string
          description: >
            ID of the account receivable accounting code associated with the
            invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
        recognizedRevenueAccountingCodeId:
          type: string
          description: >
            ID of the recognized revenue accounting code associated with the
            invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
        deferredRevenueAccountingCodeId:
          description: >
            ID of the deferred revenue accounting code associated with the
            invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
          type: string
        contractAssetAccountingCodeId:
          description: >
            ID of the accounting code for contract asset. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        contractLiabilityAccountingCodeId:
          type: string
          description: >
            ID of the accounting code for contract liability. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
        contractRecognizedRevenueAccountingCodeId:
          description: >
            ID of the accounting code for contract recognized revenue. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        unbilledReceivablesAccountingCodeId:
          type: string
        adjustmentRevenueAccountingCodeId:
          description: >
            The accounting code for adjustment revenue. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        adjustmentLiabilityAccountingCodeId:
          description: >
            ID of the accounting code for adjustment liability. 
                  
            **Note**: This field is only available if you have the Billing -
            Revenue Integration feature enabled. 
          type: string
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this invoice item.
        accountId:
          type: string
          description: |
            The ID of the account associated with the invoice item.
        billToContactSnapshotId:
          description: |
            The ID of the bill-to contact snapshot associated with the invoice.
          type: string
        shipToContactSnapshotId:
          description: |
            The ID of the ship-to contact snapshot associated with the invoice.
          type: string
        soldToContactSnapshotId:
          description: |
            The ID of the sold-to contact snapshot associated with the invoice.
          type: string
        parentAccountId:
          type: string
          description: >
            The parent account of the account associated with the invoice.


            **Note**: This field is available only if you have <a

            href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Customer_Accounts/A_Customer_Account_Introduction#Customer_Hierarchy"

            target="_blank">Customer Hierarchy</a> enabled for your tenant.
        billToContactId:
          type: string
          description: |
            The ID of the bill-to contact associated with the invoice.
        shipToContactId:
          type: string
          description: |
            The ID of the ship-to contact associated with the invoice.
        soldToContactId:
          type: string
          description: |
            The ID of the sold-to contact associated with the invoice.
        defaultPaymentMethodId:
          type: string
          description: |
            The ID of the default payment method on the associated account.
        ratePlanId:
          type: string
          description: |
            The ID of the rate plan that the invoice is created from.
        amendmentId:
          type: string
          description: >
            The ID of the amendment associated with the subscription. 


            **Note**: This field is available only if you do not have Orders
            enabled for your tenant.
        productRatePlanChargeId:
          description: >
            The ID of the product rate plan charge that the invoice item is
            created from.
          type: string
        productRatePlanId:
          description: >
            The ID of the product rate plan that the invoice item is created
            from.
          type: string
        productId:
          description: |
            The ID of the product that the invoice item is created from.
          type: string
        bookingReference:
          type: string
          description: |
            The booking reference of the invoice item.
        itemType:
          type: string
          description: |
            The type of the invoice item.
        purchaseOrderNumber:
          description: |
            The purchase order number associated with the invoice item.
          type: string
        revRecCode:
          description: |
            The revenue recognition code.
          type: string
        revRecTriggerCondition:
          description: |
            The date when revenue recognition is triggered.
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          description: >
            The revenue recognition rule of the invoice item.


            **Note:** This field is only available if you have Zuora Finance
            enabled.
          type: string
        orderLineItemId:
          description: >
            The reference ID of the oder line item associated with the invoice
            item.
          type: string
        subscriptionOwnerId:
          description: |
            The ID of the subscription owner associated with the invoice item.
          type: string
        invoice:
          $ref: '#/components/schemas/NestedInvoiceOnExpand'
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        taxationItems:
          type: array
          items:
            $ref: '#/components/schemas/ExpandedTaxationItem'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        orderLineItem:
          $ref: '#/components/schemas/NestedOrderLineItemOnExpand'
        subscriptionOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Invoice Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryInvoiceItemResponse
    NestedInvoiceScheduleItemOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the invoice schedule item.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the invoice schedule
            item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice schedule item was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the invoice
            schedule item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice schedule item was last updated.
        amount:
          type: string
          format: number
          description: >
            The amount of the invoice generated during the processing of the
            invoice schedule item.


            You can only specify either the `amount` field or `percentage` field
            in one request. 


            - If you choose to specify the `amount` field in the request, `null`
            is returned as the value of the `percentage` field in the
            corresponding response. 


            - If you choose to specify the `percentage` field in the request,
            the value of the `amount` field returned in the corresponding
            response is calculated based on the percentage of the total amount.


            The value of this field keeps unchanged once invoice schedule items
            are created. 
        percentage:
          type: number
          description: >
            The percentage of the total amount to be billed during the
            processing of the invoice schedule item.


            You can only specify either the `amount` field or `percentage` field
            in one request. 


            - If you choose to specify the `amount` field in the request, `null`
            is returned as the value of the `percentage` field in the
            corresponding response. 


            - If you choose to specify the `percentage` field in the request,
            the value of the `amount` field returned in the corresponding
            response is calculated based on the percentage of the total amount.
        actualAmount:
          type: string
          format: number
          description: >
            The actual amount that needs to be billed during the processing of
            the invoice schedule item.


            By default, the actual amount is the same as the total amount. Even
            if order changes occur like Remove Product or Cancel Subscription,
            the value of the `amount` field keeps unchanged. The value of the
            `actualAmount` field reflects the actual amount to be billed.
        runDate:
          type: string
          format: date
          description: >
            The date in the tenant's time zone when the invoice schedule item is
            processed to generate an invoice.
        invoiceScheduleId:
          type: string
          description: >
            The ID of the invoice schedule that the invoice schedule item
            belongs to.
        invoiceId:
          type: string
          description: >
            The ID of the invoice that is generated during the processing of the
            invoice schedule item.
        creditMemoId:
          type: string
          description: >
            The ID of the credit memo that is generated during the processing of
            the invoice schedule item.
        status:
          type: string
          description: |
            The status of the invoice schedule item.
          enum:
            - Pending
            - Executing
            - Processed
        name:
          type: string
          maxLength: 100
          description: |
            The name of the invoice schedule item.
        sequenceNumber:
          type: string
          description: |
            The sequence number of the invoice schedule item.
        targetDateForAdditionalSubscriptions:
          type: string
          format: date
          description: >
            The date in the tenant's time zone used by the invoice schedule to
            determine which fixed-period regular charges to be billed together
            with the invoice schedule item. 


            The regular charges must come from the subscriptions specified in
            the `additionalSubscriptionsToBill` field on the associated invoice
            schedule.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Invoice Schedule Item object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryInvoiceScheduleItemResponse
    NestedInvoiceScheduleBookingOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the invoice schedule booking.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the invoice schedule
            booking.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice schedule booking was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the invoice
            schedule booking.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the invoice schedule booking was last
            updated.
        invoiceScheduleId:
          type: string
          description: >
            The ID of the invoice schedule that the invoice schedule booking
            belongs to.
        orderId:
          type: string
          description: |
            The ID of the order associated with the invoice schedule.
        orderNumber:
          type: string
          description: |
            The number of the order associated with the invoice schedule.
        subscriptionId:
          type: string
          description: >
            The ID of the subscription contained in the order associated with
            the invoice schedule.
        subscriptionNumber:
          type: string
          description: >
            The number of the subscription contained in the order associated
            with the invoice schedule.
        chargeNumbers:
          type: string
          description: >
            A list of charges in the subscription that are chosen to be included
            in the invoice schedule.
      type: object
      title: QueryInvoiceScheduleBookingResponse
    ExpandedInvoiceSchedule:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the invoice schedule.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the invoice schedule.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice schedule was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the invoice
            schedule.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the invoice schedule was last updated.
        totalAmount:
          type: number
          description: >
            The total amount that needs to be billed during the processing of
            the invoice schedule. 


            The value of this field keeps unchanged once invoice schedule items
            are created.
        actualAmount:
          type: number
          description: >
            The actual amount that needs to be billed during the processing of
            the invoice schedule.


            By default, the actual amount is the same as the total amount. Even
            if order changes occur like Remove Product or Cancel Subscription,
            the value of the `totalAmount` field keeps unchanged. The value of
            the `actualAmount` field reflects the actual amount to be billed.
        billedAmount:
          type: number
          description: >
            The amount that has been billed during the processing of the invoice
            schedule.
        unbilledAmount:
          type: number
          description: >
            The amount that is waiting to be billed during the processing of the
            invoice schedule.
        nextRunDate:
          type: string
          format: date
          description: >
            The run date of the next execution of invoice schedule. By default,
            the next run date is the same as run date of next pending invoice
            schedule item. 

            It can be overwritten with a different date other than the default
            value. When the invoice schedule has completed the execution, the
            next run date is null.
        number:
          type: string
          description: |
            The sequence number of the invoice schedule. 
        notes:
          type: string
          maxLength: 255
          description: |
            Comments on the invoice schedule.
        accountId:
          type: string
          description: |
            The ID of the customer account that the invoice schedule belongs to.
        status:
          type: string
          description: |
            The status of the invoice schedule.
          enum:
            - Pending
            - PartiallyProcessed
            - Paused
            - FullyProcessed
        additionalSubscriptionsToBill:
          type: string
          description: >
            A list of the numbers of the subscriptions that need to be billed
            together with the invoice schedule. 


            One invoice schedule can have at most 600 additional subscriptions.
        currency:
          type: string
          description: >
            The currency of the billing documents generated during the
            processing of the invoice schedule.


            **Note**: 

            - This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Leverage_advanced_capabilities/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currencies</a> feature enabled.


            - If you have the Multiple Currencies feature disabled, the
            corresponding account's default currency is always used.
        invoiceScheduleItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceScheduleItemOnExpand'
        invoiceScheduleBookings:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceScheduleBookingOnExpand'
        ratePlanCharges:
          type: array
          items:
            $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Invoice Schedule object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryInvoiceScheduleResponse
    NestedOrderActionOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the order action.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the order action.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the order action gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the order action.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the order action was last updated.
        contractEffectiveDate:
          type: string
          format: date
          description: |
            Effective contract date for this subscription, as yyyy-mm-dd.
        customerAcceptanceDate:
          type: string
          format: date
          description: >
            The date on which the services or products within a subscription
            have been accepted by the customer, as yyyy-mm-dd.
        type:
          description: >
            Type of the order action.


            **Note**: The change plan type of order action is supported for the 
            <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature. However, it is
            currently not supported for the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> feature. When
            Billing - Revenue Integration is enabled, the change plan type of
            order action will no longer be applicable in Zuora Billing.
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        sequence:
          type: integer
          format: int32
          description: |
            The sequence of the order actions processed in the order.
        subscriptionVersionAmendmentId:
          type: string
          description: >
            The unique identifier of the amendment that changes the version of
            the subscription.
        orderId:
          type: string
          description: |
            The unique identifier of the order that the order action belongs to.
        subscriptionId:
          type: string
          description: >
            The unique identifier of the subscription associated with the order
            action.
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription associated with the order action.
        serviceActivationDate:
          type: string
          format: date
          description: >
            The date on which the services or products within a subscription
            have been activated and access has been provided to the customer, as
            yyyy-mm-dd.
        autoRenew:
          type: boolean
          description: >
            If `true`, the subscription automatically renews at the end of the
            term. 
          default: false
        renewSetting:
          description: >
            Specifies whether a termed subscription will remain termed or change
            to evergreen when it is renewed.
          type: string
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the subscription renewal term. 
          default: 0
        renewalTermPeriodType:
          description: >
            The period type for the subscription renewal term.


            This field is used with the `renewalTerm` field to specify the
            subscription renewal term.
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        termStartDate:
          type: string
          format: date
          description: >
            The date on which the subscription term begins, as `yyyy-mm-dd`. If
            this is a renewal subscription, this date is different from the
            subscription start date.
        termType:
          type: string
          enum:
            - TERMED
            - EVERGREEN
          description: |
            The type of the subscription term.
        currentTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the current subscription term.
        currentTermPeriodType:
          description: |
            The period type for the current subscription term.
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        suspendDate:
          type: string
          format: date
          description: >
            The date when subscription suspension takes effect, in the
            `yyyy-mm-dd` format.
        resumeDate:
          type: string
          format: date
          description: |
            The resume date when the resumption takes effect.
        cancellationEffectiveDate:
          type: string
          format: date
          description: >
            Date when the cancellation takes effect, in the `yyyy-mm-dd` format.
            Used only if `cancellationPolicy` is `SpecificDate`. It should not
            be earlier than the subscription contract-effective date, later than
            the subscription term-end date, or within a period for which the
            customer has been invoiced.
        cancellationPolicy:
          type: string
          description: |
            Cancellation method. 
          enum:
            - EndOfCurrentTerm
            - EndOfLastInvoicePeriod
            - SpecificDate
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For

            example, `Net 30`. The payment term determines the due dates of
            invoices.



            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.
              
            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the subscription.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        clearingExistingPaymentTerm:
          default: false
          description: >
            Whether to clear the existing payment term at the subscription
            level. This field is mutually exclusive with the `paymentTerm`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingBillToContact:
          default: false
          description: >
            Whether to clear the existing bill-to contact ID at the subscription
            level. This field is mutually exclusive with the `billToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          description: >
            Whether to clear the existing invoice template ID at the
            subscription level. This field is mutually exclusive with the
            `invoiceTemplateId` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSequenceSet:
          default: false
          description: >
            Whether to clear the existing sequence set ID at the subscription
            level. This field is mutually exclusive with the `sequenceSetId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingShipToContact:
          default: false
          description: >
            Whether to clear the existing ship-to contact ID at the subscription
            level. This field is mutually exclusive with the `shipToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSoldToContact:
          default: false
          description: >
            Whether to clear the existing sold-to contact ID at the subscription
            level. This field is mutually exclusive with the `soldToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        communicationProfileId:
          description: >
            The ID of the communication profile associated with the
            subscription.


            **Note**: This field is available in the request body only if you
            have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
            target="_blank">Flexible Billing Attributes</a>
                feature turned on. The value is `null` in the response body without this feature turned on.
          type: string
          nullable: true
        clearingExistingCommunicationProfile:
          default: false
          description: >
            Whether to clear the existing communication profile at the
            subscription

            level. This field is mutually exclusive with the
            `communicationProfileId` field.
          type: boolean
        subType:
          description: >
            The sub type for the change plan order action.


            If this field was not set by user, the field is automatically
            generated by the system according to the following rules:


            When the old and new rate plans are within the same Grading catalog
            group:

            * If the grade of new plan is greater than that of the old plan,
            this is an "Upgrade".

            * If the grade of new plan is less than that of the old plan, this
            is a "Downgrade".

            * If the grade of new plan equals that of the old plan, this is a
            "Crossgrade".


            When the old and new rate plans are not in the same Grading catalog
            group, or either has no group, this is "PlanChanged".
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        effectivePolicy:
          description: |
            The default value for the `effectivePolicy` field is as follows:
              * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
              * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
              * Otherwise, the effective policy is `SpecificDate` by default.

            **Notes**: 
              * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates" target="_blank">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period.
              * When setting this field to `SpecificDate`, you must also set the `contractEffectiveDate` field.
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        subscription:
          type: object
          description: >
            The subscription associated with this order action.



            **Note**: For draft and scheduled orders, information on the
            subscription, rate plan, and rate plan charges is not available nor
            displayed until the following conditions are met:


            - A scheduled order is executed and its status is changed to
            `completed`. 

            - A draft order is activated and its status is changed to `pending`
            or `completed`.


            For example, if an order is in the `scheduled` or `draft` status,
            information on the subscription, rate plan, and rate plan charges is
            not displayed.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Order Action object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryOrderActionResponse
    NestedOrderOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the order.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the order.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the order gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the order.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the order was last updated.
        description:
          type: string
          description: |
            The description of the order.
        orderDate:
          type: string
          format: date
          description: |
            The date when the order is signed. All the order actions under this
            order will use this order date as the contract effective date if no
            additinal contractEffectiveDate is provided.
        orderNumber:
          type: string
          description: |
            The unique identifier of the order.
        accountId:
          type: string
          description: |
            The unique identifier of the customer account associated with the
            order.
        status:
          type: string
          description: >
            The status of the order. If the order contains any `Pending

            Activation` or `Pending Acceptance` subscription, the order status

            will be `Pending`; If the order is in draft status, the order status

            will be `Draft`; otherwise the order status is `Completed`.



            The available order statuses are as follow:


            - `Draft`: The order is in draft status.


            - `Pending`: The order is in pending status.


            - `Completed`: The order is in completed status.


            - `Cancelled`: The draft or scheduled order is cancelled.


            - `Scheduled`: The order is in scheduled status and it is only valid

            if the Scheduled Orders feature is enabled.


            - `Executing`: The scheduled order is executed by a scheduler and it

            is only valid if the Scheduled Orders feature is enabled.


            - `Failed`: The scheduled order has failed.



            **Note**: To manage and access the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/P_Scheduled_Orders"

            target="_blank">Scheduled Orders</a> feature from the self-service

            interface, see <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"

            target="_blank">Enable billing features by yourself</a>.
          enum:
            - Draft
            - Pending
            - Completed
            - Cancelled
            - Scheduled
            - Executing
            - Failed
        state:
          type: string
          description: >
            The state of the bill-to address. The value is a valid subregion
            (state
             or province) name or code. For more information, see <a
             href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
             target="_blank">View subregions of a specific country or region</a>.
        createdByMigration:
          type: boolean
          description: |
            Indicates whether the order is created by migration.
        category:
          type: string
        invoiceScheduleId:
          type: string
          description: |
            The unique identifier of the invoice schedule associated with the
            order.
        scheduledDate:
          type: string
          format: date
          description: |
            The date for the order scheduled.
        scheduledDatePolicy:
          description: Date policy of the scheduled order.
          enum:
            - SpecificDate
          type: string
        errorCode:
          type: string
          description: |
            The error code of the error response.
        errorMessage:
          type: string
          description: |
            The error message of the error response.
        response:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        orderLineItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderLineItemOnExpand'
        orderActions:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderActionOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Order object. Only the indexed custom fields with
          a specified value (not null) are returned. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryOrdersResponse
    ExpandedOrderAction:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the order action.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the order action.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the order action gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the order action.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the order action was last updated.
        contractEffectiveDate:
          type: string
          format: date
          description: |
            Effective contract date for this subscription, as yyyy-mm-dd.
        customerAcceptanceDate:
          type: string
          format: date
          description: >
            The date on which the services or products within a subscription
            have been accepted by the customer, as yyyy-mm-dd.
        type:
          description: >
            Type of the order action.


            **Note**: The change plan type of order action is supported for the 
            <a
            href="https://docs.zuora.com/en/zuora-billing/set-up-zuora-billing/enable-order-to-revenue/overview-of-order-to-revenue"
            target="_blank">Order to Revenue</a> feature. However, it is
            currently not supported for the <a
            href="https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration"
            target="_blank">Billing - Revenue Integration</a> feature. When
            Billing - Revenue Integration is enabled, the change plan type of
            order action will no longer be applicable in Zuora Billing.
          enum:
            - CreateSubscription
            - TermsAndConditions
            - AddProduct
            - UpdateProduct
            - RemoveProduct
            - RenewSubscription
            - CancelSubscription
            - OwnerTransfer
            - Suspend
            - Resume
            - ChangePlan
          type: string
        sequence:
          type: integer
          format: int32
          description: |
            The sequence of the order actions processed in the order.
        subscriptionVersionAmendmentId:
          type: string
          description: >
            The unique identifier of the amendment that changes the version of
            the subscription.
        orderId:
          type: string
          description: |
            The unique identifier of the order that the order action belongs to.
        subscriptionId:
          type: string
          description: >
            The unique identifier of the subscription associated with the order
            action.
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription associated with the order action.
        serviceActivationDate:
          type: string
          format: date
          description: >
            The date on which the services or products within a subscription
            have been activated and access has been provided to the customer, as
            yyyy-mm-dd.
        autoRenew:
          type: boolean
          description: >
            If `true`, the subscription automatically renews at the end of the
            term. 
          default: false
        renewSetting:
          description: >
            Specifies whether a termed subscription will remain termed or change
            to evergreen when it is renewed.
          type: string
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the subscription renewal term. 
          default: 0
        renewalTermPeriodType:
          description: >
            The period type for the subscription renewal term.


            This field is used with the `renewalTerm` field to specify the
            subscription renewal term.
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        termStartDate:
          type: string
          format: date
          description: >
            The date on which the subscription term begins, as `yyyy-mm-dd`. If
            this is a renewal subscription, this date is different from the
            subscription start date.
        termType:
          type: string
          enum:
            - TERMED
            - EVERGREEN
          description: |
            The type of the subscription term.
        currentTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the current subscription term.
        currentTermPeriodType:
          description: |
            The period type for the current subscription term.
          type: string
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        suspendDate:
          type: string
          format: date
          description: >
            The date when subscription suspension takes effect, in the
            `yyyy-mm-dd` format.
        resumeDate:
          type: string
          format: date
          description: |
            The resume date when the resumption takes effect.
        cancellationEffectiveDate:
          type: string
          format: date
          description: >
            Date when the cancellation takes effect, in the `yyyy-mm-dd` format.
            Used only if `cancellationPolicy` is `SpecificDate`. It should not
            be earlier than the subscription contract-effective date, later than
            the subscription term-end date, or within a period for which the
            customer has been invoiced.
        cancellationPolicy:
          type: string
          description: |
            Cancellation method. 
          enum:
            - EndOfCurrentTerm
            - EndOfLastInvoicePeriod
            - SpecificDate
        paymentTerm:
          description: >
            The name of the payment term associated with the subscription. For

            example, `Net 30`. The payment term determines the due dates of
            invoices.



            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        billToContactId:
          description: |
            The ID of the bill-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        invoiceTemplateId:
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.
              
            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          description: |
            The ID of the ship-to contact associated with the subscription.
          type: string
        soldToContactId:
          description: |
            The ID of the sold-to contact associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
        clearingExistingPaymentTerm:
          default: false
          description: >
            Whether to clear the existing payment term at the subscription
            level. This field is mutually exclusive with the `paymentTerm`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingBillToContact:
          default: false
          description: >
            Whether to clear the existing bill-to contact ID at the subscription
            level. This field is mutually exclusive with the `billToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingInvoiceTemplate:
          default: false
          description: >
            Whether to clear the existing invoice template ID at the
            subscription level. This field is mutually exclusive with the
            `invoiceTemplateId` field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSequenceSet:
          default: false
          description: >
            Whether to clear the existing sequence set ID at the subscription
            level. This field is mutually exclusive with the `sequenceSetId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingShipToContact:
          default: false
          description: >
            Whether to clear the existing ship-to contact ID at the subscription
            level. This field is mutually exclusive with the `shipToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        clearingExistingSoldToContact:
          default: false
          description: >
            Whether to clear the existing sold-to contact ID at the subscription
            level. This field is mutually exclusive with the `soldToContactId`
            field.


            **Note**: If you have the [Flexible Billing
            Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)
            feature disabled, this field is unavailable in the request body and
            the value of this field is `null` in the response body.
          type: boolean
        communicationProfileId:
          description: >
            The ID of the communication profile associated with the
            subscription.


            **Note**: This field is available in the request body only if you
            have the <a
            href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes"
            target="_blank">Flexible Billing Attributes</a>
                feature turned on. The value is `null` in the response body without this feature turned on.
          type: string
          nullable: true
        clearingExistingCommunicationProfile:
          default: false
          description: >
            Whether to clear the existing communication profile at the
            subscription

            level. This field is mutually exclusive with the
            `communicationProfileId` field.
          type: boolean
        subType:
          description: >
            The sub type for the change plan order action.


            If this field was not set by user, the field is automatically
            generated by the system according to the following rules:


            When the old and new rate plans are within the same Grading catalog
            group:

            * If the grade of new plan is greater than that of the old plan,
            this is an "Upgrade".

            * If the grade of new plan is less than that of the old plan, this
            is a "Downgrade".

            * If the grade of new plan equals that of the old plan, this is a
            "Crossgrade".


            When the old and new rate plans are not in the same Grading catalog
            group, or either has no group, this is "PlanChanged".
          enum:
            - Upgrade
            - Downgrade
            - Crossgrade
            - PlanChanged
          type: string
        effectivePolicy:
          description: |
            The default value for the `effectivePolicy` field is as follows:
              * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default.
              * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default.
              * Otherwise, the effective policy is `SpecificDate` by default.

            **Notes**: 
              * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/W_Subscription_and_Amendment_Dates#Billing_Trigger_Dates" target="_blank">billing trigger dates</a> for the subscription as the system will automatically set the trigger dates to the end of billing period.
              * When setting this field to `SpecificDate`, you must also set the `contractEffectiveDate` field.
          enum:
            - EffectiveImmediately
            - EffectiveEndOfBillingPeriod
            - SpecificDate
          type: string
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        order:
          $ref: '#/components/schemas/NestedOrderOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Order Action object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryOrderActionResponse
    ExpandedOrderLineItem:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the order line item.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the order line item.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the order line item gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the order line
            item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the order line item was last updated.
        accountingCode:
          type: string
          description: >
            The accountingCode for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          nullable: true
        billTargetDate:
          description: >
            The target date for the Order Line Item (OLI) to be picked up by
            bill run for generating billing documents.


            To generate billing documents for an OLI, you must set this field
            and set the `itemState` field to `SentToBilling`.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        amountPerUnit:
          type: number
          description: >
            The actual charged amount per unit for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
        description:
          description: |
            The description of the Order Line Item.
          type: string
        amount:
          type: number
          description: |
            The total amount for the Order Line Item (OLI).
        amountWithoutTax:
          type: number
          description: |
            The total amount for the Order Line Item (OLI) excluding tax.
        itemName:
          description: >
            The name of the Order Line Item (OLI).


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          type: string
        itemNumber:
          description: >
            The number for the Order Line Item (OLI).


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          type: string
        itemState:
          description: >
            The state of the Order Line Item (OLI). See [State transitions for
            an order, order line item, and
            fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States)
            for more information.


            To generate invoice for an OLI, you must set this field to
            `SentToBilling` and set the `billTargetDate` field .


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` or 'Booked' or `SentToBilling`state (when
            the `itemState` field is set as `Executing` or `SentToBilling`).
          enum:
            - Executing
            - Booked
            - SentToBilling
            - Complete
            - Cancelled
          type: string
        itemType:
          description: >
            The type of the Order Line Item (OLI). 


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          enum:
            - Product
            - Fee
            - Services
          type: string
        listPricePerUnit:
          description: >
            The list price per unit for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: number
        listPrice:
          description: >
            The extended list price for an order line item, calculated by the
            formula:

            listPrice = listPricePerUnit * quantity
          type: number
        orderId:
          type: string
          description: |
            The ID of the order that the order line item belongs to.
        productCode:
          description: >
            The product code for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        purchaseOrderNumber:
          description: >
            Used by customers to specify the Purchase Order Number provided by
            the buyer.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        quantity:
          description: >
            The quantity of units, such as the number of authors in a hosted
            wiki service.


            You can update this field for a sales or return OLI only when the
            OLI in the `Executing` state (when the `itemState` field is set as
            `Executing`).
          type: number
        revenueRecognitionRule:
          type: string
          description: |
            The Revenue Recognition rule for the Order Line Item.
        productRatePlanChargeId:
          description: >
            ID of a Product Rate Plan Charge. Only one-time charges are
            supported.
          type: string
        billToId:
          description: >
            The ID of a contact that belongs to the billing account of the order
            line item. Use this field to assign an existing account as the
            bill-to contact of an order line item.
          type: string
        billToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the bill-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `billToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        shipTo:
          description: >
            The ID of a contact that belongs to the owner acount or billing
            account of the order line item. Use this field to assign an existing
            account as the ship-to contact of an order line item.
          type: string
        shipToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the ship-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `shipToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        soldTo:
          description: >
            The ID of a contact that belongs to the owner acount or billing
            account of the order line item. Use this field to assign an existing
            account as the sold-to contact of an order line item.
          type: string
        soldToSnapshotId:
          description: >
            The snapshot of the ID for an account used as the sold-to contact of
            an order line item. This field is used to store the original
            information about the account, in case the information about the
            account is changed after the creation of the order line item. The
            `soldToSnapshotId` field is exposed while retrieving the order line
            item details.
          type: string
        soldToOrderContactId:
          type: string
          description: |
            The ID of the sold-to contact for the order.
        ownerAccountId:
          description: |
            The account ID of the owner of the order line item.
          type: string
        invoiceOwnerAccountId:
          description: |
            The account ID of the invoice owner of the order line item.
          type: string
        taxCode:
          description: >
            The tax code for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        taxMode:
          description: >
            The tax mode for the Order Line Item (OLI).


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          enum:
            - TaxInclusive
            - TaxExclusive
          type: string
        transactionDate:
          type: string
          format: date
          description: |
            The date when the transaction occurs.
        uOM:
          description: >
            Specifies the units to measure usage.


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        relatedSubscriptionNumber:
          description: >
            This field is used to relate an order line item to an subscription. 


            You can update this field only for a sales OLI and only when the
            sales OLI is in the `Executing` state (when the `itemState` field is
            set as `Executing`).
          type: string
        transactionEndDate:
          description: >
            The date a transaction is completed. The default value of this field
            is the transaction start date. Also, the value of this field should
            always equal or be later than the value of the
            `transactionStartDate` field.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        transactionStartDate:
          description: >
            The date a transaction starts. The default value of this field is
            the order date.


            You can update this field for a sales or return OLI only when the
            OLI is in the `Executing` state (when the `itemState` field is set
            as `Executing`).
          format: date
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled. 
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related rate plan charges and order
            line items from revenue accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled.
        originalOrderDate:
          type: string
          format: date
          description: |
            The date of the original sale order for a return order line item.
        amendedByOrderOn:
          type: string
          format: date
          description: |
            The date of the amended order for a return order line item.
        itemCategory:
          default: Sales
          description: >
            The category of the Order Line Item, to indicate a product sale or
            return.
          enum:
            - Sales
            - Return
          type: string
        originalOrderId:
          description: |
            The ID of the original sale order for a return order line item. 
          type: string
        originalOrderLineItemId:
          description: >
            The ID of the original sale order line item for a return order line
            item. 
          type: string
        originalOrderLineItemNumber:
          description: >
            The number of the original sale order line item for a return order
            line item. 
          type: string
        originalOrderNumber:
          description: |
            The number of the original sale order for a return order line item. 
          type: string
        quantityAvailableForReturn:
          description: |
            The quantity that can be returned for an order line item. 
          type: number
        quantityFulfilled:
          description: |
            The fulfilled quantity for an order line item.
          type: number
        quantityPendingFulfillment:
          description: |
            The quantity to fulfill for an order line item. 
          type: number
        requiresFulfillment:
          description: >
            The flag to show whether fulfillment is needed or not. It's derived
            from billing rule of the Order Line Item.
          type: boolean
        billingRule:
          description: |
            The billing rule of the Order Line Item.
          enum:
            - TriggerWithoutFulfillment
            - TriggerAsFulfillmentOccurs
          type: string
        inlineDiscountPerUnit:
          description: >
            This field is used in accordance with the `inlineDiscountType`
            field, in the following manner:

            * If the `inlineDiscountType` field is set as `Percentage`, this
            field specifies the discount percentage for each unit of the order
            line item. For exmaple, if you specify `5` in this field, the
            discount percentage is 5%.

            * If the `inlineDiscountType` field is set as `FixedAmount`, this
            field specifies the discount amount on each unit of the order line
            item. For exmaple, if you specify `10` in this field, the discount
            amount on each unit of the order line item is 10.


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          type: number
        inlineDiscountType:
          description: >
            This field is used to specify the inline discount type, which can be
            `Percentage`, `FixedAmount`, or `None`. The default value is
            `Percentage`.


            This field is used together with the `inlineDiscountPerUnit` field
            to specify inline discounts for order line items. The inline
            discount is applied to the list price of an order line item. 


            Once you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and
            `listPricePerUnit` fields, the system will automatically generate
            the `amountPerUnit` field. You shall not set the `amountPerUnit`
            field by yourself.
          enum:
            - Percentage
            - FixedAmount
            - None
          type: string
        discount:
          type: number
          description: >
            This field shows the total discount amount that is applied to an
            order line item after the `inlineDiscountType`,
            `inlineDiscountPerUnit` and `quantity` fields are set.


            The inline discount is applied to the list price of an order line
            item.
        recognizedRevenueAccountingCodeId:
          type: string
          description: |
            The recognized revenue accounting code for the Order Line Item.
        deferredRevenueAccountingCodeId:
          description: |
            The deferred revenue accounting code for the Order Line Item.
          type: string
        contractAssetAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractLiabilityAccountingCode:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        contractRecognizedRevenueAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        unbilledReceivablesAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        adjustmentRevenueAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        adjustmentLiabilityAccountingCodeId:
          description: >
            The accounting code on the Order Line Item object for customers
            using [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).
          type: string
        invoiceItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Order Line Item object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryOrderLineItemResponse
    ExpandedOrders:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the order.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the order.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the order gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the order.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the order was last updated.
        description:
          type: string
          description: |
            The description of the order.
        orderDate:
          type: string
          format: date
          description: |
            The date when the order is signed. All the order actions under this
            order will use this order date as the contract effective date if no
            additinal contractEffectiveDate is provided.
        orderNumber:
          type: string
          description: |
            The unique identifier of the order.
        accountId:
          type: string
          description: |
            The unique identifier of the customer account associated with the
            order.
        status:
          type: string
          description: >
            The status of the order. If the order contains any `Pending

            Activation` or `Pending Acceptance` subscription, the order status

            will be `Pending`; If the order is in draft status, the order status

            will be `Draft`; otherwise the order status is `Completed`.



            The available order statuses are as follow:


            - `Draft`: The order is in draft status.


            - `Pending`: The order is in pending status.


            - `Completed`: The order is in completed status.


            - `Cancelled`: The draft or scheduled order is cancelled.


            - `Scheduled`: The order is in scheduled status and it is only valid

            if the Scheduled Orders feature is enabled.


            - `Executing`: The scheduled order is executed by a scheduler and it

            is only valid if the Scheduled Orders feature is enabled.


            - `Failed`: The scheduled order has failed.



            **Note**: To manage and access the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Manage_subscription_transactions/Orders/AA_Overview_of_Orders/P_Scheduled_Orders"

            target="_blank">Scheduled Orders</a> feature from the self-service

            interface, see <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Configure_billing_settings/System_settings/Enable_billing_features_by_yourself"

            target="_blank">Enable billing features by yourself</a>.
          enum:
            - Draft
            - Pending
            - Completed
            - Cancelled
            - Scheduled
            - Executing
            - Failed
        state:
          type: string
          description: >
            The state of the bill-to address. The value is a valid subregion
            (state
             or province) name or code. For more information, see <a
             href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
             target="_blank">View subregions of a specific country or region</a>.
        createdByMigration:
          type: boolean
          description: |
            Indicates whether the order is created by migration.
        category:
          type: string
        invoiceScheduleId:
          type: string
          description: |
            The unique identifier of the invoice schedule associated with the
            order.
        scheduledDate:
          type: string
          format: date
          description: |
            The date for the order scheduled.
        scheduledDatePolicy:
          description: Date policy of the scheduled order.
          enum:
            - SpecificDate
          type: string
        errorCode:
          type: string
          description: |
            The error code of the error response.
        errorMessage:
          type: string
          description: |
            The error message of the error response.
        response:
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        orderLineItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderLineItemOnExpand'
        orderActions:
          type: array
          items:
            $ref: '#/components/schemas/NestedOrderActionOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Order object. Only the indexed custom fields with
          a specified value (not null) are returned. 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.
      type: object
      title: QueryOrdersResponse
    ExpandedPaymentApplication:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment application.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the payment
            application.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the payment application was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            application.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the payment application was last updated.
        applyAmount:
          type: number
          format: double
          description: |
            The applied amount of the payment.
        effectiveDate:
          type: string
          format: date
          description: >
            The date when the payment application takes effect, in `yyyy-mm-dd`
            format. 

            The effective date is later than or equal to the maximum effective
            date of the payment.
        paymentApplicationStatus:
          type: string
          description: |
            The status of the payment application.
          enum:
            - Processing
            - Processed
            - Cancelled
        accountId:
          type: string
          description: >
            The ID of the customer account associated with the payment
            application.
        paymentId:
          type: string
          description: |
            The unique ID of the created payment. 
          example: 4028905f5a87c0ff015a87eb6b75007f
        invoiceId:
          type: string
          description: |
            The ID of the invoice to which the payment is applied.
        applicationGroupId:
          type: string
          description: >
            The ID of the application group to which this payment application
            belongs.
        debitMemoId:
          type: string
          description: |
            The ID of the debit memo to which the payment is applied.
        billingDocumentOwnerId:
          type: string
          description: |
            The ID of the billing document owner. 
        accountReceivableAccountingCodeId:
          type: string
          description: >
            The accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
        unappliedPaymentAccountingCodeId:
          type: string
          description: |
            The accounting code for the unapplied payment.
        cashAccountingCodeId:
          type: string
          description: |
            The accounting code for cash payments.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        payment:
          $ref: '#/components/schemas/NestedPaymentOnExpand'
      type: object
      title: QueryPaymentApplicationResponse
      additionalProperties: false
    ExpandedPayment:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the payment.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the payment gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the payment.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the payment gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        accountId:
          description: |
            The ID of the customer account that the payment is for.
          type: string
        accountingCode:
          type: string
          description: |
            The accounting code for the charge. Accounting codes group
            transactions that contain similar accounting attributes.
        amount:
          description: |
            The total amount of the payment.
          format: double
          type: number
        appliedAmount:
          description: |
            The applied amount of the payment.
          format: double
          type: number
        authTransactionId:
          description: |
            The authorization transaction ID from the payment gateway.
          type: string
        appliedCreditBalanceAmount:
          type: number
          description: |
            The amount of the payment to apply to a credit balance. 
        bankIdentificationNumber:
          type: string
          description: >
            The first six or eight digits of the credit card or debit card used
            for the payment, when applicable. 

            Use this field to <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DF_Reconciling_Payments_with_Merchant_Accounts"
            target="_blank">reconcile payments between the gateway and merchant
            banks</a>.
        cancelledOn:
          type: string
          description: |
            The date when the payment was canceled.
          format: date-time
        comment:
          type: string
          description: |
            Comments about the payment.
          nullable: true
        currency:
          description: >
            When Standalone Payment is not enabled, the `currency` of the
            payment must be the same as the payment currency defined in the
            customer account settings through Zuora UI.


            When Standalone Payment is enabled and `standalone` is `true`, the
            `currency` of the standalone payment can be different from the
            payment currency defined in the customer account settings. The
            amount will not be summed up to the account balance or key metrics
            regardless of currency.
          type: string
          example: USD
        effectiveDate:
          type: string
          format: date
          description: >
            The date and time when the payment takes effect, in `yyyy-mm-dd
            hh:mm:ss` format.
        gatewayOrderId:
          description: >
            A merchant-specified natural key value that can be passed to the
            electronic payment gateway when a payment is created.
          type: string
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: >
            The message returned from the payment gateway for the payment. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: >
            The code returned from the payment gateway for the payment. This
            code is gateway-dependent.
          type: string
        gatewayState:
          description: |
            The status of the payment in the gateway; use for reconciliation. 
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        gatewayTransactionState:
          type: string
        isStandalone:
          type: boolean
          description: |
            Indicates whether the payment is a standalone payment. A standalone
            payment is a payment that is not associated with any invoice or
            subscription.
        markedForSubmissionOn:
          type: string
          format: date-time
          description: |
            The date and time when a charge was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
        paymentMethodId:
          type: string
          description: >
            The unique ID of the payment method that the customer used to make
            the payment.
        paymentMethodSnapshotId:
          type: string
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular Payment Method used in a transaction.
        paymentOptionId:
          type: string
          description: >
            ID of the paymentOption object, which describe the transactional
            level rules for processing payments. 
        paymentNumber:
          type: string
          description: |
            The unique identification number of a payment. 
          example: P-00000028.
        payoutId:
          type: string
          description: |
            The payout ID of the payment from the gateway side.
        prepayment:
          description: >
            Indicates whether the payment is used as a reserved payment. 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
        referencedPaymentID:
          type: string
          description: |
            The ID of a referenced payment. 
        referenceId:
          description: >
            The transaction ID returned by the payment gateway. Use this field
            to reconcile payments between your gateway and Zuora Payments.
          type: string
        refundAmount:
          type: number
          description: |
            The amount of the payment that is refunded.
          format: double
        secondPaymentReferenceId:
          type: string
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional transaction for the payment. Use this field to reconcile
            payments between your gateway and Zuora Payments.
        settledOn:
          type: string
          format: date-time
          description: >
            The date and time when the payment was settled in the payment
            processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by
            the Spectrum gateway only and not applicable to other gateways.
        softDescriptor:
          type: string
          description: >
            A payment gateway-specific field that maps to Zuora for the
            gateways, Orbital, Vantiv and Verifi.
        softDescriptorPhone:
          type: string
          description: >
            A payment gateway-specific field that maps to Zuora for the
            gateways, Orbital, Vantiv and Verifi.
        source:
          type: string
          description: >
            Indicates how the payment was created, whether through API,
            manually, import, or payment run.
          enum:
            - PaymentRun
            - Import
            - Manually
            - API
        sourceName:
          type: string
          description: |
            Name of the source. It can be a payment run number or a file name.
        status:
          description: |
            The status of the payment.
          enum:
            - Draft
            - Processing
            - Processed
            - Error
            - Canceled
            - Posted
          type: string
        submittedOn:
          description: >
            The date and time when the payment was submitted, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        type:
          description: |
            The type of the payment.
          enum:
            - External
            - Electronic
          type: string
        transferredToAccounting:
          description: >
            Whether the payment was transferred to an external accounting
            system. Use this field for integration with accounting systems, such
            as NetSuite. 
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        transactionSource:
          type: string
          description: >
            Payment transaction source used to differentiate the transaction
            source in Stored Credential Transaction framework.
              - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.
              - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.
              - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.
              - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.
          enum:
            - C_Unscheduled
            - M_Recurring
            - M_Unscheduled
            - M_MOTO
        unappliedAmount:
          type: number
          description: |
            The unapplied amount of the payment.
        lastEmailDateTime:
          type: string
          description: >
            The date and time when the last email was sent to the customer for
            the payment.
        gateway:
          type: string
          description: |
            Name of the gateway instance that processes the payment. 
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        paymentMethod:
          $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
        paymentApplications:
          type: array
          items:
            $ref: '#/components/schemas/ExpandedPaymentApplication'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentResponse
    ExpandedPaymentMethod:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment method.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the payment method.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the payment method gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            method.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the payment method gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        accountId:
          type: string
          description: |
            The unique identifier of the account that the payment method is
            associated with.
        achAbaCode:
          type: string
          description: >
            The nine-digit routing number or ABA number used by banks. This
            field is only required if the `type` field is set to `ACH`.
        achAccountName:
          type: string
          description: >
            The name of the account holder, which can be either a person or a
            company. This field is only required if the `type` field is set to
            `ACH`.
        achAccountNumberMask:
          description: >
            The masked bank account number associated with the ACH payment
            method. This field is only required if the `type` field is set to
            `ACH`.
          type: string
        achAccountType:
          type: string
          description: >
            The type of bank account associated with the ACH payment method.
            This field is only required if the `type` field is set to `ACH`.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify any of
            the allowed values as a dummy value, `Checking` preferably.
          enum:
            - BusinessChecking
            - Checking
            - Saving
        achAddress1:
          type: string
          description: |
            First address line for the ACH payment method.
          maxLength: 255
        achAddress2:
          type: string
          description: |
            Second address line for the ACH payment method.
          maxLength: 255
        achBankName:
          type: string
          description: >
            The name of the bank where the ACH payment account is held.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify a dummy
            value.
          maxLength: 70
        achCity:
          type: string
          description: >
            City for the ACH payment method.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          maxLength: 40
        achCountry:
          description: >
            Country for the ACH payment method. Must be a valid country name or
            abbreviation.


            See <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a> for the list of
            supported country names and abbreviations.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          type: string
        achPostalCode:
          type: string
          description: |
            Zip code or postal code for the ACH payment method.
          maxLength: 20
        achState:
          type: string
          description: >
            State for the ACH payment method. Must be a valid subregion (state
            or province) name or code. For more information, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
            target="_blank">View subregions of a specific country or region</a>.
        active:
          type: boolean
          description: >
            Indicates whether the payment method type is active. This field is
            for Zuora internal use and does not impact customer integration or
            use cases.
        isSystem:
          type: boolean
          description: >
            Indicates whether the payment method is a system-generated payment
            method. This field is for Zuora internal use and does not impact
            customer integration or use cases.
        accountVerificationService:
          description: |
            Displays the name of the service provider. For example, Plaid.
          type: string
        accountVerificationStatus:
          description: >
            Displays the status of the account.

            **Note:** 

            - `Active` - Access token is active. 

            - `Expired` - Access token has expired and must be linked again. 

            - `Expiring` - Access token will expire in few days(7 days for
            Plaid) and must be linked again

            - `Inactive` - The end customer has revoked the account pemission.
            The end customer can login again and select the same method for the
            access token to be linked again.
          enum:
            - Active
            - Expired
            - Expiring
            - Inactive
          type: string
        bankBranchCode:
          type: string
          description: |
            The branch code of the bank used for Direct Debit.  
        bankCheckDigit:
          description: >-
            The check digit in the international bank account number, which
            confirms the validity of the account. Applicable to direct debit
            payment methods.
          type: string
        bankCity:
          type: string
          description: The city of the direct debit bank.
        bankCode:
          type: string
          description: >
            The sort code or number that identifies the bank. This is also known
            as the sort code. 
        bankIdentificationNumber:
          type: string
          description: >-
            The first six or eight digits of the payment method's number, such
            as the credit card number or account number. Banks use this number
            to identify a payment method.
        bankName:
          type: string
          description: The name of the direct debit bank.
        bankPostalCode:
          type: string
          description: The zip code or postal code of the direct debit bank.
        bankStreetName:
          type: string
          description: The name of the street of the direct debit bank.
        bankStreetNumber:
          type: string
          description: The number of the direct debit bank.
        bankTransferAccountName:
          type: string
          description: The name on the direct debit bank account.
        bankTransferAccountNumberMask:
          type: string
          description: >
            This is a masked displayable version of the bank account number,
            used for

            security purposes. For example: `XXXXXXXXX54321`.
        bankTransferAccountType:
          type: string
          description: |
            The type of the customer's bank account. Applicable to direct debit
            payment methods.
        bankTransferType:
          description: >
            Specifies the type of direct debit transfer. The value of this field
            is dependent on the country of the user.


            Possible Values: 



            * `AutomatischIncasso` (NL)


            * `LastschriftDE` (Germany)


            * `LastschriftAT` (Austria)


            * `DemandeDePrelevement` (FR)


            * `DirectDebitUK` (UK)


            * `Domicil` (Belgium)


            * `LastschriftCH` (CH)


            * `RID` (Italy)


            * `OrdenDeDomiciliacion` (Spain)

            * `Autogiro` (Sweden)

            * `Betalingsservice` (Denmark)
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        businessIdentificationCode:
          type: string
          description: >
            The business identification code for Swiss direct payment methods
            that use

            the Global Collect payment gateway. Only applicable to direct debit

            payment methods in Switzerland with Global Collect.
        city:
          description: >
            The city of the customer's address. Applicable to debit payment
            methods.
          type: string
        country:
          type: string
          description: >-
            The two-letter country code of the customer's address. Applicable to
            direct debit payment methods.
        creditCardAddress1:
          type: string
          description: |
            The first line of the card holder's address, which is often a street
            address or business name. Applicable to credit card and direct debit
            payment methods.
        creditCardAddress2:
          type: string
          description: >
            The second line of the card holder's address. Applicable to credit
            card

            and direct debit payment methods.
        creditCardCity:
          type: string
          description: |
            The city of the card holder's address. Applicable to credit card and
            direct debit payment methods.
        creditCardCountry:
          description: >
            The country where the credit card holder stays.


            When creating a payment method through a translated UI or Payment
            Page, a country name in a translated language might be selected. 

            Regardless of the country texts selected when creating the payment
            method, only the supported country name returns in this field. 

            For a complete list of supported country names, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a>. 

            Internationalization is not supported for the API field value.
          type: string
        creditCardExpirationMonth:
          type: integer
          format: int32
          description: |
            One or two digits expiration month.
          minimum: 1
          maximum: 12
        creditCardExpirationYear:
          type: integer
          format: int32
          description: |
            Four-digit expiration year.
        creditCardHolderName:
          type: string
          description: |
            The full name of the credit card holder.
        creditCardMaskNumber:
          description: |
            The masked credit card number, such as `*********1112`.
          type: string
        creditCardPostalCode:
          type: string
          description: |
            The postal code for the address of the credit card holder.
        creditCardState:
          type: string
          description: |
            The state where the credit card holder stays.
        creditCardType:
          description: >
            The type of the credit card or debit card.


            Possible values include `Visa`, `MasterCard`, `AmericanExpress`,
            `Discover`, `JCB`, and `Diners`. For more information about credit
            card types supported by different payment gateways, see [Supported
            Payment
            Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).


            **Note:** This field is only returned for the Credit Card and Debit
            Card payment types.
          type: string
        deviceSessionId:
          description: >
            The session ID of the user when the `PaymentMethod` was created or
            updated.
          type: string
        existingMandate:
          description: |
            Indicates whether the mandate is an existing mandate.
          enum:
            - 'Yes'
            - 'No'
          type: string
        email:
          description: |
            The email address of the payment method holder.
          type: string
        firstName:
          type: string
          description: >
            The customer's first name. Only applicable to direct debit payment
            methods.
        iBAN:
          type: string
          description: >
            The International Bank Account Number used to create the SEPA
            payment method. The value is masked.
        iPAddress:
          type: string
          description: >
            The IP address of the user when the payment method was created or
            updated.
        identityNumber:
          type: string
          description: |
            The identity number of the account holder or the cardholder.
        companyName:
          type: string
          description: |
            The name of the company.
        isCompany:
          type: boolean
          description: |
            Whether the customer account is a company.
        lastFailedSaleTransactionDate:
          type: string
          format: date
          description: >
            The date of the last failed attempt to collect payment with this
            payment

            method.
        lastName:
          type: string
          description: >
            The customer's last name. Only applicable to direct debit payment
            methods.
        lastTransactionDateTime:
          type: string
          description: |
            The date and time of the most recent transaction.
          format: date-time
        lastTransactionStatus:
          type: string
          description: The status of the most recent transaction.
        mandateCreationDate:
          description: |
            The date on which the mandate was created.
          format: date
          type: string
        mandateId:
          description: |
            The mandate ID.
          type: string
        mandateReason:
          description: |
            The reason of the mandate from the gateway side.
          type: string
        mandateReceived:
          type: string
          description: |
            Indicates whether the mandate is received from the gateway.
          enum:
            - 'Yes'
            - 'No'
        mandateStatus:
          type: string
          description: |
            The status of the mandate from the gateway side.
        mandateUpdateDate:
          type: string
          format: date
          description: |
            The date on which the mandate was updated.
        maxConsecutivePaymentFailures:
          type: integer
          format: int32
          description: >
            The number of allowable consecutive failures Zuora attempts with the
            payment method before stopping.
        name:
          type: string
          description: |
            The name of the payment method.
        numConsecutiveFailures:
          type: integer
          format: int32
          description: >
            The number of consecutive failed payments for this payment method.
            It is reset to `0` upon successful payment. 
        paymentMethodStatus:
          type: string
          description: |
            The status of the payment method.
          enum:
            - Active
            - Closed
            - Scrubbed
        paymentRetryWindow:
          type: integer
          format: int32
          description: >
            The retry interval setting, which prevents making a payment attempt
            if the last failed attempt was within the last specified number of
            hours.
        paypalBaid:
          type: string
          description: |
            ID of a PayPal billing agreement. 
          example: I-1TJ3GAGG82Y9
        paypalEmail:
          type: string
          description: |
            Email address associated with the PayPal payment method. 
        paypalPreapprovalKey:
          type: string
          description: |
            The PayPal preapproval key.
        paypalType:
          type: string
          description: |
            The type of the PayPal payment method.
        phone:
          type: string
          description: >
            The phone number that the account holder registered with the bank.
            This

            field is used for credit card validation when passing to a gateway.
        postalCode:
          type: string
          description: >
            The zip code of the customer's address. Only applicable to direct
            debit

            payment methods.
        secondTokenId:
          description: >
            A gateway unique identifier that replaces sensitive payment method
            data.


            **Note:** This field is only returned for the Credit Card Reference
            Transaction payment type.
          type: string
        state:
          type: string
          description: |
            The state of the customer's address. Only applicable to direct debit
            payment methods.
        streetName:
          type: string
          description: >
            The street name of the customer's address. Only applicable to direct
            debit

            payment methods.
        streetNumber:
          type: string
          description: >
            The street number of the customer's address. Only applicable to
            direct

            debit payment methods.
        tokenId:
          type: string
          description: >
            A gateway unique identifier that replaces sensitive payment method
            data or

            represents a gateway's unique customer profile. Applicable to CC
            Reference

            Transaction payment methods.
        totalNumberOfErrorPayments:
          type: integer
          format: int32
          description: The number of error payments that used this payment method.
        totalNumberOfProcessedPayments:
          type: integer
          format: int32
          description: The number of successful payments that used this payment method.
        type:
          type: string
          description: |
            The type of the payment method. For example, `CreditCard`.
        useDefaultRetryRule:
          type: boolean
          description: >
            Indicates whether this payment method uses the default retry rules
            configured in the Zuora Payments settings.
        methodReferenceId:
          type: string
          description: >
            The identification reference of the custom payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Payment Method Data Source Exports and Data Query.
        userReferenceId:
          type: string
          description: >
            The identification reference of the user or customer account.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
        subType:
          type: string
          description: >
            The identification reference indicating the subtype of the custom
            payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
        methodSpecificData:
          type: string
          description: |
            Other method-specific data of the payment method.
        cardBrand:
          description: |
            The card brand, such as `Visa` and `MasterCard`.
          type: string
        cardClass:
          description: |
            The type of the card.
          type: string
          enum:
            - ChargeCard
            - Credit
            - Debit
            - DeferredDebit
            - Prepaid
        cardIssuingBank:
          type: string
          description: |
            The issuer bank of the card, such as `JPMORGAN CHASE BANK N.A.`.
        cardIssuingCountry:
          type: string
          description: |
            The issuing country code of the card, such as `US`.
        cardProductType:
          type: string
          description: |
            The product type of the card.
          enum:
            - Commercial_or_Corporate_Card
            - Consumer_Card
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment Method object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentMethodResponse
    ExpandedPaymentMethodSnapshot:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment method snapshot.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the payment method
            snapshot.
        createdDate:
          type: string
          format: date-time
          description: >
            The time that the payment method snapshot gets created in the
            system, in the

            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            method snapshot.
        updatedDate:
          type: string
          format: date-time
          description: >
            The time that the payment method snapshot gets updated in the
            system, in the

            `YYYY-MM-DD HH:MM:SS` format.
        accountId:
          type: string
          description: >
            The unique identifier of the account that the payment method
            snapshot is

            associated with.
        achAbaCode:
          type: string
          description: >
            The nine-digit routing number or ABA number used by banks. This
            field is only required if the `type` field is set to `ACH`.
        achAccountName:
          type: string
          description: >
            The name of the account holder, which can be either a person or a
            company. This field is only required if the `type` field is set to
            `ACH`.
        achAccountNumberMask:
          description: >
            The masked bank account number associated with the ACH payment
            method. This field is only required if the `type` field is set to
            `ACH`.
          type: string
        achAccountType:
          type: string
          description: >
            The type of bank account associated with the ACH payment method.
            This field is only required if the `type` field is set to `ACH`.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify any of
            the allowed values as a dummy value, `Checking` preferably.
          enum:
            - BusinessChecking
            - Checking
            - Saving
        achAddress1:
          type: string
          description: |
            First address line for the ACH payment method.
          maxLength: 255
        achAddress2:
          type: string
          description: |
            Second address line for the ACH payment method.
          maxLength: 255
        achBankName:
          type: string
          description: >
            The name of the bank where the ACH payment account is held.


            When creating an ACH payment method on Adyen, this field is required
            by Zuora but it is not required by Adyen. To create the ACH payment
            method successfully, specify a real value for this field if you can.
            If it is not possible to get the real value for it, specify a dummy
            value.
          maxLength: 70
        achCity:
          type: string
          description: >
            City for the ACH payment method.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          maxLength: 40
        achCountry:
          description: >
            Country for the ACH payment method. Must be a valid country name or
            abbreviation.


            See <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a> for the list of
            supported country names and abbreviations.


            It is recommended to provide the city and country information when
            creating a payment method. The information will be used to process
            payments. If the information is not provided during payment method
            creation, the city and country data will be missing during payment
            processing.
          type: string
        achPostalCode:
          type: string
          description: |
            Zip code or postal code for the ACH payment method.
          maxLength: 20
        achState:
          type: string
          description: >
            State for the ACH payment method. Must be a valid subregion (state
            or province) name or code. For more information, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_subregions_of_a_specific_country_or_region"
            target="_blank">View subregions of a specific country or region</a>.
        active:
          type: boolean
          description: >
            Indicates whether the payment method type is active. This field is
            for Zuora internal use and does not impact customer integration or
            use cases.
        isSystem:
          type: boolean
          description: >
            Indicates whether the payment method is a system-generated payment
            method. This field is for Zuora internal use and does not impact
            customer integration or use cases.
        bankBranchCode:
          type: string
          description: |
            The branch code of the bank used for Direct Debit.  
        bankCheckDigit:
          description: >-
            The check digit in the international bank account number, which
            confirms the validity of the account. Applicable to direct debit
            payment methods.
          type: string
        bankCity:
          type: string
          description: The city of the direct debit bank.
        bankCode:
          type: string
          description: >
            The sort code or number that identifies the bank. This is also known
            as the sort code. 
        bankIdentificationNumber:
          type: string
          description: >-
            The first six or eight digits of the payment method's number, such
            as the credit card number or account number. Banks use this number
            to identify a payment method.
        bankName:
          type: string
          description: The name of the direct debit bank.
        bankPostalCode:
          type: string
          description: The zip code or postal code of the direct debit bank.
        bankStreetName:
          type: string
          description: The name of the street of the direct debit bank.
        bankStreetNumber:
          type: string
          description: The number of the direct debit bank.
        bankTransferAccountName:
          type: string
          description: The name on the direct debit bank account.
        bankTransferAccountNumberMask:
          type: string
          description: >
            This is a masked displayable version of the bank account number,
            used for

            security purposes. For example: `XXXXXXXXX54321`.
        bankTransferAccountType:
          type: string
          description: |
            The type of the customer's bank account. Applicable to direct debit
            payment methods.
        bankTransferType:
          description: >
            Specifies the type of direct debit transfer. The value of this field
            is dependent on the country of the user.


            Possible Values: 



            * `AutomatischIncasso` (NL)


            * `LastschriftDE` (Germany)


            * `LastschriftAT` (Austria)


            * `DemandeDePrelevement` (FR)


            * `DirectDebitUK` (UK)


            * `Domicil` (Belgium)


            * `LastschriftCH` (CH)


            * `RID` (Italy)


            * `OrdenDeDomiciliacion` (Spain)

            * `Autogiro` (Sweden)

            * `Betalingsservice` (Denmark)
          enum:
            - AutomatischIncasso
            - LastschriftDE
            - LastschriftAT
            - DemandeDePrelevement
            - DirectDebitUK
            - Domicil
            - LastschriftCH
            - RID
            - OrdenDeDomiciliacion
            - Autogiro
            - Betalingsservice
          type: string
        businessIdentificationCode:
          type: string
          description: >
            The business identification code for Swiss direct payment methods
            that use

            the Global Collect payment gateway. Only applicable to direct debit

            payment methods in Switzerland with Global Collect.
        city:
          description: >
            The city of the customer's address. Applicable to debit payment
            methods.
          type: string
        country:
          type: string
          description: >-
            The two-letter country code of the customer's address. Applicable to
            direct debit payment methods.
        creditCardAddress1:
          type: string
          description: |
            The first line of the card holder's address, which is often a street
            address or business name. Applicable to credit card and direct debit
            payment methods.
        creditCardAddress2:
          type: string
          description: >
            The second line of the card holder's address. Applicable to credit
            card

            and direct debit payment methods.
        creditCardCity:
          type: string
          description: |
            The city of the card holder's address. Applicable to credit card and
            direct debit payment methods.
        creditCardCountry:
          description: >
            The country where the credit card holder stays.


            When creating a payment method through a translated UI or Payment
            Page, a country name in a translated language might be selected. 

            Regardless of the country texts selected when creating the payment
            method, only the supported country name returns in this field. 

            For a complete list of supported country names, see <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/A_Manage_countries_and_regions#View_countries_or_regions"
            target="_blank">View countries or regions</a>. 

            Internationalization is not supported for the API field value.
          type: string
        creditCardExpirationMonth:
          type: integer
          format: int32
          description: |
            One or two digits expiration month.
          minimum: 1
          maximum: 12
        creditCardExpirationYear:
          type: integer
          format: int32
          description: |
            Four-digit expiration year.
        creditCardHolderName:
          type: string
          description: |
            The full name of the credit card holder.
        creditCardMaskNumber:
          description: |
            The masked credit card number, such as `*********1112`.
          type: string
        creditCardPostalCode:
          type: string
          description: |
            The postal code for the address of the credit card holder.
        creditCardState:
          type: string
          description: |
            The state where the credit card holder stays.
        creditCardType:
          description: >
            The type of the credit card or debit card.


            Possible values include `Visa`, `MasterCard`, `AmericanExpress`,
            `Discover`, `JCB`, and `Diners`. For more information about credit
            card types supported by different payment gateways, see [Supported
            Payment
            Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways).


            **Note:** This field is only returned for the Credit Card and Debit
            Card payment types.
          type: string
        deviceSessionId:
          description: >
            The session ID of the user when the `PaymentMethod` was created or
            updated.
          type: string
        existingMandate:
          description: |
            Indicates whether the mandate is an existing mandate.
          enum:
            - 'Yes'
            - 'No'
          type: string
        email:
          description: |
            The email address of the payment method holder.
          type: string
        firstName:
          type: string
          description: >
            The customer's first name. Only applicable to direct debit payment
            methods.
        iBAN:
          type: string
          description: >
            The International Bank Account Number used to create the SEPA
            payment method. The value is masked.
        iPAddress:
          type: string
          description: >
            The IP address of the user when the payment method was created or
            updated.
        identityNumber:
          type: string
          description: |
            The identity number of the account holder or the cardholder.
        companyName:
          type: string
          description: |
            The name of the company.
        isCompany:
          type: boolean
          description: |
            Whether the customer account is a company.
        lastFailedSaleTransactionDate:
          type: string
          format: date
          description: >
            The date of the last failed attempt to collect payment with this
            payment

            method.
        lastName:
          type: string
          description: >
            The customer's last name. Only applicable to direct debit payment
            methods.
        lastTransactionDateTime:
          type: string
          description: |
            The date and time of the most recent transaction.
          format: date-time
        lastTransactionStatus:
          type: string
          description: The status of the most recent transaction.
        mandateCreationDate:
          description: |
            The date on which the mandate was created.
          format: date
          type: string
        mandateId:
          description: |
            The mandate ID.
          type: string
        mandateReason:
          description: |
            The reason of the mandate from the gateway side.
          type: string
        mandateReceived:
          type: string
          description: |
            Indicates whether the mandate is received from the gateway.
          enum:
            - 'Yes'
            - 'No'
        mandateStatus:
          type: string
          description: |
            The status of the mandate from the gateway side.
        mandateUpdateDate:
          type: string
          format: date
          description: |
            The date on which the mandate was updated.
        maxConsecutivePaymentFailures:
          type: integer
          format: int32
          description: >
            The number of allowable consecutive failures Zuora attempts with the
            payment method before stopping.
        paymentMethodId:
          type: string
          description: |
            ID of the associated payment method.
        name:
          type: string
          description: |
            The name of the payment method.
        numConsecutiveFailures:
          type: integer
          format: int32
          description: >
            The number of consecutive failed payments for this payment method.
            It is reset to `0` upon successful payment. 
        paymentMethodStatus:
          type: string
          description: |
            The status of the payment method.
          enum:
            - Active
            - Closed
            - Scrubbed
        paymentRetryWindow:
          type: integer
          format: int32
          description: >
            The retry interval setting, which prevents making a payment attempt
            if the last failed attempt was within the last specified number of
            hours.
        paypalBaid:
          type: string
          description: |
            ID of a PayPal billing agreement. 
          example: I-1TJ3GAGG82Y9
        paypalEmail:
          type: string
          description: |
            Email address associated with the PayPal payment method. 
        paypalPreapprovalKey:
          type: string
          description: |
            The PayPal preapproval key.
        paypalType:
          type: string
          description: |
            The type of the PayPal payment method.
        phone:
          type: string
          description: >
            The phone number that the account holder registered with the bank.
            This

            field is used for credit card validation when passing to a gateway.
        postalCode:
          type: string
          description: >
            The zip code of the customer's address. Only applicable to direct
            debit

            payment methods.
        secondTokenId:
          description: >
            A gateway unique identifier that replaces sensitive payment method
            data.


            **Note:** This field is only returned for the Credit Card Reference
            Transaction payment type.
          type: string
        state:
          type: string
          description: |
            The state of the customer's address. Only applicable to direct debit
            payment methods.
        streetName:
          type: string
          description: >
            The street name of the customer's address. Only applicable to direct
            debit

            payment methods.
        streetNumber:
          type: string
          description: >
            The street number of the customer's address. Only applicable to
            direct

            debit payment methods.
        tokenId:
          type: string
          description: >
            A gateway unique identifier that replaces sensitive payment method
            data or

            represents a gateway's unique customer profile. Applicable to CC
            Reference

            Transaction payment methods.
        totalNumberOfErrorPayments:
          type: integer
          format: int32
          description: The number of error payments that used this payment method.
        totalNumberOfProcessedPayments:
          type: integer
          format: int32
          description: The number of successful payments that used this payment method.
        type:
          type: string
          description: |
            The type of the payment method. For example, `CreditCard`.
        useDefaultRetryRule:
          type: boolean
          description: >
            Indicates whether this payment method uses the default retry rules
            configured in the Zuora Payments settings.
        methodReferenceId:
          type: string
          description: >
            The identification reference of the custom payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Payment Method Data Source Exports and Data Query.
        userReferenceId:
          type: string
          description: >
            The identification reference of the user or customer account.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
        subType:
          type: string
          description: >
            The identification reference indicating the subtype of the custom
            payment method.


            This field should be mapped to a field name defined in the `fields`
            array for the purpose of being used as a filter in reporting tools
            such as Data Source Exports and Data Query.
        methodSpecificData:
          type: string
          description: |
            Other method-specific data of the payment method.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment Method Snapshot object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentMethodSnapshotResponse
    ExpandedPaymentRun:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment run.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the payment run.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the payment run gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the payment run.
        updatedDate:
          type: string
          format: date-time
          description: |
            The time that the payment run gets updated in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        endDate:
          type: string
          description: |
            The end date of the payment run.
        executedDate:
          type: string
          format: date-time
          description: |
            The date and time when the payment run is executed, in `yyyy-mm-dd
            hh:mm:ss` format. For example, 2024-03-01 11:30:37.
        numberOfCreditBalanceAdjustments:
          type: integer
          format: int32
          description: >
            **Note:** This field is only available if you have the Credit
            Balance

            feature enabled.



            The number of credit balance adjustments that are successfully
            processed

            in the payment run.
        numberOfErrors:
          format: int32
          description: |
            The number of payments with the status of `Error` and `Processing`.
          type: integer
        numberOfInvoices:
          type: integer
          format: int32
          description: >
            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.


            The total number of invoices that are picked up for processing in
            the payment run.
        numberOfPayments:
          type: integer
          format: int32
          description: >
            The number of payments that are successfully processed in the
            payment run.
        numberOfUnprocessed:
          type: integer
          format: int32
          description: >
            The number of billing documents with remaining positive balances
            after the

            payment run is completed.
        paymentRunNumber:
          type: string
          description: |
            Number of the payment run.
        status:
          description: |
            The status of the created payment run.
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Canceled
          type: string
        targetDate:
          type: string
          format: date
          description: >
            The target date used to determine which receivables to be collected
            in the

            payment run. 
        applyCreditBalance:
          description: >
            Whether to apply credit balances in the payment run. This field is
            only

            available when you have Invoice Settlement feature disabled.
          type: boolean
        consolidatedPayment:
          type: boolean
          description: >
            **Note:** The **Process Electronic Payment** permission also needs
            to be allowed for a Manage Payment Runs role to work. See [Payments
            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)
            for more information. 


            Whether to process a single payment for all receivables that are due
            on an account.
        processPaymentWithClosedPM:
          description: >
            Whether to process payments even if the default payment method is
            closed.



            **Note:** The **Process Electronic Payment** permission also needs
            to be

            allowed for a Manage Payment Runs role to work. See [Payments

            Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/e_Payments_Roles)

            for more information. 
          type: boolean
        collectPayment:
          description: >
            Whether to process electronic payments during the execution of
            payment

            runs. 
          type: boolean
        autoApplyCreditMemo:
          description: >
            Whether to automatically apply a posted credit memo to one or more

            receivables in the payment run.



            **Note:** This field is only available if you have [Invoice

            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)

            enabled. The Invoice Settlement feature is generally available as of
            Zuora

            Billing Release 296 (March 2021). This feature includes Unapplied

            Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
            want

            to enable Invoice Settlement, see [Invoice Settlement Enablement and

            Checklist

            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)

            for more information.
          type: boolean
        autoApplyUnappliedPayment:
          description: >
            Whether to automatically apply unapplied payments to  one or more

            receivables in the payment run.



            **Note:** This field is only available if you have [Invoice

            Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)

            enabled. The Invoice Settlement feature is generally available as of
            Zuora

            Billing Release 296 (March 2021). This feature includes Unapplied

            Payments, Credit and Debit Memo, and Invoice Item Settlement. If you
            want

            to enable Invoice Settlement, see [Invoice Settlement Enablement and

            Checklist

            Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)

            for more information.
          type: boolean
        numberOfCreditMemos:
          type: integer
          format: int32
          description: >
            The total number of credit memos that are successfully processed in
            the

            payment run.



            **Note:** This field is only available if you have the Invoice
            Settlement

            feature enabled.
        numberOfDebitMemos:
          type: integer
          format: int32
          description: >
            The total number of debit memos that are picked up for processing in
            the payment run.


            **Note:** This field is only available if you have the Invoice
            Settlement feature enabled.
        numberOfDebitMemosUnprocessed:
          type: integer
          format: int32
          description: >
            The total number of debit memos that are not processed in the
            payment run.



            **Note:** This field is only available if you have the Invoice
            Settlement

            feature enabled.
        numberofUnappliedPayments:
          type: integer
          format: int32
          description: >
            The number of unapplied payments that are successfully processed in
            the

            payment run.



            **Note:** This field is only available if you have the Invoice
            Settlement

            feature enabled.
        totalExecutionTime:
          type: integer
          format: int64
          description: |
            The total time taken to execute the payment run in milliseconds.
        errorMessage:
          type: string
          description: |
            The detailed information of the error response.
        runDate:
          type: string
          format: date
          description: >
            The date and time when the scheduled payment run is to be executed
            for

            collecting payments.
        nextRunOn:
          type: string
          format: date
          description: |
            The date when the next payment run is scheduled to run.
        repeatType:
          type: string
          description: |
            The repeat type of the payment run.
          enum:
            - None
            - Daily
            - Weekly
            - Monthly
        repeatFrom:
          type: string
          description: |
            The start date of the scheduled payment run.
        repeatTo:
          type: string
          description: |
            The end date of of the scheduled payment run.
        runTime:
          type: integer
          format: int32
          description: |
            The scheduled run time (hour) of day.
          minimum: 0
          maximum: 23
        timeZone:
          type: string
          description: |
            Timezone of the scheduled payment run.
        monthlyOnDay:
          type: string
          description: |
            The repeat day in a month.
        weeklyOnDay:
          type: string
          description: |
            The repeat day in a week. 

            This field is required if you set `repeatType` field to `Weekly`.
          enum:
            - Mon
            - Tue
            - Wed
            - Thu
            - Fri
            - Sat
            - Sun
        accountId:
          description: |
            The ID of the customer account associated with the payment run.
          type: string
        batch:
          type: string
          description: |
            The alias name given to a batch.
          example: Batch1
        billingCycleDay:
          description: |
            The billing cycle day (BCD), the day of the month when a bill run
            generates invoices for the account. 
          example: 1
          type: string
        currency:
          description: |
            A currency defined in the web-based UI administrative settings.
          example: USD
          type: string
        paymentGatewayId:
          type: string
          description: |
            The ID of the gateway instance that processes the payment.
          format: uuid
          nullable: true
        billingRunId:
          type: string
          description: |
            The unique identifier of the billing run that the payment run is
            associated with.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment Run object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentRunResponse
    ExpandedPaymentSchedule:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment schedule.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the payment schedule.
        createdDate:
          type: string
          format: date-time
          description: >
            The time that the payment schedule gets created in the system, in
            the

            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            schedule.
        updatedDate:
          type: string
          format: date-time
          description: >
            The time that the payment schedule gets updated in the system, in
            the

            `YYYY-MM-DD HH:MM:SS` format.
        number:
          type: string
          description: |
            Number of the payment schedule.
        accountId:
          type: string
          description: |
            ID of the account that owns the payment schedule.
        invoiceId:
          type: string
          description: >
            The unique identifier of the invoice to which the payment is
            applied.
        debitmemoId:
          type: string
          description: >
            The unique identifier of the debit memo to which the payment is
            applied.
        paymentOptionId:
          type: string
          description: |
            The unique identifier of the payment option that is used to process
            the payment schedule.
        startDate:
          type: string
          format: date
          description: |
            The date when the first payment of this payment schedule is
            proccessed.
        runHour:
          type: integer
          format: int32
          description: |
            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.
          minimum: 0
          maximum: 23
        period:
          type: string
          description: >
            For recurring payment schedule only. The period of payment
            generation.


            Returns `null` for custom payment schedules.
          nullable: true
          enum:
            - Monthly
            - Weekly
            - BiWeekly
            - null
        prepayment:
          type: boolean
          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.
        occurrences:
          type: integer
          format: int32
          description: >
            The number of payment schedule items that are created by this
            payment schedule.
        status:
          type: string
          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
        description:
          type: string
          description: |
            The description of the payment schedule.
        nextPaymentDate:
          type: string
          format: date
          description: |
            The date the next payment will be processed.
        recentPaymentDate:
          type: string
          format: date
          description: |
            The date the last payment was processed.
        totalPaymentsProcessed:
          type: integer
          format: int32
          description: |
            The number of processed payments.
        totalPaymentsErrored:
          type: integer
          format: int32
          description: |
            The number of errored payments.
        totalAmount:
          description: |
            The total amount that will be collected by the payment
            schedule.            
          type: number
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment Schedule object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentScheduleResponse
    ExpandedPaymentScheduleItem:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the payment schedule item.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the payment schedule
            item.
        createdDate:
          type: string
          format: date-time
          description: >
            The time that the payment schedule item gets created in the system,
            in the

            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            schedule item.
        updatedDate:
          type: string
          format: date-time
          description: >
            The time that the payment schedule item gets updated in the system,
            in the

            `YYYY-MM-DD HH:MM:SS` format.
        number:
          type: string
          description: |
            Number of the payment schedule item.
        accountId:
          type: string
          description: |
            ID of the account that owns the payment schedule.
        invoiceId:
          type: string
          description: >
            The unique identifier of the invoice to which the payment is
            applied.
        debitmemoId:
          type: string
          description: >
            The unique identifier of the debit memo to which the payment is
            applied.
        paymentOptionId:
          type: string
          description: |
            The unique identifier of the payment option that is used to process
            the payment schedule item.
        prepayment:
          type: boolean
          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.
        scheduledDate:
          type: string
          format: date
          description: |
            The scheduled date when the payment is processed.
        runHour:
          type: integer
          format: int32
          description: |
            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.
          minimum: 0
          maximum: 23
        paymentMethodId:
          type: string
          description: |
            ID of the payment method that will pay the billing documents.
        paymentGatewayId:
          type: string
          nullable: true
          description: |
            ID of the payment gateway that processes the payment.
        amount:
          type: number
          description: |
            The total amount of the payment schedule item.
        balance:
          type: number
          description: |
            The remaining balance of payment schedule item.
        currency:
          type: string
          description: >
            The currency in which the payment is made.


            Note: If this field was not specified, the default value is the
            currency set for the account.
        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
        errorMessage:
          type: string
          description: |
            The error message indicating if the error is related to the
            configuration or the payment collection.
        paymentId:
          type: string
          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`.
        description:
          type: string
          description: |
            The description of the payment schedule item.
        cancellationReason:
          type: string
          description: |
            The reason for the cancellation of payment schedule item.  
        paymentScheduleId:
          type: string
          description: >
            ID of the payment schedule to which the payment schedule item
            belongs.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Payment Schedule Item object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPaymentScheduleItemResponse
    ExpandedPrepaidBalance:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the prepaid balance.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the payment
            application.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the payment application was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            application.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the payment application was last updated.
        name:
          type: string
          description: |
            The name of the prepaid balance.
        totalFund:
          type: number
          description: |
            The total amount of all prepaid balance funds.
        balance:
          type: number
          description: |
            The current prepaid balance.
        endDate:
          description: End date of the validity period.
          format: date
          type: string
        startDate:
          description: Start date of the validity period.
          format: date
          type: string
        accountId:
          type: string
          description: |
            The ID of the customer account to which the prepaid balance belongs.
        origSubscriptionId:
          type: string
          description: |
            If it belongs to a subscription, the original subscription ID.
        uOM:
          description: |
            The units of measure for prepayment charge. Units of measure
            are configured in the web-based UI. Your values depend on your
            configuration in **Billing Settings**.

            **Values**: a valid unit of measure
          type: string
        prepaidBalanceState:
          type: string
          description: |
            The state of the prepaid balance. 
          enum:
            - ACTIVE
            - EXPIRED
        prepaidType:
          type: integer
          format: int32
          description: |
            The type of the prepaid balance.
          nullable: true
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        origSubscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Prepaid Balance object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPrepaidBalanceResponse
    NestedPrepaidBalanceOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the prepaid balance.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the payment
            application.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the payment application was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the payment
            application.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the payment application was last updated.
        name:
          type: string
          description: |
            The name of the prepaid balance.
        totalFund:
          type: number
          description: |
            The total amount of all prepaid balance funds.
        balance:
          type: number
          description: |
            The current prepaid balance.
        endDate:
          description: End date of the validity period.
          format: date
          type: string
        startDate:
          description: Start date of the validity period.
          format: date
          type: string
        accountId:
          type: string
          description: |
            The ID of the customer account to which the prepaid balance belongs.
        origSubscriptionId:
          type: string
          description: |
            If it belongs to a subscription, the original subscription ID.
        uOM:
          description: |
            The units of measure for prepayment charge. Units of measure
            are configured in the web-based UI. Your values depend on your
            configuration in **Billing Settings**.

            **Values**: a valid unit of measure
          type: string
        prepaidBalanceState:
          type: string
          description: |
            The state of the prepaid balance. 
          enum:
            - ACTIVE
            - EXPIRED
        prepaidType:
          type: integer
          format: int32
          description: |
            The type of the prepaid balance.
          nullable: true
        account:
          type: object
          description: |
            The account associated with the prepaid balance.
        origSubscription:
          type: object
          description: |
            The subscription associated with the prepaid balance.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Prepaid Balance object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPrepaidBalanceResponse
    NestedValidityPeriodSummaryOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the validity period summary.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the validity period
            summary.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the validity period summary was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the validity
            period summary.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the validity period summary was last updated.
        prepaidBalanceId:
          type: string
          description: |
            The unique identifier of the prepaid balance.
        startDate:
          type: string
          format: date
          description: |
            The start date of the validity period.
        endDate:
          type: string
          format: date
          description: |
            The end date of the validity period.
        totalBalance:
          type: number
          description: |
            The total prepaid balance for the current validity period.
        remainingBalance:
          type: number
          description: |
            The remaining prepaid balance for the current validity period.
        totalBilledAmount:
          type: number
          description: |
            The total amount that has been billed.
        billedBalanceAmount:
          type: number
          description: |
            The total amount of the billing documents balances.
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription the validity period belongs to.
        uom:
          type: string
          description: |
            The UOM of the validity period.
        accountNumber:
          type: string
          description: |
            The number of the account to which the prepaid balance belongs.
        accountId:
          type: string
          description: |
            The ID of the account to which the prepaid balance belongs.
        overageRatedQuantity:
          type: number
          format: double
          description: >
            The overage rated quantity for the validity period.


            **Note**: The `overageRatedQuantity` and `overageRatedAmount` fields
            of the Validity Period Summary object are approaching end of support
            on  February 01, 2025. For more information, see <a
            href="https://knowledgecenter.zuora.com/Releases/ZProduct_and_feature_end_of_support_plan#overageRatedQuantity_and_overageRatedAmount_fields_end_of_support_plan"
            target="_blank">Product and feature end of support plan</a>.
        overageRatedAmount:
          type: number
          format: double
          description: >
            The overage rated amount for the validity period.


            **Note**: The `overageRatedQuantity` and `overageRatedAmount` fields
            of the Validity Period Summary object are approaching end of support
            on  February 01, 2025. For more information, see <a
            href="https://knowledgecenter.zuora.com/Releases/ZProduct_and_feature_end_of_support_plan#overageRatedQuantity_and_overageRatedAmount_fields_end_of_support_plan"
            target="_blank">Product and feature end of support plan</a>.
        account:
          type: object
          description: |
            The account associated with the validty period summary.
        prepaidBalance:
          type: object
          description: |
            The prepaid balance associated with the validity period summary.
        billingTiming:
          type: string
          description: |
            The billing timing of the validity period.
          enum:
            - In Advance
            - In Arrears
      additionalProperties:
        type: object
        description: >
          Custom fields of the Validity Period Summary object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryValidityPeriodSummaryResponse
    ExpandedPrepaidBalanceFund:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the prepaid balance fund.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the prepaid balance
            fund.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the prepaid balance fund was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the prepaid
            balance fund.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the prepaid balance fund was last updated.
        accountId:
          type: string
          description: >
            The ID of the customer account to which the prepaid balance fund
            belongs.
        balance:
          type: number
          description: |
            The remaining balance (remaining units) on the fund.
        chargeSegmentNumber:
          type: integer
          format: int32
          description: >
            The number of the charge segment. One prepaid balance fund can only
            belong to one charge segment.
        endDate:
          type: string
          format: date
          description: |
            End date of the fund effective period.
        fundedBalance:
          type: number
          description: |
            The total units of the fund. 
        fundSourceType:
          type: string
          description: |
            The type of the Prepaid Balance Fund.  
          enum:
            - CHARGE
            - ORDER_LINE_ITEM
            - CREDIT_MEMO_ITEM
            - DEBIT_MEMO_ITEM
        fundingPrice:
          type: number
          description: >
            The price amount of a fund. A rounded value that follows the
            associated invoice owner's <a
            href="https://knowledgecenter.zuora.com/Quick_References/Rounding_and_Precision#Currency_rounding_rules"
            target="_blank">currency rounding rule</a>. 


            **Calculation**: (Number of billing periods in one fund validity
            period) * (price in one billing period)
        totalBilled:
          type: number
          description: |
            The total billed amount of a fund.
        totalBalance:
          type: number
          description: |
            The total balance of a fund.
        originalTotalBalance:
          type: number
          description: |
            The original total balance of a fund.
        originalFundingPrice:
          type: number
          description: |
            The original price amount of a fund.
        originalFundEndDate:
          type: string
          format: date
          description: |
            The original end date of the fund effective period.
        rolloverValidityPeriodStartDate:
          type: string
          format: date
          description: |
            Start date of the rollover validity period.
        rolloverValidityPeriodEndDate:
          type: string
          format: date
          description: |
            End date of the rollover validity period.
        prepaidBalanceId:
          type: string
          description: >
            The ID of the prepaid balance associated to which this prepaid
            balance fund belongs.
        priority:
          type: integer
          format: int32
          description: >
            The priority of the Fund. Possible values include: 10(high),
            50(medium),100(low)
          enum:
            - 10
            - 50
            - 100
        sourceId:
          type: string
          description: |
            The source Id of the fund. It is the original charge ID. 
        startDate:
          type: string
          format: date
          description: |
            Start date of the fund effective period.
        vpSummaryId:
          type: string
        rolloverCount:
          type: integer
          format: int32
        originFundId:
          type: string
        rolloverApplyOption:
          type: string
        done:
          type: integer
          format: int32
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        prepaidBalance:
          $ref: '#/components/schemas/NestedPrepaidBalanceOnExpand'
        source:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        vpSummary:
          $ref: '#/components/schemas/NestedValidityPeriodSummaryOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Prepaid Balance Fund object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPrepaidBalanceFundResponse
    NestedPrepaidBalanceFundOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the prepaid balance fund.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the prepaid balance
            fund.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the prepaid balance fund was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the prepaid
            balance fund.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the prepaid balance fund was last updated.
        accountId:
          type: string
          description: >
            The ID of the customer account to which the prepaid balance fund
            belongs.
        balance:
          type: number
          description: |
            The remaining balance (remaining units) on the fund.
        chargeSegmentNumber:
          type: integer
          format: int32
          description: >
            The number of the charge segment. One prepaid balance fund can only
            belong to one charge segment.
        endDate:
          type: string
          format: date
          description: |
            End date of the fund effective period.
        fundedBalance:
          type: number
          description: |
            The total units of the fund. 
        fundSourceType:
          type: string
          description: |
            The type of the Prepaid Balance Fund.  
          enum:
            - CHARGE
            - ORDER_LINE_ITEM
            - CREDIT_MEMO_ITEM
            - DEBIT_MEMO_ITEM
        fundingPrice:
          type: number
          description: >
            The price amount of a fund. A rounded value that follows the
            associated invoice owner's <a
            href="https://knowledgecenter.zuora.com/Quick_References/Rounding_and_Precision#Currency_rounding_rules"
            target="_blank">currency rounding rule</a>. 


            **Calculation**: (Number of billing periods in one fund validity
            period) * (price in one billing period)
        totalBilled:
          type: number
        totalBalance:
          type: number
        originalTotalBalance:
          type: number
        originalFundingPrice:
          type: number
        originalFundEndDate:
          type: string
          format: date
        rolloverValidityPeriodStartDate:
          type: string
          format: date
        rolloverValidityPeriodEndDate:
          type: string
          format: date
        prepaidBalanceId:
          type: string
          description: >
            The ID of the prepaid balance associated to which this prepaid
            balance fund belongs.
        priority:
          type: integer
          format: int32
          description: >
            The priority of the Fund. Possible values include: 10(high),
            50(medium),100(low)
          enum:
            - 10
            - 50
            - 100
        sourceId:
          type: string
          description: |
            The source Id of the fund. It is the original charge ID. 
        startDate:
          type: string
          format: date
          description: |
            Start date of the fund effective period.
        vpSummaryId:
          type: string
        rolloverCount:
          type: integer
          format: int32
        originFundId:
          type: string
        rolloverApplyOption:
          type: string
        done:
          type: integer
          format: int32
        account:
          type: object
          description: |
            The account associated with the prepaid balance fund.
        prepaidBalance:
          type: object
          description: |
            The prepaid balance that contains the prepaid balance fund.
        source:
          type: object
          description: |
            The rate plan charge associated with the prepaid balance fund.
        vpSummary:
          type: object
          description: >
            The validity period summary associated with the prepaid balance
            fund.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Prepaid Balance Fund object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPrepaidBalanceFundResponse
    ExpandedPrepaidBalanceTransaction:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the prepaid balance transaction.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the prepaid balance
            transaction.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the prepaid balance transaction was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the prepaid
            balance transaction.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the prepaid balance transaction was last
            updated.
        accountId:
          type: string
          description: >
            The ID of the customer account on which the prepaid balance
            transaction occurs.
        prepaidBalanceId:
          type: string
          description: |
            The ID of the prepaid balance.
        fundId:
          type: string
          description: |
            The ID of the prepaid balance fund.
        amount:
          type: number
          description: >
            The amount of units to be adjusted to the prepaid balance (could be
            positive or negative).
        balance:
          type: number
          description: |
            The prepaid balance after a transaction.
        sourceId:
          type: string
          description: >
            The transaction source id (original Charge Id, Guided Usage Id,
            Order Line Item Id).
        transactionDate:
          type: string
          format: date
          description: |
            The date when the prepaid balance transaction occurs.
        transactionSourceType:
          type: string
          description: |
            The type of the transaction source. 
          enum:
            - CHARGE
            - ORDER_LINE_ITEM
            - USAGE
        prepaidBalanceTransactionType:
          type: string
          description: |
            The type of the Prepaid Balance Transaction. 
          enum:
            - PREPAYMENT
            - DRAWDOWN
            - PREPAYMENT_ADJUSTMENT
            - DRAWDOWN_ADJUSTMENT
            - DRAWDOWN_REVERSAL
            - PREPAYMENT_CREDIT_BACK
            - PREPAYMENT_CREDIT_BACK_REVERSAL
        usageUom:
          type: string
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
          nullable: true
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        prepaidBalance:
          $ref: '#/components/schemas/NestedPrepaidBalanceOnExpand'
        fund:
          $ref: '#/components/schemas/NestedPrepaidBalanceFundOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Prepaid Balance Transaction object. Only the
          indexed custom fields with a specified value (not null) are returned.
          The name of each custom field has the form
          <code>*customField*__c</code>. Custom field names are case sensitive.
          See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryPrepaidBalanceTransactionResponse
    ExpandedProcessedUsage:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the processed usage.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the processed usage.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the processed usage was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the processed
            usage.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the processed usage was last updated.
        usageId:
          type: string
          description: |
            The unique identifier of the usage.
        amount:
          type: number
          description: |
            The amount of the processed usage.
        billingPeriodEndDate:
          type: string
          description: |
            The end date of the billing period for the processed usage.
        billingPeriodStartDate:
          type: string
          description: |
            The start date of the billing period for the processed usage.
        invoiceItemId:
          type: string
          description: >
            The unique identifier of the invoice item associated with the
            processed usage.
        creditMemoItemId:
          type: string
          description: >
            The unique identifier of the credit memo item associated with the
            processed usage.
        ratePlanChargeId:
          type: string
          description: |
            ID of the rate plan charge associated with the processed usage.
        usage:
          $ref: '#/components/schemas/NestedUsageOnExpand'
        invoiceItem:
          $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
        creditMemoItem:
          $ref: '#/components/schemas/NestedCreditMemoItemOnExpand'
      type: object
      title: QueryProcessedUsageResponse
      additionalProperties: false
    NestedProductRatePlanOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product rate plan.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the product rate plan.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the product rate plan was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the product rate
            plan.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the product rate plan was last updated.
        productId:
          type: string
          description: |
            The unique identifier of the product to which this product rate
            plan belongs.
        name:
          type: string
          description: |
            The name of the product rate plan.
        description:
          type: string
          description: |
            A description of the product rate plan.
        effectiveStartDate:
          type: string
          format: date
          description: |
            First date the rate plan is active (i.e., available to be subscribed
            to), as `yyyy-mm-dd`.  Before this date, the status is `NotStarted`.
        effectiveEndDate:
          type: string
          format: date
          description: >
            Final date the rate plan is active, as `yyyy-mm-dd`. After this
            date,

            the rate plan status is `Expired`.
        grade:
          type: integer
          format: int32
          description: >
            The grade of the product rate plan.



            **Note**: This field is in the **Early Adopter** phase. We are

            actively soliciting feedback from a small set of early adopters
            before

            releasing it as generally available. If you want to join this early

            adopter program, submit a request at [Zuora Global

            Support](http://support.zuora.com/).
        productRatePlanNumber:
          type: string
          description: |
            The natural key of the product rate plan. 
        product:
          type: object
          description: |
            The product associated with the product rate plan.
        productRatePlanCharges:
          type: array
          items:
            type: object
          description: |
            The product rate plan charges on the product rate plan.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product Rate Plan object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductRatePlanResponse
    ExpandedProduct:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the product.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the product was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the product.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the product was last updated.
        allowFeatureChanges:
          type: boolean
          description: >
            Controls whether to allow your users to add or remove features while
            creating or amending a subscription.
          default: false
        description:
          type: string
          description: |
            A description of the product. 
        name:
          type: string
          description: >
            The name of the product. This information is displayed in the
            product

            catalog pages in the web-based UI.
        effectiveEndDate:
          type: string
          format: date
          description: >
            The date when the product expires and can't be subscribed to
            anymore,

            in the `yyyy-mm-dd` format.
        effectiveStartDate:
          type: string
          format: date
          description: >
            The date when the product becomes available and can be subscribed
            to, in the `yyyy-mm-dd` format.
        sKU:
          type: string
          description: |
            The unique SKU for the product.
        productNumber:
          type: string
          description: |
            The product number of the product.
        category:
          type: string
          description: >
            Category of the product. Used by Zuora Quotes Guided Product
            Selector.
          enum:
            - Base Products
            - Add On Services
            - Miscellaneous Products
        productRatePlans:
          type: array
          items:
            $ref: '#/components/schemas/NestedProductRatePlanOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductResponse
    NestedProductOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the product.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the product was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the product.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the product was last updated.
        allowFeatureChanges:
          type: boolean
          description: >
            Controls whether to allow your users to add or remove features while
            creating or amending a subscription.
          default: false
        description:
          type: string
          description: |
            A description of the product. 
        name:
          type: string
          description: >
            The name of the product. This information is displayed in the
            product

            catalog pages in the web-based UI.
        effectiveEndDate:
          type: string
          format: date
          description: >
            The date when the product expires and can't be subscribed to
            anymore,

            in the `yyyy-mm-dd` format.
        effectiveStartDate:
          type: string
          format: date
          description: >
            The date when the product becomes available and can be subscribed
            to, in the `yyyy-mm-dd` format.
        sKU:
          type: string
          description: |
            The unique SKU for the product.
        productNumber:
          type: string
          description: |
            The product number of the product.
        category:
          type: string
          description: >
            Category of the product. Used by Zuora Quotes Guided Product
            Selector.
          enum:
            - Base Products
            - Add On Services
            - Miscellaneous Products
        productRatePlans:
          type: array
          items:
            type: object
          description: The product rate plans contained in this product.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductResponse
    NestedPrpcOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product rate plan charge.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the product rate plan
            charge.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the product rate plan charge was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the product rate
            plan charge.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the product rate plan charge was last
            updated.
        accountingCode:
          type: string
          description: |
            The accounting code for the charge. Accounting codes group
            transactions that contain similar accounting attributes.
          maxLength: 100
        applyDiscountTo:
          type: string
          description: |
            Indicates which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          nullable: true
        chargeFunction:
          description: >
            **Note**: This field is only available if you have the Prepaid with
            Drawdown or Minimum Commitment feature enabled.


            This field defines what type of charge it is:

            * Standard: Normal charge with no Prepayment or Commitment or
            Drawdown.

            * Prepayment: For recurring charges. Unit or currency based prepaid
            charge.

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge.

            * Drawdown: For usage charges. Drawdown from prepaid funds.

            * DrawdownAndCreditCommitment: For usage charges. Drawdown from
            prepaid funds and then credit to minimum commitment funds.

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - Standard
            - Prepayment
            - CommitmentTrueUp
            - Drawdown
            - CreditCommitment
            - DrawdownAndCreditCommitment
          type: string
        isAllocationEligible:
          type: boolean
          description: >
            Indicates whether the charge segment is allocation eligible in
            revenue recognition. 
          default: false
        isUnbilled:
          type: boolean
          description: |
            Specifies how to perform the accounting during revenue recognition. 
          default: false
        applyToBillingPeriodPartially:
          description: >
            Allow the discount duration to be aligned with the billing period
            partially.
          type: boolean
          default: false
        billCycleDay:
          type: integer
          format: int64
          description: >
            Sets the bill cycle day (BCD) for the charge. The BCD determines
            which

            day of the month customer is billed. The BCD value in the account
            can

            override the BCD in this object.
          minimum: 1
          maximum: 31
        billCycleType:
          description: |
            Specifies how to determine the billing day for the
            charge.               
          enum:
            - DefaultFromCustomer
            - SpecificDayofMonth
            - SubscriptionStartDay
            - ChargeTriggerDay
            - SpecificDayofWeek
            - TermStartDay
            - TermEndDay
          type: string
        billingPeriod:
          description: >
            The billing period for the charge. The start day of the billing
            period

            is also called the bill cycle day (BCD).
          enum:
            - Month
            - Quarter
            - Annual
            - Semi-Annual
            - Specific Months
            - Subscription Term
            - Week
            - Specific Weeks
            - Specific Days
          type: string
        billingPeriodAlignment:
          type: string
          description: |
            The billing period alignment setting for this charge.
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
        billingTiming:
          type: string
          description: |
            The billing timing for this charge.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
        chargeModel:
          description: >
            Determines how to calculate charges. Charge models must be
            individually activated in Zuora Billing administration.
          enum:
            - Discount-Fixed Amount
            - Discount-Percentage
            - Flat Fee Pricing
            - Per Unit Pricing
            - Overage Pricing
            - Tiered Pricing
            - Tiered with Overage Pricing
            - Volume Pricing
            - Delivery Pricing
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing`
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        chargeType:
          description: |
            Specifies the type of charge.
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        creditOption:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            The way to calculate credit. See [Credit

            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)

            for more information. 
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        defaultQuantity:
          type: number
          nullable: true
          description: |
            The default quantity. 

            This field is applicable only for one-time and recurring charges.
        deferredRevenueAccount:
          type: string
          description: |
            The name of the deferred revenue account for this charge.


            This feature is in **Limited Availability**. If you wish to have
            access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/). 
          maxLength: 100
        description:
          type: string
          description: |
            Description of the product rate plan charge.
        discountClassId:
          type: string
          description: >
            ID of the class the discount belongs to. The discount class defines
            the order in which discount product rate plan charges are applied.


            For more information, see [Manage Discount
            Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).
          nullable: true
        discountLevel:
          description: >
            The application scope of the discount charge. For example, if the
            value of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
          nullable: true
        endDateCondition:
          description: |
            The end date condition for this charge.
          enum:
            - SubscriptionEnd
            - OneTime
            - FixedPeriod
            - SpecificEndDate
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled. 
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related rate plan charges and order
            line items from revenue accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled.
        includedUnits:
          type: number
          description: |
            Specifies the number of units in the base set of units.
        isPrepaid:
          type: boolean
          default: false
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Indicates whether this charge is a prepayment (topup) charge or a

            drawdown charge. 
        isRollover:
          type: boolean
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            It determines whether the rollover fields are needed.
        isStackedDiscount:
          type: boolean
          description: >
            **Note**: This field is only applicable to the Discount - Percentage
            charge model.


            This field indicates whether the discount is to be calculated as
            stacked discount. Possible values are as follows:
              - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.
              - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.

            For more information, see [Stacked
            discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
        legacyRevenueReporting:
          type: boolean
          description: >
            Indicates whether to use the legacy revenue reporting for this
            charge.
        listPriceBase:
          description: |
            The list price base for the product rate plan charge.

            This field is only applicable for recurring charges.
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
          type: string
        specificListPriceBase:
          type: integer
          format: int32
          description: >
            The number of months for the list price base of the charge. The
            value of this field is `null` if you do not set the value of the
            `listPriceBase` field to `Per_Specific_Months`.
          nullable: true
        maxQuantity:
          type: number
          description: >
            The maximum number of units for this charge. This field and the
            `minQuantity` field can be used to create a range of units allowed
            in a product rate plan charge.
        minQuantity:
          type: number
          description: >
            The minimum number of units for this charge. This field and the
            `maxQuantity` field can be used to create a range of units allowed
            in a product rate plan charge.
        name:
          description: |
            Name of the product rate-plan charge. Not required to be unique.
          type: string
        numberOfPeriod:
          type: integer
          format: int64
          description: >
            Specifies the number of periods to use when calculating charges in
            an overage smoothing charge model.

            This field is ued when overage smoothing model is `RollingWindow` or
            `Rollover`.
          nullable: true
        overageCalculationOption:
          description: |
            Value specifies when to calculate overage charges.
          type: string
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          nullable: true
        overageUnusedUnitsCreditOption:
          type: string
          description: >
            Determines whether to credit the customer with unused units of
            usage.
          enum:
            - NoCredit
            - CreditBySpecificRate
          nullable: true
        prepaidOperationType:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The type of this charge. It is either a prepayment (topup) charge or
            a drawdown charge. 
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
          nullable: true
        prepaidTotalQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The total amount of units that end customers can use during a
            validity period when they subscribe to a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: number
          nullable: true
        priceChangeOption:
          description: |
            Applies an automatic price change when a termed subscription is
            renewed and the following applies:


            1. AutomatedPriceChange setting is on

            2. Charge type is not one-time

            3. Charge model is not discount fixed amount
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
          default: NoChange
          nullable: true
        priceIncreasePercentage:
          type: number
          description: >
            Specifies the percentage to increase or decrease the price of a
            termed subscription's renewal. Use this field if you set the
            `PriceChangeOption` value to `SpecificPercentageValue`.


            1. AutomatedPriceChange setting is on

            2. Charge type is not one-time

            3. Charge model is not discount fixed amount


            Values: a decimal between -100 and 100
          minimum: -100
          maximum: 100
          nullable: true
        productRatePlanChargeNumber:
          type: string
          description: |
            The natural key of the product rate plan charge.
        prorationOption:
          type: string
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled.


            The charge-level proration option for the product rate plan charge.
        ratingGroup:
          description: >
            Specifies a rating group based on which usage records are rated.


            Possible values:


            - `ByBillingPeriod` (default): The rating is based on all the usages
            in a billing period.

            - `ByUsageStartDate`: The rating is based on all the usages on the
            same usage start date. 

            - `ByUsageRecord`: The rating is based on each usage record.

            - `ByUsageUpload`: The rating is based on all the  usages in a
            uploaded usage file (`.xls` or `.csv`).

            - `ByGroupId`: The rating is based on all the usages in a custom
            group.


            **Note:** 

            - The `ByBillingPeriod` value can be applied for all charge models. 

            - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload`
            values can only be applied for per unit, volume pricing, and tiered
            pricing charge models. 

            - The `ByGroupId` value is only available if you have the Active
            Rating feature enabled.

            - Use this field only for Usage charges. One-Time Charges and
            Recurring Charges return `NULL`.
          type: string
          nullable: true
        revRecTriggerCondition:
          description: |
            Specifies when revenue recognition begins.
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          maxLength: 22
          type: string
          nullable: true
        revenueRecognitionRuleName:
          description: >
            The name of the revenue recognition rule governing the revenue
            schedule.
          type: string
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            The period length of the rollover fund.
          type: integer
          format: int32
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: integer
          format: int64
        recognizedRevenueAccount:
          description: >
            The name of the recognized revenue account for this charge.
              - Required when the Allow Blank Accounting Code setting is No.
              - Optional when the Allow Blank Accounting Code setting is Yes.

            This feature is in **Limited Availability**. If you wish to have
            access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/). 
          maxLength: 100
          type: string
        smoothingModel:
          description: >
            Specifies the smoothing model for an overage smoothing charge model
            or

            an tiered with overage model, which is an advanced type of a usage

            model that avoids spikes in usage charges. If a customer's usage

            spikes in a single period, then an overage smoothing model eases

            overage charges by considering usage and multiple periods.



            One of the following values shows which smoothing model will be

            applied to the charge when `Overage` or `Tiered with Overage` is
            used:



            - `RollingWindow` considers a number of periods to smooth usage. The

            rolling window starts and increments forward based on billing

            frequency. When allowed usage is met, then period resets and a new

            window begins.


            - `Rollover` considers a fixed number of periods before calculating

            usage. The net balance at the end of a period is unused usage, which

            is carried over to the next period's balance.
          type: string
          nullable: true
        specificBillingPeriod:
          type: integer
          format: int64
          description: >
            When the billing period is set to `Specific` Months then this
            positive

            integer reflects the number of months for billing period charges.
          nullable: true
        taxable:
          type: boolean
          description: |
            Specifies whether the charge is taxable; used by Zuora Tax. 
        taxCode:
          type: string
          description: |
            Specifies the tax code for taxation rules; used by Zuora Tax.
        taxMode:
          description: |
            Specifies how to define taxation for the charge; used by Zuora Tax.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        triggerEvent:
          type: string
          description: >
            Specifies when to start billing the customer for the charge.


            Values: one of the following:

            - `ContractEffective` is the date when the subscription's contract
            goes into effect and the charge is ready to be billed.

            - `ServiceActivation` is the date when the services or products for
            a subscription have been activated and the customers have access.

            - `CustomerAcceptance` is when the customer accepts the services or
            products for a subscription. 

            - `SpecificDate` is the date specified.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
        upToPeriods:
          type: integer
          format: int64
          nullable: true
          description: >
            Specifies the length of the period during which the charge is
            active.

            If this period ends before the subscription ends, the charge ends
            when

            this period ends.


            If the subscription end date is subsequently changed through a

            Renewal, or Terms and Conditions amendment, the charge end date will

            change accordingly up to the original period end.
        upToPeriodsType:
          description: |
            The period type used to define when the charge ends.
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          description: |
            Determines how Zuora processes usage records for per-unit usage
            charges. 
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          type: boolean
          nullable: true
          description: |
            Determines whether to define a new accounting code for the new
            discount charge.
        useTenantDefaultForPriceChange:
          type: boolean
          description: >
            Shows the tenant-level percentage uplift value for an automatic
            price

            change to a termed subscription's renewal. You set the tenant uplift

            value in the web-based UI: **Settings > Billing > Define Default

            Subscription Settings**.
        validityPeriodType:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            The period in which the prepayment units are valid to use as defined

            in a [prepayment

            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          enum:
            - SubscriptionTerm
            - Annual
            - SemiAnnual
            - Quarter
            - Month
        weeklyBillCycleDay:
          description: |
            Specifies which day of the week as the bill cycle day (BCD) for the
            charge.


            This feature is in **Limited Availability**. If you wish to have
            access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/). 
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
        priceUpsellQuantityStacked:
          type: boolean
          description: |
            Indicates whether the price upsell quantity is stacked.
        deliveryScheduleId:
          type: string
          description: >
            The unique identifier of the delivery schedule associated with the

            product rate plan charge. This field is applicable only when this
            charge is

            using Delivery Pricing charge model.
        commitmentType:
          type: string
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a> feature enabled.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to `133` or higher. Otherwise, an error occurs. 


            This field defines the type of commitment. A prepaid charge can be
            `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can
            only be `CURRENCY` type. For topup(recurring or one-time) charges,
            this field indicates what type of funds are created. 

            * If UNIT, it will create a fund with given prepaidUom.

            * If CURRENCY, it will create a fund with the currency amount
            calculated in list price.
              
            For drawdown(usage) charges, this field indicates what type of funds
            are drawdown from that created from topup charges.
          enum:
            - UNIT
            - CURRENCY
        isCommitted:
          type: boolean
          description: |
            Indicates whether the charge is commited.
        productRatePlanId:
          type: string
          description: >
            The unique identifier of the product rate plan to which this product
            rate plan charge belongs.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The type of the accounting code for accounts receivable.
        recognizedRevenueAccountingCodeId:
          description: >
            The accounting code for recognized revenue, such as Monthly
            Recurring

            Charges or Overage Charges. 
          type: string
        deferredRevenueAccountingCodeId:
          description: >
            The type associated with the deferred revenue accounting code, such
            as

            Deferred Revenue. 
          type: string
          nullable: true
        adjustmentLiabilityAccountingCodeId:
          type: string
          description: >
            The type associated with the adjustment liability accounting code. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        adjustmentRevenueAccountingCodeId:
          type: string
          description: >
            The type associated with the adjustment revenue accounting code. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        contractAssetAccountingCodeId:
          type: string
          description: >
            The type associated with the contract asset accounting code. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        contractLiabilityAccountingCodeId:
          type: string
          description: >
            The accounting code for contract liability. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        contractRecognizedRevenueAccountingCodeId:
          type: string
          description: >
            The accounting code for contract recognized revenue. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        unbilledReceivablesAccountingCodeId:
          description: >
            The accounting code for unbilled receivables. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
          type: string
          nullable: true
        revRecCode:
          description: |
            Associates this product rate plan charge with a specific revenue
            recognition code.
          maxLength: 70
          type: string
          nullable: true
        uOM:
          type: string
          description: |
            Describes the Units of Measure (uom) configured in **Settings >
            Billing** for the productRatePlanCharges.
          nullable: true
        drawdownUom:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Unit of measurement for a [drawdown

            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
        prepaidUom:
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Unit of measurement for a [prepayment

            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: string
          nullable: true
        productRatePlan:
          type: object
          description: |
            The product rate plan that contains this product rate plan charge.
        productRatePlanChargeTiers:
          type: array
          items:
            type: object
          description: >
            The product rate plan charge tiers contained in this product rate
            plan charge.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product Rate Plan Charge object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductRatePlanChargeResponse
    ExpandedProductRatePlan:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product rate plan.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the product rate plan.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the product rate plan was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the product rate
            plan.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the product rate plan was last updated.
        productId:
          type: string
          description: |
            The unique identifier of the product to which this product rate
            plan belongs.
        name:
          type: string
          description: |
            The name of the product rate plan.
        description:
          type: string
          description: |
            A description of the product rate plan.
        effectiveStartDate:
          type: string
          format: date
          description: |
            First date the rate plan is active (i.e., available to be subscribed
            to), as `yyyy-mm-dd`.  Before this date, the status is `NotStarted`.
        effectiveEndDate:
          type: string
          format: date
          description: >
            Final date the rate plan is active, as `yyyy-mm-dd`. After this
            date,

            the rate plan status is `Expired`.
        grade:
          type: integer
          format: int32
          description: >
            The grade of the product rate plan.



            **Note**: This field is in the **Early Adopter** phase. We are

            actively soliciting feedback from a small set of early adopters
            before

            releasing it as generally available. If you want to join this early

            adopter program, submit a request at [Zuora Global

            Support](http://support.zuora.com/).
        productRatePlanNumber:
          type: string
          description: |
            The natural key of the product rate plan. 
        product:
          $ref: '#/components/schemas/NestedProductOnExpand'
        productRatePlanCharges:
          type: array
          items:
            $ref: '#/components/schemas/NestedPrpcOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product Rate Plan object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductRatePlanResponse
    NestedPrpcTierOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product rate plan charge tier.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the product rate plan
            charge tier.
        createdDate:
          type: string
          format: date-time
          description: >
            The time that the product rate plan charge tier gets created in the
            system, in the

            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the product rate
            plan charge tier.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the product rate plan charge tier was last
            updated.
        active:
          type: boolean
          description: |
            Indicates whether the product rate plan charge tier is active.
        currency:
          type: string
          description: |
            The valid code corresponding to the currency for the tier's price.
        discountAmount:
          type: number
          description: >
            The specific amount for a fixed discount. This field is applicable
            for charges based on the Discount-Fixed Amount charge model.
          format: double
        discountPercentage:
          type: number
          description: >
            The percentage of discount for a percentage discount. This field is
            applicable for charges based on the Discount-Percentage charge
            model.
          format: double
        endingUnit:
          type: number
          description: |
            The end number of a range of units for the tier. This field is
            applicable for charges based on the Tiered Pricing or Tiered with
            Overage Pricing charge model.
        includedUnits:
          type: number
          description: |
            Specifies the number of units in the base set of units.
        overagePrice:
          description: >
            Indicates whether the price is an overage price, which is the price
            when usage surpasses the last defined tier.
          format: double
          type: number
        price:
          type: number
          description: >
            The price of the tier if the charge is a flat fee, or the price of
            each unit in the tier if the charge model is tiered pricing.
          format: double
        priceFormat:
          type: string
          description: >
            Indicates if pricing is a flat fee or is per unit. This field is for
            tiered and volume pricing models only.
          enum:
            - Flat Fee
            - Per Unit
        startingUnit:
          type: number
          description: |
            The starting number of a range of units for the tier. This field is
            applicable for charges based on the Tiered Pricing or Tiered with
            Overage Pricing charge model.
        tier:
          type: integer
          format: int32
          description: |
            A unique number that identifies the tier that the price applies to.
        isDefault:
          type: boolean
          description: >
            Indicates whether the tier is the default tier. The default tier is
            the

            tier that is used when the usage does not fall into any of the
            defined

            tiers.
        productRatePlanChargeId:
          type: string
          description: |
            The unique identifier of the product rate plan charge that the tier
            belongs to.
        productChargeDefinitionId:
          type: string
          description: >
            The unique identifier of the product rate plan charge definition
            that

            the tier belongs to.
        productRatePlanCharge:
          type: object
          description: >
            The product rate plan charge that contains this product rate plan
            charge tier.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product Rate Plan Charge Tier object. Only the
          indexed custom fields with a specified value (not null) are returned.
          The name of each custom field has the form
          <code>*customField*__c</code>. Custom field names are case sensitive.
          See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductRatePlanChargeTierResponse
    ExpandedProductRatePlanCharge:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product rate plan charge.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the product rate plan
            charge.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the product rate plan charge was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the product rate
            plan charge.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the product rate plan charge was last
            updated.
        accountingCode:
          type: string
          description: |
            The accounting code for the charge. Accounting codes group
            transactions that contain similar accounting attributes.
          maxLength: 100
        applyDiscountTo:
          type: string
          description: |
            Indicates which type of charge the discount charge applies to.
          enum:
            - ONETIME
            - RECURRING
            - USAGE
            - ONETIMERECURRING
            - ONETIMEUSAGE
            - RECURRINGUSAGE
            - ONETIMERECURRINGUSAGE
            - null
          nullable: true
        chargeFunction:
          description: >
            **Note**: This field is only available if you have the Prepaid with
            Drawdown or Minimum Commitment feature enabled.


            This field defines what type of charge it is:

            * Standard: Normal charge with no Prepayment or Commitment or
            Drawdown.

            * Prepayment: For recurring charges. Unit or currency based prepaid
            charge.

            * CommitmentTrueUp: For recurring charges. Currency based minimum
            commitment charge.

            * Drawdown: For usage charges. Drawdown from prepaid funds.

            * DrawdownAndCreditCommitment: For usage charges. Drawdown from
            prepaid funds and then credit to minimum commitment funds.

            * CreditCommitment: For usage charges. Credit to minimum commitment
            funds.
          enum:
            - Standard
            - Prepayment
            - CommitmentTrueUp
            - Drawdown
            - CreditCommitment
            - DrawdownAndCreditCommitment
          type: string
        isAllocationEligible:
          type: boolean
          description: >
            Indicates whether the charge segment is allocation eligible in
            revenue recognition. 
          default: false
        isUnbilled:
          type: boolean
          description: |
            Specifies how to perform the accounting during revenue recognition. 
          default: false
        applyToBillingPeriodPartially:
          description: >
            Allow the discount duration to be aligned with the billing period
            partially.
          type: boolean
          default: false
        billCycleDay:
          type: integer
          format: int64
          description: >
            Sets the bill cycle day (BCD) for the charge. The BCD determines
            which

            day of the month customer is billed. The BCD value in the account
            can

            override the BCD in this object.
          minimum: 1
          maximum: 31
        billCycleType:
          description: |
            Specifies how to determine the billing day for the
            charge.               
          enum:
            - DefaultFromCustomer
            - SpecificDayofMonth
            - SubscriptionStartDay
            - ChargeTriggerDay
            - SpecificDayofWeek
            - TermStartDay
            - TermEndDay
          type: string
        billingPeriod:
          description: >
            The billing period for the charge. The start day of the billing
            period

            is also called the bill cycle day (BCD).
          enum:
            - Month
            - Quarter
            - Annual
            - Semi-Annual
            - Specific Months
            - Subscription Term
            - Week
            - Specific Weeks
            - Specific Days
          type: string
        billingPeriodAlignment:
          type: string
          description: |
            The billing period alignment setting for this charge.
          enum:
            - AlignToCharge
            - AlignToSubscriptionStart
            - AlignToTermStart
            - AlignToTermEnd
        billingTiming:
          type: string
          description: |
            The billing timing for this charge.
          enum:
            - IN_ADVANCE
            - IN_ARREARS
        chargeModel:
          description: >
            Determines how to calculate charges. Charge models must be
            individually activated in Zuora Billing administration.
          enum:
            - Discount-Fixed Amount
            - Discount-Percentage
            - Flat Fee Pricing
            - Per Unit Pricing
            - Overage Pricing
            - Tiered Pricing
            - Tiered with Overage Pricing
            - Volume Pricing
            - Delivery Pricing
            - MultiAttributePricing
            - PreratedPerUnit
            - PreratedPricing`
            - HighWatermarkVolumePricing
            - HighWatermarkTieredPricing
          type: string
        chargeType:
          description: |
            Specifies the type of charge.
          enum:
            - OneTime
            - Recurring
            - Usage
          type: string
        creditOption:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            The way to calculate credit. See [Credit

            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)

            for more information. 
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        defaultQuantity:
          type: number
          nullable: true
          description: |
            The default quantity. 

            This field is applicable only for one-time and recurring charges.
        deferredRevenueAccount:
          type: string
          description: |
            The name of the deferred revenue account for this charge.


            This feature is in **Limited Availability**. If you wish to have
            access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/). 
          maxLength: 100
        description:
          type: string
          description: |
            Description of the product rate plan charge.
        discountClassId:
          type: string
          description: >
            ID of the class the discount belongs to. The discount class defines
            the order in which discount product rate plan charges are applied.


            For more information, see [Manage Discount
            Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes).
          nullable: true
        discountLevel:
          description: >
            The application scope of the discount charge. For example, if the
            value of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
            - null
          type: string
          nullable: true
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The [conversion
            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)
            between Usage UOM and Drawdown UOM for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
            Must be a positive number (>0).
          type: number
          nullable: true
        endDateCondition:
          description: |
            The end date condition for this charge.
          enum:
            - SubscriptionEnd
            - OneTime
            - FixedPeriod
            - SpecificEndDate
          type: string
        excludeItemBillingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related invoice items, invoice item
            adjustments, credit memo items, and debit memo items from revenue
            accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled. 
        excludeItemBookingFromRevenueAccounting:
          type: boolean
          description: >
            Indicates whether to exclude the related rate plan charges and order
            line items from revenue accounting.


            **Note**: This field is only available if you have the Order to
            Revenue or Billing - Revenue Integration feature enabled.
        includedUnits:
          type: number
          description: |
            Specifies the number of units in the base set of units.
        isPrepaid:
          type: boolean
          default: false
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Indicates whether this charge is a prepayment (topup) charge or a

            drawdown charge. 
        isRollover:
          type: boolean
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            It determines whether the rollover fields are needed.
        isStackedDiscount:
          type: boolean
          description: >
            **Note**: This field is only applicable to the Discount - Percentage
            charge model.


            This field indicates whether the discount is to be calculated as
            stacked discount. Possible values are as follows:
              - `True`: This is a stacked discount, which should be calculated by stacking with other discounts.
              - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts.

            For more information, see [Stacked
            discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models).
        legacyRevenueReporting:
          type: boolean
          description: >
            Indicates whether to use the legacy revenue reporting for this
            charge.
        listPriceBase:
          description: |
            The list price base for the product rate plan charge.

            This field is only applicable for recurring charges.
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
          type: string
        specificListPriceBase:
          type: integer
          format: int32
          description: >
            The number of months for the list price base of the charge. The
            value of this field is `null` if you do not set the value of the
            `listPriceBase` field to `Per_Specific_Months`.
          nullable: true
        maxQuantity:
          type: number
          description: >
            The maximum number of units for this charge. This field and the
            `minQuantity` field can be used to create a range of units allowed
            in a product rate plan charge.
        minQuantity:
          type: number
          description: >
            The minimum number of units for this charge. This field and the
            `maxQuantity` field can be used to create a range of units allowed
            in a product rate plan charge.
        name:
          description: |
            Name of the product rate-plan charge. Not required to be unique.
          type: string
        numberOfPeriod:
          type: integer
          format: int64
          description: >
            Specifies the number of periods to use when calculating charges in
            an overage smoothing charge model.

            This field is ued when overage smoothing model is `RollingWindow` or
            `Rollover`.
          nullable: true
        overageCalculationOption:
          description: |
            Value specifies when to calculate overage charges.
          type: string
          enum:
            - EndOfSmoothingPeriod
            - PerBillingPeriod
            - null
          nullable: true
        overageUnusedUnitsCreditOption:
          type: string
          description: >
            Determines whether to credit the customer with unused units of
            usage.
          enum:
            - NoCredit
            - CreditBySpecificRate
          nullable: true
        prepaidOperationType:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The type of this charge. It is either a prepayment (topup) charge or
            a drawdown charge. 
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          type: number
          nullable: true
        prepaidTotalQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The total amount of units that end customers can use during a
            validity period when they subscribe to a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: number
          nullable: true
        priceChangeOption:
          description: |
            Applies an automatic price change when a termed subscription is
            renewed and the following applies:


            1. AutomatedPriceChange setting is on

            2. Charge type is not one-time

            3. Charge model is not discount fixed amount
          enum:
            - NoChange
            - SpecificPercentageValue
            - UseLatestProductCatalogPricing
          type: string
          default: NoChange
          nullable: true
        priceIncreasePercentage:
          type: number
          description: >
            Specifies the percentage to increase or decrease the price of a
            termed subscription's renewal. Use this field if you set the
            `PriceChangeOption` value to `SpecificPercentageValue`.


            1. AutomatedPriceChange setting is on

            2. Charge type is not one-time

            3. Charge model is not discount fixed amount


            Values: a decimal between -100 and 100
          minimum: -100
          maximum: 100
          nullable: true
        productRatePlanChargeNumber:
          type: string
          description: |
            The natural key of the product rate plan charge.
        prorationOption:
          type: string
          description: >
            **Note**: This field is only available if you have the Charge Level
            Proration feature enabled.


            The charge-level proration option for the product rate plan charge.
        ratingGroup:
          description: >
            Specifies a rating group based on which usage records are rated.


            Possible values:


            - `ByBillingPeriod` (default): The rating is based on all the usages
            in a billing period.

            - `ByUsageStartDate`: The rating is based on all the usages on the
            same usage start date. 

            - `ByUsageRecord`: The rating is based on each usage record.

            - `ByUsageUpload`: The rating is based on all the  usages in a
            uploaded usage file (`.xls` or `.csv`).

            - `ByGroupId`: The rating is based on all the usages in a custom
            group.


            **Note:** 

            - The `ByBillingPeriod` value can be applied for all charge models. 

            - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload`
            values can only be applied for per unit, volume pricing, and tiered
            pricing charge models. 

            - The `ByGroupId` value is only available if you have the Active
            Rating feature enabled.

            - Use this field only for Usage charges. One-Time Charges and
            Recurring Charges return `NULL`.
          type: string
          nullable: true
        revRecTriggerCondition:
          description: |
            Specifies when revenue recognition begins.
          enum:
            - ContractEffectiveDate
            - ServiceActivationDate
            - CustomerAcceptanceDate
            - null
          maxLength: 22
          type: string
          nullable: true
        revenueRecognitionRuleName:
          description: >
            The name of the revenue recognition rule governing the revenue
            schedule.
          type: string
        rolloverApply:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
          type: string
        rolloverPeriodLength:
          default: null
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            The period length of the rollover fund.
          type: integer
          format: int32
        rolloverPeriods:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
          type: integer
          format: int64
        recognizedRevenueAccount:
          description: >
            The name of the recognized revenue account for this charge.
              - Required when the Allow Blank Accounting Code setting is No.
              - Optional when the Allow Blank Accounting Code setting is Yes.

            This feature is in **Limited Availability**. If you wish to have
            access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/). 
          maxLength: 100
          type: string
        smoothingModel:
          description: >
            Specifies the smoothing model for an overage smoothing charge model
            or

            an tiered with overage model, which is an advanced type of a usage

            model that avoids spikes in usage charges. If a customer's usage

            spikes in a single period, then an overage smoothing model eases

            overage charges by considering usage and multiple periods.



            One of the following values shows which smoothing model will be

            applied to the charge when `Overage` or `Tiered with Overage` is
            used:



            - `RollingWindow` considers a number of periods to smooth usage. The

            rolling window starts and increments forward based on billing

            frequency. When allowed usage is met, then period resets and a new

            window begins.


            - `Rollover` considers a fixed number of periods before calculating

            usage. The net balance at the end of a period is unused usage, which

            is carried over to the next period's balance.
          type: string
          nullable: true
        specificBillingPeriod:
          type: integer
          format: int64
          description: >
            When the billing period is set to `Specific` Months then this
            positive

            integer reflects the number of months for billing period charges.
          nullable: true
        taxable:
          type: boolean
          description: |
            Specifies whether the charge is taxable; used by Zuora Tax. 
        taxCode:
          type: string
          description: |
            Specifies the tax code for taxation rules; used by Zuora Tax.
        taxMode:
          description: |
            Specifies how to define taxation for the charge; used by Zuora Tax.
          enum:
            - TaxExclusive
            - TaxInclusive
            - null
          type: string
          nullable: true
        triggerEvent:
          type: string
          description: >
            Specifies when to start billing the customer for the charge.


            Values: one of the following:

            - `ContractEffective` is the date when the subscription's contract
            goes into effect and the charge is ready to be billed.

            - `ServiceActivation` is the date when the services or products for
            a subscription have been activated and the customers have access.

            - `CustomerAcceptance` is when the customer accepts the services or
            products for a subscription. 

            - `SpecificDate` is the date specified.
          enum:
            - ContractEffective
            - ServiceActivation
            - CustomerAcceptance
            - SpecificDate
        upToPeriods:
          type: integer
          format: int64
          nullable: true
          description: >
            Specifies the length of the period during which the charge is
            active.

            If this period ends before the subscription ends, the charge ends
            when

            this period ends.


            If the subscription end date is subsequently changed through a

            Renewal, or Terms and Conditions amendment, the charge end date will

            change accordingly up to the original period end.
        upToPeriodsType:
          description: |
            The period type used to define when the charge ends.
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
            - null
          type: string
          nullable: true
        usageRecordRatingOption:
          description: |
            Determines how Zuora processes usage records for per-unit usage
            charges. 
          type: string
          nullable: true
        useDiscountSpecificAccountingCode:
          type: boolean
          nullable: true
          description: |
            Determines whether to define a new accounting code for the new
            discount charge.
        useTenantDefaultForPriceChange:
          type: boolean
          description: >
            Shows the tenant-level percentage uplift value for an automatic
            price

            change to a termed subscription's renewal. You set the tenant uplift

            value in the web-based UI: **Settings > Billing > Define Default

            Subscription Settings**.
        validityPeriodType:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            The period in which the prepayment units are valid to use as defined

            in a [prepayment

            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          enum:
            - SubscriptionTerm
            - Annual
            - SemiAnnual
            - Quarter
            - Month
        weeklyBillCycleDay:
          description: |
            Specifies which day of the week as the bill cycle day (BCD) for the
            charge.


            This feature is in **Limited Availability**. If you wish to have
            access to the feature, submit a request at [Zuora Global
            Support](http://support.zuora.com/). 
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
        priceUpsellQuantityStacked:
          type: boolean
          description: |
            Indicates whether the price upsell quantity is stacked.
        deliveryScheduleId:
          type: string
          description: >
            The unique identifier of the delivery schedule associated with the

            product rate plan charge. This field is applicable only when this
            charge is

            using Delivery Pricing charge model.
        commitmentType:
          type: string
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a> feature enabled.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to `133` or higher. Otherwise, an error occurs. 


            This field defines the type of commitment. A prepaid charge can be
            `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can
            only be `CURRENCY` type. For topup(recurring or one-time) charges,
            this field indicates what type of funds are created. 

            * If UNIT, it will create a fund with given prepaidUom.

            * If CURRENCY, it will create a fund with the currency amount
            calculated in list price.
              
            For drawdown(usage) charges, this field indicates what type of funds
            are drawdown from that created from topup charges.
          enum:
            - UNIT
            - CURRENCY
        isCommitted:
          type: boolean
          description: |
            Indicates whether the charge is commited.
        productRatePlanId:
          type: string
          description: >
            The unique identifier of the product rate plan to which this product
            rate plan charge belongs.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The type of the accounting code for accounts receivable.
        recognizedRevenueAccountingCodeId:
          description: >
            The accounting code for recognized revenue, such as Monthly
            Recurring

            Charges or Overage Charges. 
          type: string
        deferredRevenueAccountingCodeId:
          description: >
            The type associated with the deferred revenue accounting code, such
            as

            Deferred Revenue. 
          type: string
          nullable: true
        adjustmentLiabilityAccountingCodeId:
          type: string
          description: >
            The type associated with the adjustment liability accounting code. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        adjustmentRevenueAccountingCodeId:
          type: string
          description: >
            The type associated with the adjustment revenue accounting code. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        contractAssetAccountingCodeId:
          type: string
          description: >
            The type associated with the contract asset accounting code. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        contractLiabilityAccountingCodeId:
          type: string
          description: >
            The accounting code for contract liability. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        contractRecognizedRevenueAccountingCodeId:
          type: string
          description: >
            The accounting code for contract recognized revenue. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
        unbilledReceivablesAccountingCodeId:
          description: >
            The accounting code for unbilled receivables. 



            **Note**: This field is only available if you have the Zuora Billing
            -

            Revenue Integration feature enabled.
          type: string
          nullable: true
        revRecCode:
          description: |
            Associates this product rate plan charge with a specific revenue
            recognition code.
          maxLength: 70
          type: string
          nullable: true
        uOM:
          type: string
          description: |
            Describes the Units of Measure (uom) configured in **Settings >
            Billing** for the productRatePlanCharges.
          nullable: true
        drawdownUom:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Unit of measurement for a [drawdown

            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
        prepaidUom:
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Unit of measurement for a [prepayment

            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: string
          nullable: true
        productRatePlan:
          $ref: '#/components/schemas/NestedProductRatePlanOnExpand'
        productRatePlanChargeTiers:
          type: array
          items:
            $ref: '#/components/schemas/NestedPrpcTierOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product Rate Plan Charge object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductRatePlanChargeResponse
    ExpandedProductRatePlanChargeTier:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the product rate plan charge tier.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the product rate plan
            charge tier.
        createdDate:
          type: string
          format: date-time
          description: >
            The time that the product rate plan charge tier gets created in the
            system, in the

            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the product rate
            plan charge tier.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the product rate plan charge tier was last
            updated.
        active:
          type: boolean
          description: |
            Indicates whether the product rate plan charge tier is active.
        currency:
          type: string
          description: |
            The valid code corresponding to the currency for the tier's price.
        discountAmount:
          type: number
          description: >
            The specific amount for a fixed discount. This field is applicable
            for charges based on the Discount-Fixed Amount charge model.
          format: double
        discountPercentage:
          type: number
          description: >
            The percentage of discount for a percentage discount. This field is
            applicable for charges based on the Discount-Percentage charge
            model.
          format: double
        endingUnit:
          type: number
          description: |
            The end number of a range of units for the tier. This field is
            applicable for charges based on the Tiered Pricing or Tiered with
            Overage Pricing charge model.
        includedUnits:
          type: number
          description: |
            Specifies the number of units in the base set of units.
        overagePrice:
          description: >
            Indicates whether the price is an overage price, which is the price
            when usage surpasses the last defined tier.
          format: double
          type: number
        price:
          type: number
          description: >
            The price of the tier if the charge is a flat fee, or the price of
            each unit in the tier if the charge model is tiered pricing.
          format: double
        priceFormat:
          type: string
          description: >
            Indicates if pricing is a flat fee or is per unit. This field is for
            tiered and volume pricing models only.
          enum:
            - Flat Fee
            - Per Unit
        startingUnit:
          type: number
          description: |
            The starting number of a range of units for the tier. This field is
            applicable for charges based on the Tiered Pricing or Tiered with
            Overage Pricing charge model.
        tier:
          type: integer
          format: int32
          description: |
            A unique number that identifies the tier that the price applies to.
        isDefault:
          type: boolean
          description: >
            Indicates whether the tier is the default tier. The default tier is
            the

            tier that is used when the usage does not fall into any of the
            defined

            tiers.
        productRatePlanChargeId:
          type: string
          description: |
            The unique identifier of the product rate plan charge that the tier
            belongs to.
        productChargeDefinitionId:
          type: string
          description: >
            The unique identifier of the product rate plan charge definition
            that

            the tier belongs to.
        productRatePlanCharge:
          $ref: '#/components/schemas/NestedPrpcOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Product Rate Plan Charge Tier object. Only the
          indexed custom fields with a specified value (not null) are returned.
          The name of each custom field has the form
          <code>*customField*__c</code>. Custom field names are case sensitive.
          See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryProductRatePlanChargeTierResponse
    ExpandedRamp:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the ramp.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the ramp.
        createdDate:
          type: string
          format: date-time
          description: |
            The time that the ramp gets created in the system, in the
            `YYYY-MM-DD HH:MM:SS` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the ramp.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the ramp was last updated.
        name:
          type: string
          description: |
            The name of the ramp.
        number:
          type: string
          description: >
            The number of the ramp. It is automaticcally generated by the
            billing system.
        description:
          type: string
          description: |
            The short description of the ramp.
        subscriptionNumbers:
          type: string
          description: >
            The number of the subscription that is considered as part of the
            ramp deal.
        chargeNumbers:
          type: string
          description: >
            The number of the rate plan charge. It can contain multiple charge
            numbers, separated by commas(`,`).
        orderId:
          type: string
          description: |
            The unique identifier of the order.
        grossTcb:
          description: The gross TCB value before discount charges are applied.
          type: number
        grossTcv:
          description: The gross TCV value before discount charges are applied.
          type: number
        netTcb:
          description: The net TCB value after discount charges are applied.
          type: number
        netTcv:
          description: The net TCV value after discount charges are applied.
          type: number
        discountTcb:
          description: The discount amount for the TCB.
          type: number
        discountTcv:
          description: The discount amount for the TCV.
          type: number
        metricsProcessingStatus:
          type: string
          description: |
            Status of the metrics processing. 
          enum:
            - Completed
            - NotStarted
      additionalProperties:
        type: object
        description: >
          Custom fields of the Ramp object. The name of each custom field has
          the form <code>*customField*__c</code>. Custom field names are case
          sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryRampResponse
    ExpandedRatePlan:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the rate plan.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the rate plan.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the rate plan.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan was last updated.
        productId:
          type: string
          description: |
            The unique identifier of the product associated with the rate plan.
        amendmentId:
          type: string
          description: >
            The unique identifier of the amendment made to the subscription.



            **Note**: This field is not available for single version
            subscriptions.
        amendmentType:
          type: string
          description: >
            The type of amendment associated with the rate plan. This field only
            applies to amendment rate plans.



            **Note**: This field is not available for single version
            subscriptions.
        name:
          type: string
          description: |
            The name of the rate plan.
        productRatePlanId:
          type: string
          description: >
            The unique identifier of the product rate plan that the rate plan is
            based on.
        subscriptionId:
          type: string
          description: >
            The unique identifier of the subscription associated with the rate
            plan.
        subscriptionOwnerId:
          type: string
          description: |
            The unique identifier of the account that owns the subscription.
        invoiceOwnerId:
          type: string
          description: |
            The unique identifier of the account that will pay the invoice.
        reverted:
          type: boolean
          description: |
            Indicates whether the rate plan has been reverted.
        externallyManagedPlanId:
          type: string
          description: >
            Indicates the unique identifier for the rate plan purchased on a

            third-party store. This field is used to represent a subscription
            rate

            plan created through third-party stores.
        originalRatePlanId:
          type: string
          description: >
            The original ID of the subscription rate plan, which is the ID of
            the subscription rate plan in the version-1 subscription.
        subscriptionOfferId:
          type: string
          description: >
            The unique identifier of the subscription offer associated with the
            rate plan.



            **Note**: This field is not available for single version
            subscriptions.
        subscriptionRatePlanNumber:
          type: string
          description: |
            The number of the rate plan in the subscription.
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        productRatePlan:
          $ref: '#/components/schemas/NestedProductRatePlanOnExpand'
        ratePlanCharges:
          type: array
          items:
            $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Rate Plan object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryRatePlanResponse
    NestedRatePlanOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the rate plan.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the rate plan.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the rate plan.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan was last updated.
        productId:
          type: string
          description: |
            The unique identifier of the product associated with the rate plan.
        amendmentId:
          type: string
          description: >
            The unique identifier of the amendment made to the subscription.



            **Note**: This field is not available for single version
            subscriptions.
        amendmentType:
          type: string
          description: >
            The type of amendment associated with the rate plan. This field only
            applies to amendment rate plans.



            **Note**: This field is not available for single version
            subscriptions.
        name:
          type: string
          description: |
            The name of the rate plan.
        productRatePlanId:
          type: string
          description: >
            The unique identifier of the product rate plan that the rate plan is
            based on.
        subscriptionId:
          type: string
          description: >
            The unique identifier of the subscription associated with the rate
            plan.
        subscriptionOwnerId:
          type: string
          description: |
            The unique identifier of the account that owns the subscription.
        invoiceOwnerId:
          type: string
          description: |
            The unique identifier of the account that will pay the invoice.
        externallyManagedPlanId:
          type: string
          description: >
            Indicates the unique identifier for the rate plan purchased on a

            third-party store. This field is used to represent a subscription
            rate

            plan created through third-party stores.
        originalRatePlanId:
          type: string
          description: >
            The original ID of the subscription rate plan, which is the ID of
            the subscription rate plan in the version-1 subscription.
        subscriptionOfferId:
          type: string
          description: >
            The unique identifier of the subscription offer associated with the
            rate plan.



            **Note**: This field is not available for single version
            subscriptions.
        subscriptionRatePlanNumber:
          type: string
          description: |
            The number of the rate plan in the subscription.
        subscription:
          type: object
          description: |
            The subscription associated with the rate plan.
        productRatePlan:
          type: object
          description: |
            The product rate plan associated with the rate plan.
        reverted:
          type: boolean
          description: |
            Indicates whether the rate plan has been reverted.
        ratePlanCharges:
          type: array
          items:
            type: object
          description: |
            The rate plan charges on the rate plan.
      additionalProperties:
        type: object
        description: >
          Custom fields of the Rate Plan object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryRatePlanResponse
    ExpandedRatePlanCharge:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the rate plan charge.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the rate plan charge.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan charge was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the rate plan
            charge.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan charge was last updated.
        ratePlanId:
          type: string
          description: >
            The unique identifier of the rate plan to which this rate plan
            charge belongs.
        productRatePlanChargeId:
          type: string
          description: >
            The unique identifier of the product rate plan charge associated
            with this product rate plan charge.
        accountingCode:
          description: >
            The accounting code for the charge. Accounting codes group
            transactions that contain similar accounting attributes.


            **Values**: inherited from `ProductRatePlanCharge.AccountingCode`


            **Note**: This value changes if
            `ProductRatePlanCharge.AccountingCode` is updated.

            The values of `UpdatedById` and `UpdatedDate` for the
            `RatePlanCharge` do not change when
            `ProductRatePlanCharge.AccountingCode` is updated. 
          type: string
        applyDiscountTo:
          description: |
            Specifies the type of charges a specific discount applies to. 

            **Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` 
          type: string
        billCycleDay:
          type: integer
          format: int64
          description: >
            Indicates the charge's billing cycle day (BCD), which is

            when bill runs generate invoices for charges associated with the
            product

            rate plan charge or the account. 


            **Values**: inherited from `ProductRatePlanCharge.BillCycleDay` 
        billCycleType:
          type: string
          description: >
            Specifies how to determine the billing day for the charge.


            **Values**: inherited from `ProductRatePlanCharge.BillCycleType`

            **Note:** You can override the value inherited from the Product Rate

            Plan Charge, but only when creating a new subscription or a New
            Product

            amendment. 
        billingPeriod:
          type: string
          description: >
            Allows billing period to be overridden on rate plan Charge.


            **Values**: **inherited from `ProductRatePlanCharge.BillingPeriod`


            **Note:**

            You can override the value inherited from the Product Rate Plan
            Charge,

            but only when creating a new subscription or a New Product
            amendment. 
        billingPeriodAlignment:
          type: string
          description: >
            Aligns charges within the same subscription if multiple charges

            begin on different dates.


            **Values**: inherited from
            `ProductRatePlanCharge.BillingPeriodAlignment` 
        billingTiming:
          type: string
          description: >
            The billing timing for the charge. You can choose to bill in advance
            or in arrears for recurring charge types. This field is not used in
            one-time or usage based charge types.


            **Note:** You can override the value inherited from the Product Rate
            Plan Charge when a subscription has a recurring charge type.
          enum:
            - In Advance
            - In Arrears
        chargedThroughDate:
          type: string
          format: date
          description: |
            The date through which a customer has been billed for the charge.
          maxLength: 29
        chargeModel:
          type: string
          description: |
            Determines how to evaluate charges. Charge models must be
            individually activated in the web-based UI.

            **Values**: inherited from `ProductRatePlanCharge.ChargeModel` 
        chargeNumber:
          description: >
            A unique number that identifies the charge. This number is returned
            as a string.


            **Values**: one of the following:

            - automatically generated if left `null`

            - a unique number of 50 characters or fewer
          type: string
        chargeType:
          type: string
          description: |
            Specifies the type of charge.

            **Values**: inherited from `ProductRatePlanCharge.ChargeType`
        description:
          type: string
          description: |
            A description of the rate plan charge. 
        discountLevel:
          type: string
          description: >
            Application scope of the discount charge. For example, if the value
            of this field is `subscription` and the value of the
            `applyDiscountTo` field is `RECURRING`, the discount charge applies
            to all recurring charges in the same subscription as the discount
            charge.
          enum:
            - rateplan
            - subscription
            - account
        dMRC:
          type: number
          description: |
            A delta monthly recurring charge is the change in monthly
            recurring revenue caused by an amendment or a new subscription. 

            **Character limit**: 16 
            **Values**: automatically generated
        drawdownRate:
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            The [conversion

            rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion)

            between Usage UOM and Drawdown UOM for a [drawdown

            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).

            Must be a positive number (>0).
          type: number
        dTCV:
          type: number
          description: |
            After an Amendment, the change in the total contract value
            (TCV) amount for this charge, compared with its previous value.

            **Character limit**: 16
            **Values**: automatically generated 
        effectiveEndDate:
          type: string
          format: date
          description: >
            Start date when the rate plan charge becomes active, as
            `yyyy-mm-dd`.
        effectiveStartDate:
          type: string
          format: date
          description: |
            Final date the rate plan is active, as `yyyy-mm-dd`.
        endDateCondition:
          description: >
            Condition for the charge to become inactive.



            - If the value of this field is `FixedPeriod`, the charge is active
            for a

            predefined duration based on the value of the `upToPeriodsType` and

            `upToPeriods` fields.


            - If the value of this field is `SpecificEndDate`, use the

            `specificEndDate` field to specify the date when the charge becomes

            inactive.
          enum:
            - SubscriptionEnd
            - FixedPeriod
            - SpecificEndDate
            - OneTime
          type: string
        estimatedStartDate:
          type: string
          format: date
          description: >
            The estimated start date of the pending charge in an active
            subscription.


            The value must be a date within the subscription term. The system
            will then automatically calculate the estimated end date for the
            pending charge. The estimated start and end dates are used to manage
            the estimated charge duration and forecast the revenue for the
            pending charge. 


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        estimatedEndDate:
          type: string
          format: date
          description: >
            The estimated end date of the pending charge in an active
            subscription.


            The system automatically calculates the estimated end date for the
            pending charge. The estimated start and end dates are used to manage
            the estimated charge duration and forecast the revenue for the
            pending charge. 


            **Note:** This field is available only when the Pending Subscription
            Processing feature is turned on.
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charge related invoice items, invoice
            item adjustments, credit memo items, and debit memo items from
            revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBillingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge. In addition, if the
            `excludeItemBookingFromRevenueAccounting` field in an Create
            Subscription or Add Product order action is set to `false`, you must
            also set the `excludeItemBillingFromRevenueAccounting` field in this
            order action to `false`.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        excludeItemBookingFromRevenueAccounting:
          default: false
          description: >
            The flag to exclude rate plan charges from revenue accounting.


            If both the following features are enabled in your tenant, you must
            ensure the `excludeItemBookingFromRevenueAccounting` field is set
            consistently for a prepayment charge and the corresponding drawdown
            charge.
              * Prepaid with Drawdown
              * Unbilled Usage

            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue"
            target="_blank">Order to Revenue</a> or [Zuora Billing - Revenue
            Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration)
            feature enabled. 
          type: boolean
        invoiceScheduleId:
          type: string
          description: >
            The unique identifier of the invoice schedule associated with the
            subscription.
        isLastSegment:
          type: boolean
          description: |
            Indicates if the segment of the rate plan charge is the most
            recent segment.

            **Character limit**: 5
            **Values**: automatically generated.
        isPrepaid:
          type: boolean
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.



            Indicates whether this charge is a prepayment (topup) charge or a

            drawdown charge. 
        isRollover:
          type: boolean
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            It determines whether the rollover fields are needed.
        rolloverPeriods:
          type: integer
          format: int64
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the number of rollover periods, it is restricted
            to 3.
        rolloverPeriodLength:
          type: integer
          format: int32
          nullable: true
          description: >
            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature enabled.


            Use this field when you want to set the rollover fund's period
            length shorter than the prepayment charge's validity period. In this
            case, you must set the `rolloverPeriods` field to 1. For example,
            you can define the rollover fund's period length as 5 months,
            shorter than the prepayment charge's validity period: a year.
        rolloverApply:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            This field defines the priority of rollover, which is either first
            or last.
          enum:
            - ApplyFirst
            - ApplyLast
        isProcessed:
          type: boolean
          description: |
            Indicates whether the rate plan charge has been processed.
        listPriceBase:
          type: string
          description: |
            The list price base for the product rate plan charge.
          enum:
            - Per Billing Period
            - Per Month
            - Per Week
            - Per Year
            - Per Specific Months
        specificListPriceBase:
          type: integer
          format: int32
          description: >
            The number of months for the list price base of the charge. This
            field is required if you set the value of the `ListPriceBase` field
            to `Per Specific Months`.


            **Notes**: 
              - This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/I_Annual_List_Price" target="_blank">Annual List Price</a> feature enabled.
              - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`.
          maximum: 200
          minimum: 1
          nullable: true
        priceUpsellQuantityStacked:
          type: boolean
        commitmentType:
          description: >
            **Note**: This field is only available if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a> feature enabled.


            To use this field, you must set the `X-Zuora-WSDL-Version` request
            header to `133` or higher. Otherwise, an error occurs. 


            This field defines the type of commitment. A prepaid charge can be
            `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can
            only be `CURRENCY` type. For topup(recurring or one-time) charges,
            this field indicates what type of funds are created. 

            * If UNIT, it will create a fund with given prepaidUom.

            * If CURRENCY, it will create a fund with the currency amount
            calculated in list price.
              
            For drawdown(usage) charges, this field indicates what type of funds
            are drawdown from that created from topup charges.
          enum:
            - UNIT
            - CURRENCY
          type: string
        isCommitted:
          type: boolean
          description: |
            Indicates whether the rate plan charge is commited.
        mRR:
          type: number
          description: >
            Monthly recurring revenue (MRR) is the amount of recurring

            charges in a given month. The MRR calculation doesn't include
            one-time

            charges nor usage charges.


            **Character limit**: 16

            **Values**: automatically generated 
        name:
          type: string
          description: |
            The name of the rate plan charge.

            **Character limit**: 100
            **Values**: automatically generated 
        numberOfPeriods:
          type: integer
          format: int64
          description: |
            Specifies the number of periods to use when calculating charges
            in an overage smoothing charge model.

            **Character limit**: 5
            **Values**: inherited from `ProductRatePlanCharge.NumberOfPeriod`
        originalId:
          type: string
          description: |
            The original ID of the rate plan charge.

            **Character limit**: 32
            **Values**: automatically generated
        overageCalculationOption:
          type: string
          description: >
            Determines when to calculate overage charges. If the value

            of the SmoothingMode field is null (not specified and not inherited
            from

            ProductRatePlanCharge.SmoothingMode), the value of this field is
            ignored.


            **Character limit**: 20

            **Values**: inherited from
            `ProductRatePlanCharge.OverageCalculationOption`
        overageUnusedUnitsCreditOption:
          type: string
          description: >
            Determines whether to credit the customer with unused units

            of usage.


            **Character limit**: 20

            **Values**: inherited from
            `ProductRatePlanCharge.OverageUnusedUnitsCreditOption`
        prepaidOperationType:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The type of this charge. It is either a prepayment (topup) charge or
            a drawdown charge. 
          enum:
            - topup
            - drawdown
            - null
          type: string
          nullable: true
        prepaidQuantity:
          type: number
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The number of units included in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
            Must be a positive number (>0).
          nullable: true
        prepaidTotalQuantity:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The total amount of units that end customers can use during a
            validity period when they subscribe to a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: number
          nullable: true
        priceChangeOption:
          type: string
          description: >
            Applies an automatic price change when a termed subscription is
            renewed.


            **Values**: one of the following:


            - `NoChange` (default)

            - `SpecificPercentageValue`

            - `UseLatestProductCatalogPricing`
        priceIncreasePercentage:
          type: number
          format: double
          description: |
            Specifies the percentage to increase or decrease the price
            of renewed subscriptions.

            **Character limit**: 16
            **Values**: a decimal value between -100 and 100
        processedThroughDate:
          type: string
          format: date
          description: >
            The date until when charges have been processed. When billing

            in arrears, such as usage, this field value is the the same as the
            `ChargedThroughDate`

            value. This date is the earliest date when a charge can be amended.


            **Character limit**: 29

            **Values**: automatically generated
        prorationOption:
          type: string
          description: >
            Determines how to prorate charges when a subscription is created or
            amended.
        quantity:
          type: number
          description: >
            The default quantity of units, such as the number of authors

            in a hosted wiki service. Valid for all charge models except for
            Flat

            Fee pricing.


            **Character limit**: 16

            **Values**: a valid quantity value
        numberOfDeliveries:
          type: number
          description: >
            Number of deliveries in the billing period for the charge segment.


            The `numberOfDeliveries` is used for the Delivery Pricing charge
            model only. 


            **Note**: The Delivery Pricing charge model is in the **Early
            Adopter** phase. We are actively soliciting feedback from a small
            set of early adopters before releasing it as generally available. To
            manage and access this feature through the self-service interface,
            see [Enable billing features by
            yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)
            in the Knowledge Center. You can check **Delivery Pricing** in
            **Billing Settings** > **Enable Charge Types / Models**.
        ratingGroup:
          type: string
          description: >
            A rating group based on which usage records are rated. Only

            applicable to Usage charges.


            Possible values:

            - `ByBillingPeriod`: The rating is based on all the usages in a
            billing period.

            - `ByUsageStartDate`: The rating is based on all the usages on the
            same usage start date.

            - `ByUsageRecord`: The rating is based on each usage record.

            - `ByUsageUpload`: The rating is based on all the  usages in a
            uploaded usage file (`.xls` or `.csv`).

            - `ByGroupId`: The rating is based on all the usages in a custom
            group.


            For more information, see [Usage rating by
            group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group).
          enum:
            - ByBillingPeriod
            - ByUsageStartDate
            - ByUsageRecord
            - ByUsageUpload
            - ByGroupId
        revenueRecognitionRuleName:
          type: string
          description: >
            Specifies the Revenue Recognition Rule that you want the

            Rate Plan Charge to use. This field can be updated when **Status**
            is

            `Draft`. By default, the Revenue Recognition Rule is inherited from

            the Product Rate Plan Charge. For Amend calls, you can use this
            field

            only for NewProduct amendments. For Update calls, you can use this
            field

            only to update subscriptions in draft status. Note that if you use
            this

            field to specify a Revenue Recognition Rule for the Rate Plan
            Charge,

            the rule will remain as specified even if you later change the rule

            used by the corresponding Product Rate Plan Charge.


            **Character limit**: n/a

            **Values**: inherited from
            `ProductRatePlanCharge.RevenueRecognitionRuleName` or the name of an
            active Revenue Recognition Rule


            **Note**: Unless overridden, this value changes if
            `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated.

            The values of `UpdatedById` and `UpdatedDate` for the
            `RatePlanCharge` do not change when
            `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated.
        revenueRecognitionTiming:
          description: >
            Specifies the type of revenue recognition timing.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Upon Billing Document Posting Date
            - Upon Order Activation Date
        revenueAmortizationMethod:
          description: >
            Specifies the type of revenue amortization method.


            Predefined options are listed as enum values in this API Reference.
            Other options might also be avaliable depending on the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Enable_Order_to_Revenue/Configure_revenue_settings/Configure_revenue_recognition_policy"
            target="_blank">revenue recognition policy configuration</a> in the
            Zuora Billing UI.


            **Note**: This field is only available if you have the Order to
            Revenue feature enabled. 
          maxLength: 200
          type: string
          enum:
            - Immediate
            - Ratable Using Start And End Dates
        revRecCode:
          type: string
          description: >
            Associates this product rate plan charge with a specific revenue
            recognition code.


            **Character limit**: 70

            **Values**: inherited from `ProductRatePlanCharge.RevRecCode` or a
            valid revenue recognition code


            **Note**: Unless overridden, this value changes if
            `ProductRatePlanCharge.RevRecCode` is updated.

            The values of `UpdatedById` and `UpdatedDate` for the
            `RatePlanCharge` do not change when
            `ProductRatePlanCharge.RevRecCode` is updated.
        revRecTriggerCondition:
          type: string
          description: >
            Specifies when revenue recognition begins.


            **Character limit**: 22

            **Values**: inherited from
            `ProductRatePlanCharge.RevRecTriggerCondition` or one of the
            following:


            -  `ContractEffectiveDate`

            -  `ServiceActivationDate`

            -  `CustomerAcceptanceDate`


            Note: Unless overridden, this value changes if
            `ProductRatePlanCharge.RevRecTriggerCondition` is updated.

            The values of `UpdatedById` and `UpdatedDate` for the
            `RatePlanCharge` do not change when
            `ProductRatePlanCharge.RevRecTriggerCondition` is updated. "
        segment:
          type: integer
          format: int32
          description: |
            The identifying number of the subscription rate plan segment.
            Segments are numbered sequentially, starting with 1.

            **Character limit**: 2
            **Values**: automatically generated
        specificBillingPeriod:
          type: integer
          format: int64
          description: >
            Customizes the number of months or weeks for the charges

            billing period. This field is required if you set the value of the
            BillingPeriod

            field to `Specific Months` or `Specific Weeks`.


            **Character limit**: 5

            **Values**: inherited from `ProductRatePlanCharge.BillingPeriod`


            **Note:** You can override the value inherited from the Product Rate
            Plan Charge, but only when creating a new subscription or a New
            Product amendment.
        specificEndDate:
          type: string
          format: date
          description: >
            The specific date on which the charge ends, in `yyyy-mm-dd` format.


            **Character limit**: 29 


            **Note**:


            - This field is only applicable when the `EndDateCondition` field is
            set to `SpecificEndDate`.

            - If the subscription ends before the specific end date, the charge
            ends when the subscription ends. But if the subscription end date is
            subsequently changed through a Renewal, or Terms and Conditions
            amendment, the charge will end on the specific end date.
        tCV:
          description: >
            The total contract value (TCV) is the value of a single rate

            plan charge in a subscription over the lifetime of the subscription.

            This value does not represent all charges on the subscription. The
            TCV

            includes recurring charges and one-time charges, but it doesn't
            include

            usage charge.


            **Character limit**: 16

            **Values**: automatically generated
          format: double
          type: number
        triggerDate:
          description: |
            The date when the charge becomes effective and billing begins,
            in `yyyy-mm-dd` format. This field is required if the `TriggerEvent`
            field value is `SpecificDate`.

            **Character limit**: 29
          format: date
          type: string
        triggerEvent:
          description: >
            Specifies when to start billing the customer for the charge.

            **Note: **This field can be passed through the Subscribe and Amend
            calls and will override the default value set on the Product Rate
            Plan Charge.


            **Character limit**: 18

            **Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and
            can be one of the following values:


            - `ContractEffective` is the date when the subscription's contract
            goes into effect and the charge is ready to be billed.

            - `ServiceActivation` is when the services or products for a
            subscription have been activated and the customers have access.

            - `CustomerAcceptance` is when the customer accepts the services or
            products for a subscription.

            - `SpecificDate` is valid only on the RatePlanCharge.
          type: string
        uOM:
          description: |
            Specifies the units to measure usage.

            **Character limit**: 25
            **Values**: inherited from `ProductRatePlanCharge.UOM`
          type: string
        upToPeriods:
          type: integer
          format: int64
          description: >
            Specifies the length of the period during which the charge is
            active. If this period ends before the subscription ends, the charge
            ends when this period ends.


            **Character limit**: 5 


            **Values**: inherited from `ProductRatePlanCharge.UpToPeriods`
            **Note**:


            - You must use this field together with the `UpToPeriodsType` field
            to specify the time period. This field is only applicable only when
            the `EndDateCondition` field is set to `FixedPeriod`.

            - You can override the value inherited from the Product Rate Plan
            Charge, but only when creating a new subscription or a New Product
            amendment.

            - Use this field to override the value in
            `ProductRatePlanCharge.UpToPeriod`.

            - If you override the value in this field, enter a whole number
            between 0 and 65535, exclusive.

            - If the subscription end date is subsequently changed through a
            Renewal, or Terms and Conditions amendment, the charge end date will
            change accordingly up to the original period end.
        upToPeriodsType:
          type: string
          description: >
            The period type used to define when the charge ends. This field can
            be updated when **Status** is `Draft`. 


            **Note**:


            - You must use this field together with the `UpToPeriods` field to
            specify the time period.

            - This field is only applicable only when the `EndDateCondition`
            field is set to `FixedPeriod`.
          enum:
            - Billing Periods
            - Days
            - Weeks
            - Months
            - Years
          default: Billing Periods
        version:
          type: integer
          format: int64
          description: |
            The version of the rate plan charge. Each time a charge is
            amended, Zuora creates a new version of the rate plan charge.

            **Character limit**: 5
            **Values**: automatically generated.
        weeklyBillCycleDay:
          description: >
            Specifies which day of the week as the bill cycle day (BCD) for the
            charge.
          type: string
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
        subscriptionId:
          type: string
          description: >
            The unique identifier of the subscription to which the rate plan
            charge belongs.
        subscriptionOwnerId:
          type: string
          description: |
            ID of the account that owns the subscription.
        invoiceOwnerId:
          type: string
          description: >
            ID of the account that will pay the billing documents for the
            subscription.
        originalOrderDate:
          type: string
          format: date
          description: >
            The date when the rate plan charge is created through an order or
            amendment. This field is to standardize the booking date information
            to increase audit ability and traceability of data between Zuora
            Billing and Zuora Revenue. It is mapped as the booking date for a
            sales order line in Zuora Revenue.
        amendedByOrderOn:
          type: string
          format: date
          description: |
            The date when the rate plan charge is amended through an order
            or amendment. This field is to standardize the booking date
            information to increase audit ability and traceability of data
            between Zuora Billing and Zuora Revenue. It is mapped as the
            booking date for a sale order line in Zuora Revenue.
        validityPeriodType:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            The period in which the prepayment units are valid to use as defined
            in a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          enum:
            - SUBSCRIPTION_TERM
            - ANNUAL
            - SEMI_ANNUAL
            - QUARTER
            - MONTH
        creditOption:
          type: string
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled. 


            The way to calculate credit. See [Credit
            Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option)
            for more information.
          enum:
            - TimeBased
            - ConsumptionBased
            - FullCreditBack
        applyToBillingPeriodPartially:
          type: boolean
          description: >
            Allow the discount duration to be aligned with the billing period
            partially.


            **Note**: You must enable the [Enhanced
            Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount)
            feature to access this field.
        productChargeDefinitionId:
          type: string
          description: |
            The unique ID of the product charge definition.
        accountReceivableAccountingCodeId:
          description: >
            ID of the accountReceivableAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a>, <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a>, and <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Get_started_with_Invoice_Settlement/AA_Overview_of_Invoice_Settlement"
            target="_blank">Invoice Settlement</a> features are enabled.
          type: string
        deferredRevenueAccountingCodeId:
          description: >
            ID of the deferredRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        recognizedRevenueAccountingCodeId:
          description: >
            ID of the recognizedRevenueAccountingCode of a standalone charge.


            **Note:** This field is available when the <a
            href="https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/overview-of-standalone-orders"
            target="_blank">Standalone Orders</a> and <a
            href="https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance"
            target="_blank">Zuora Finance</a> features are enabled.
          type: string
        prepaidUOM:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            Unit of measurement for a [prepayment
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge).
          type: string
        drawdownUom:
          description: >
            **Note**: This field is only available if you have the [Prepaid with
            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)
            feature enabled.


            Unit of measurement for a [drawdown
            charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge).
          type: string
        salesPrice:
          type: number
          description: >
            The sales price associated with the rate plan charge expressed as a
            decimal.


            **Notes**:
              - This field is only available to subscriptions that are created through orders and exist after 2023-01-10.
              - This field applies to the following charge models, and the values vary with the charge models:
                - Flat fee: the value equals the value of the `price` field.
                - Per unit: the value equals `price` multiplied by `quantity`.
                - Fixed amount discount: the value equals the value of the `discountAmount` field.
                - Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit.
                - Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit.
        taxable:
          type: boolean
          description: |
            Indicates whether the rate plan charge is taxable.
        reverted:
          type: boolean
          description: |
            Indicates whether the rate plan charge has been reverted.
        reflectDiscountInNetAmount:
          type: boolean
          description: |
            Indicates whether the discount is reflected in the net amount.
        ratePlan:
          $ref: '#/components/schemas/NestedRatePlanOnExpand'
        productRatePlanCharge:
          $ref: '#/components/schemas/NestedPrpcOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Rate Plan Charge object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryRatePlanChargeResponse
    ExpandedRatePlanChargeTier:
      properties:
        currency:
          type: string
          description: |
            The currency of the rate plan charge tier.
        discountAmount:
          type: number
          description: |
            The discount amount if it is a amount-based discount.
        discountPercentage:
          type: number
          description: |
            The discount percentage if it is a percentage-based discount.
        endingUnit:
          type: number
          description: |
            The ending number of a range of units for the tier.
        includedUnits:
          type: number
          description: |
            The number of units included in the tier.
        overagePrice:
          type: number
          description: >
            The overage price. An overage occurs when usage surpasses the last
            defined tier. 

            This field is applicable only to tier pricing and volume pricing
            models.
        price:
          type: number
          description: >
            The price of the tier if the charge is a flat fee, or the price of
            each unit in the tier if the change model is tiered pricing.
        priceFormat:
          type: string
          description: |
            Indicates if the price is a flat fee or is per unit.
          enum:
            - Per Unit
            - Flat Fee
        startingUnit:
          type: number
          description: |
            The start number of a range of units for the tier.
        tier:
          type: integer
          format: int64
          description: |
            A unique number that identifies the tier that the price applies to.
        id:
          type: string
          description: |
            The unique identifier of the rate plan charge tier.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the rate plan charge
            tier.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan charge tier was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the rate plan
            charge tier.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the rate plan charge tier was last updated.
        ratePlanChargeId:
          type: string
          description: >
            The unique identifier of the rate plan charge to which the rate plan
            charge tier belongs.
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
      type: object
      title: QueryRatePlanChargeTierResponse
      additionalProperties: true
    ExpandedRatingResult:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the rating result.
        createdByID:
          type: string
          description: |
            The unique identifier of the user who created the rating result.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the rating result was created in the Zuora
            system, in the `yyyy-mm-dd hh:mm:ss` format.
        updatedByID:
          type: string
          description: >
            The unique identifier of the user who last updated the rating
            result.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the rating result was last updated, in the
            `yyyy-mm-dd hh:mm:ss` format.
        accountId:
          type: string
          description: >
            The unique identifier of the customer account associated with the
            rating result.
        subscriptionId:
          type: string
          description: >
            The unique identifier of the subscription associated with the rating
            result.
        ratePlanChargeId:
          type: string
          description: >
            The unique identifier of the rate plan charge associated with the
            rating result.
        quantity:
          type: number
          description: |
            The quantity of the charge.
        amount:
          type: number
          description: |
            The amount of the charge.
        serviceStartDate:
          type: string
          format: date
          description: |
            The start date of the service period for the rating result.
        serviceEndDate:
          type: string
          format: date
          description: |
            The end date of the service period for the rating result.
        status:
          type: string
          description: |
            The status of the rating result.
        isPartial:
          type: boolean
          description: |
            Indicates whether the rating result is partial.
        chargeSegmentNumber:
          type: integer
          format: int32
          description: |
            Rate plan charge number.
        invoiceItemId:
          type: string
          description: >
            The unique identifier of the invoice item associated with the rating
            result.
        actualPeriodStartDate:
          type: string
          format: date
          description: |
            The start date of the actual period for the rating result.
        actualPeriodEndDate:
          type: string
          format: date
          description: |
            The end date of the actual period for the rating result.
        billingCycleDay:
          type: integer
          format: int32
          description: |
            The day of the month on which the billing cycle starts.
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        ratePlanCharge:
          $ref: '#/components/schemas/NestedRatePlanChargeOnExpand'
        subscription:
          $ref: '#/components/schemas/NestedSubscriptionOnExpand'
        invoiceItem:
          $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
      type: object
      title: QueryRatingResultResponse
      additionalProperties: false
    NestedRefundApplicationOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the refund application.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the refund
            application.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the refund
            application.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application was last updated.
        accountId:
          type: string
          description: |
            The ID of the account associated with this refund application. 
        applicationGroupId:
          type: string
          description: >
            The ID of the application group to which this payment application
            belongs.
        applyAmount:
          type: number
          description: |
            The total amount of the refund to be applied.
          format: double
        creditMemoId:
          type: string
          description: >
            The unique identifier of the credit memo to which the associated
            payment was applied.
        effectiveDate:
          type: string
          format: date
          description: |
            The date when the refund application becomes effective.
        invoiceId:
          type: string
          description: >
            The unique identifier of the invoice to which the associated payment
            was applied.
        paymentId:
          type: string
          description: >
            The unique identifier of the payment associated with the refund
            application.
        refundId:
          type: string
          description: >
            The unique identifier of the refund associated with the refund
            application.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The Account Receivable accounting code of a standalone charge.
        onAccountAccountingCodeId:
          description: |
            The accounting code that maps to an on account in your accounting
            system.
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
          description: |
            The accounting code for the unapplied payment.
        cashAccountingCodeId:
          type: string
          description: |
            The accounting code for cash payments.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        refund:
          type: object
          description: |
            The refund associated with the refund application.
        payment:
          type: object
          description: |
            The payment associated with the refund application.
        refundApplicationItems:
          type: array
          items:
            type: object
          description: |
            The refund application items contained in the refund application.
      type: object
      title: QueryRefundApplicationResponse
      additionalProperties: false
    ExpandedRefund:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the refund.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the refund.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the refund.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund was last updated.
        accountId:
          description: >
            The ID of the account associated with this refund. Zuora associates
            the refund automatically with the account from the associated
            payment or credit memo.
          type: string
        amount:
          description: |
            The total amount of the refund.
          format: double
          type: number
        cancelledOn:
          description: >
            The date and time when the refund was cancelled, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        comment:
          description: |
            Comments about the refund.
          type: string
          nullable: true
        paymentMethodSnapshotId:
          type: string
          description: >
            The unique ID of the payment method snapshot which is a copy of the
            particular payment method used in a transaction.
        accountingCode:
          type: string
          description: >
            The accounting code that maps to this refund transaction in your
            accounting

            system.
        currency:
          type: string
          description: |
            The currency of the refund.
        gatewayReconciliationReason:
          description: |
            The reason of gateway reconciliation.
          type: string
        gatewayReconciliationStatus:
          description: |
            The status of gateway reconciliation.
          type: string
        gatewayResponse:
          description: |
            The message returned from the payment gateway for the refund. This
            message is gateway-dependent.
          type: string
        gatewayResponseCode:
          description: |
            The code returned from the payment gateway for the refund. This code
            is gateway-dependent.
          type: string
        gatewayState:
          description: |
            The status of the refund in the gateway. 
          enum:
            - MarkedForSubmission
            - Submitted
            - Settled
            - NotSubmitted
            - FailedToSettle
          type: string
        markedForSubmissionOn:
          description: >
            The date and time when a refund was marked and waiting for batch
            submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.
          format: date-time
          type: string
        methodType:
          description: |
            How an external refund was issued to a customer. 
          enum:
            - ACH
            - Cash
            - Check
            - CreditCard
            - PayPal
            - WireTransfer
            - DebitCard
            - CreditCardReferenceTransaction
            - BankTransfer
            - Other
          type: string
        paymentMethodId:
          type: string
          description: >
            The unique ID of the payment method that the customer used to make
            the refund.
        payoutId:
          type: string
          description: |
            The payout ID of the refund from the gateway side.
        reasonCode:
          type: string
          description: |
            A code identifying the reason for the transaction.
        refundNumber:
          type: string
          description: |
            The number of the refund.
        referenceID:
          description: >
            The transaction ID returned by the payment gateway for an electronic
            refund. Use this field to reconcile refunds between your gateway and
            Zuora Payments.
          type: string
        refundDate:
          description: >
            The date when the refund takes effect, in `yyyy-mm-dd` format. For
            example, 2017-03-01.
          format: date
          type: string
        refundTransactionTime:
          description: >
            The date and time when the refund was issued, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
          type: string
        sourceType:
          type: string
          description: >
            Specifies whether the refund is a refund payment or a credit
            balance. 
          enum:
            - Payment
            - CreditBalance
            - CreditMemo
        secondRefundReferenceId:
          description: >
            The transaction ID returned by the payment gateway if there is an
            additional transaction for the refund. Use this field to reconcile
            payments between your gateway and Zuora Payments.
          type: string
        settledOn:
          description: >
            The date and time when the refund was settled in the payment
            processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by
            the Spectrum gateway only and not applicable to other gateways.
          format: date-time
          type: string
        softDescriptor:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        softDescriptorPhone:
          description: |
            A payment gateway-specific field that maps Zuora to other gateways.
          type: string
        status:
          description: |
            The status of the refund. 
          enum:
            - Processed
            - Canceled
            - Error
            - Processing
          type: string
        submittedOn:
          type: string
          description: >
            The date and time when the refund was submitted, in `yyyy-mm-dd
            hh:mm:ss` format.
          format: date-time
        transferredToAccounting:
          description: >
            Whether the refund was transferred to an external accounting system.
            Use this field for integration with accounting systems, such as
            NetSuite. 
          enum:
            - Processing
            - 'Yes'
            - 'No'
            - Error
            - Ignore
          type: string
        type:
          type: string
          description: |
            The type of the refund. 
          enum:
            - External
            - Electronic
        associatedTransactionNumber:
          type: string
          description: |
            The number of the associated transactions, such as payments.
        gateway:
          type: string
          description: >
            The gateway that processed the original payment. A gateway is an
            online service provider that connects an online shopping cart to a
            payment processor.

            Zuora uses this same gateway for the corresponding refund. 

            If this payment gateway is no longer active, then the electronic
            refund fails. 
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        paymentMethod:
          $ref: '#/components/schemas/NestedPaymentMethodOnExpand'
        refundApplications:
          type: array
          items:
            $ref: '#/components/schemas/NestedRefundApplicationOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Refund object. Only the indexed custom fields
          with a specified value (not null) are returned. The name of each
          custom field has the form <code>*customField*__c</code>. Custom field
          names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryRefundResponse
    NestedRefundApplicationItemOnExpand:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the refund application item.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the refund application
            item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application item was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the refund
            application item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application item was last updated.
        amount:
          type: number
          description: |
            The amount of the refund application item.
        effectiveDate:
          type: string
          format: date
          description: |
            The date when the refund application item becomes effective.
        applicationGroupId:
          type: string
          description: >
            The ID of the application group to which this refund application
            belongs.
        refundApplicationId:
          type: string
          description: >
            The ID of the refund application to which this refund application
            item belongs.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The Account Receivable accounting code of a standalone charge.
        onAccountAccountingCodeId:
          description: >
            The accounting code that maps to an on account in your accounting
            system.
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
          description: |
            The accounting code for the unapplied payment.
        cashAccountingCodeId:
          type: string
          description: |
            The accounting code for cash payments.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        creditTaxationItemId:
          type: string
          description: >
            The unique identifier of the credit taxation item to which the
            refund application item is applied.
        creditMemoItemId:
          type: string
          description: >
            The unique identifier of the credit memo item to which the refund
            application item is applied.
        refundApplication:
          type: object
          description: >
            The refund application object that contains the refund application
            item.
      type: object
      title: QueryRefundApplicationItemResponse
      additionalProperties: false
    ExpandedRefundApplication:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the refund application.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the refund
            application.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the refund
            application.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application was last updated.
        accountId:
          type: string
          description: |
            The ID of the account associated with this refund application. 
        applicationGroupId:
          type: string
          description: >
            The ID of the application group to which this payment application
            belongs.
        applyAmount:
          type: number
          description: |
            The total amount of the refund to be applied.
          format: double
        creditMemoId:
          type: string
          description: >
            The unique identifier of the credit memo to which the associated
            payment was applied.
        effectiveDate:
          type: string
          format: date
          description: |
            The date when the refund application becomes effective.
        invoiceId:
          type: string
          description: >
            The unique identifier of the invoice to which the associated payment
            was applied.
        paymentId:
          type: string
          description: >
            The unique identifier of the payment associated with the refund
            application.
        refundId:
          type: string
          description: >
            The unique identifier of the refund associated with the refund
            application.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The accountReceivableAccountingCode of a standalone charge.
        onAccountAccountingCodeId:
          description: |
            The accounting code that maps to an on account in your accounting
            system.
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
          description: |
            The accounting code for the unapplied payment.
        cashAccountingCodeId:
          type: string
          description: |
            The accounting code for cash payments.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        refund:
          $ref: '#/components/schemas/NestedRefundOnExpand'
        payment:
          $ref: '#/components/schemas/NestedPaymentOnExpand'
        refundApplicationItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedRefundApplicationItemOnExpand'
      type: object
      title: QueryRefundApplicationResponse
      additionalProperties: false
    ExpandedRefundApplicationItem:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the refund application item.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the refund application
            item.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application item was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the refund
            application item.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the refund application item was last updated.
        amount:
          type: number
          description: |
            The amount of the refund application item.
        effectiveDate:
          type: string
          format: date
          description: |
            The date when the refund application item becomes effective.
        applicationGroupId:
          type: string
          description: >
            The ID of the application group to which this refund application
            belongs.
        refundApplicationId:
          type: string
          description: >
            The ID of the refund application to which this refund application
            item belongs.
        accountReceivableAccountingCodeId:
          type: string
          description: |
            The Account Receivable accounting code of a standalone charge.
        onAccountAccountingCodeId:
          description: >
            The accounting code that maps to an on account in your accounting
            system.
          type: string
        unappliedPaymentAccountingCodeId:
          type: string
          description: |
            The accounting code for the unapplied payment.
        cashAccountingCodeId:
          type: string
          description: |
            The accounting code for cash payments.
        journalEntryId:
          type: string
          description: |
            The ID of the journal entry that corresponds to this transaction.
        creditTaxationItemId:
          type: string
          description: >
            The unique identifier of the credit taxation item to which the
            refund application item is applied.
        creditMemoItemId:
          type: string
          description: >
            The unique identifier of the credit memo item to which the refund
            application item is applied.
        refundApplication:
          $ref: '#/components/schemas/NestedRefundApplicationOnExpand'
      type: object
      title: QueryRefundApplicationItemResponse
      additionalProperties: false
    ExpandedSummaryStatementRun:
      properties:
        accountId:
          description: |
            The unique identifier for the statement account.
          type: string
        autoEmailEnabled:
          description: |
            Indicates whether automatic emails are enabled.
          type: string
        batchName:
          description: |
            The name of the batch used to filter accounts, for example, Batch1.
          type: string
        billCycleDay:
          description: >
            The bill cycle day for filtering accounts, represented as a number,
            for example '01' to '31'.
          nullable: true
          type: string
        createdDate:
          description: |
            The date and time when the summary statement run was created.
          format: dateTime
          type: string
        updatedDate:
          description: |
            The date and time when the summary statement run was last updated.
          format: dateTime
          type: string
        createdById:
          description: |
            The user ID of the person who created the summary statement run.
          type: string
        updatedById:
          description: >
            The user ID of the person who last updated the summary statement
            run.
          type: string
        dateRangeType:
          description: |
            The type of date range used for the statement.
          enum:
            - Custom
            - PreviousOneCalendarMonth
            - PreviousThreeCalendarMonth
          type: string
        deleted:
          description: |
            Indicates whether the statement has been deleted.
          type: string
        description:
          description: |
            A description of the summary statement run.
          type: string
        endDate:
          description: |
            The end date of the statement in the format YYYY-MM-DD.
          format: date
          type: string
        id:
          description: |
            The unique identifier of the statement.
          type: string
        numberOfAccounts:
          description: |
            The number of accounts being processed in the summary statement run.
          type: string
        runType:
          description: |
            The type of summary statement run.
          enum:
            - AdHoc
            - Scheduled
          type: string
        startDate:
          description: |
            The start date of the statement in the format YYYY-MM-DD.
          format: date
          type: string
        statementRunNumber:
          description: |
            The unique number assigned to this statement run.
          type: string
        status:
          description: >
            The current status of the statement, with possible values:
              - Pending
              - Processing
              - GenerationCompleted
              - Completed (indicates PDF generation is completed and emails are triggered if AutoEmailEnabled)
              - Error
              - Terminated
              
            For AutoEmailEnabled, the possible values are Pending, Processing,
            GenerationCompleted, Completed, Error

            For AutoEmailDisabled, the possible values are Pending, Processing,
            Completed
          enum:
            - Pending
            - Processing
            - GenerationCompleted
            - Completed
            - Error
            - Terminated
          type: string
        targetAccountCategory:
          description: |
            The method used to filter accounts.
          enum:
            - SingleAccount
            - AllAccounts
            - AccountsWithOpenInvoices
            - AccountsWithOpenBalances
            - AccountsWithoutInvoices
            - AccountsWithoutInvoicesAndOpenBalances
          type: string
        errorCategory:
          description: |
            The category of error when the operation fails.
          type: string
        errorMessage:
          description: |
            The specific error message when the operation fails.
          type: string
        success:
          description: Indicates whether the call succeeded.
          type: boolean
        statementDate:
          description: |
            The date of the statement in the format YYYY-MM-DD.
          format: date
          type: string
        statementNumber:
          description: |
            The unique number assigned to the statement.
          type: string
        statementRunId:
          description: |
            ID of the statement run.
          type: string
        emailStatus:
          type: string
          description: |
            The email status of the statement.
      type: object
    ExpandedSummaryStatement:
      properties:
        accountId:
          description: |
            The unique identifier for the statement account.
          type: string
        autoEmailEnabled:
          description: >
            Indicates whether to send an email after a statement is generated.
            Acceptable values are `true` or `false`. If unspecified, the default
            value is `false`.
          type: boolean
        description:
          description: |
            A text description of the statement run.
          type: string
        batchName:
          description: Name of the batch.
          type: string
          nullable: true
        billCycleDay:
          description: >
            The bill cycle day for filtering accounts, with values ranging from
            '01' to '31'.
          nullable: true
          type: string
        dateRangeType:
          description: >
            The date range for the statement.


            If `PreviousThreeCalendarMonth` or `PreviousOneCalendarMonth` is
            selected, the start and end dates are automatically calculated.

            For example, if `PreviousThreeCalendarMonth` is chosen today
            (2024-08-20), the dates would be 2024-05-01 to 2024-07-31.
          enum:
            - Custom
            - PreviousThreeCalendarMonth
            - PreviousOneCalendarMonth
          type: string
        runType:
          description: >
            The scheduled type of the run which can either be AdHoc or
            Scheduled. Currently, only `AdHoc` is supported.
          enum:
            - AdHoc
          type: string
        createdById:
          description: |
            The ID of the user who created the statement.
          type: string
        createdDate:
          description: |
            The date and time when the statement was created.
          format: dateTime
          type: string
        deleted:
          description: |
            Indicates whether the statement has been deleted.
          type: string
        endDate:
          description: |
            The end date of the statement in the format YYYY-MM-DD.
          format: date
          type: string
        fileId:
          description: |
            The ID associated with the file generated for the statement.
          type: string
        id:
          description: |
            The unique identifier of the statement.
          type: string
        startDate:
          description: |
            The start date of the statement in the format YYYY-MM-DD.
          format: date
          type: string
        emailStatus:
          type: string
          description: |
            The email status of the statement.
        statementDate:
          description: |
            The date of the statement in the format YYYY-MM-DD.
          format: date
          type: string
        statementNumber:
          description: |
            The unique number assigned to the statement.
          type: string
        statementRunNumber:
          description: |
            The number of the related statement run.
          type: string
        statementRunId:
          description: |
            The ID of the related statement run.
          type: string
        status:
          description: |
            The current status of the statement.
          enum:
            - Pending
            - Processing
            - Completed
            - Error
            - Terminated
          type: string
        targetAccountCategory:
          type: string
          description: |
            The method used to filter accounts.
          enum:
            - SingleAccount
            - AllAccounts
            - AccountsWithOpenInvoices
            - AccountsWithOpenBalances
            - AccountsWithoutInvoices
            - AccountsWithoutInvoicesAndOpenBalances
        updatedById:
          description: |
            The ID of the user who last updated the statement.
          type: string
        updatedDate:
          description: |
            The date and time when the statement was last updated.
          format: dateTime
          type: string
        errorCategory:
          description: |
            The category of error when the operation fails.
          type: string
        errorMessage:
          description: |
            The specific error message when the operation fails.
          type: string
        success:
          description: Indicates whether the call succeeded.
          type: boolean
      type: object
    ExpandedSubscription:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the subscription.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the subscription.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the subscription was created in the Zuora
            system, in the `yyyy-mm-dd hh:mm:ss` format.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the subscription.
        updatedDate:
          type: string
          format: date-time
          description: >
            The date and time when the subscription was last updated, in the
            `yyyy-mm-dd hh:mm:ss` format.
        accountId:
          type: string
          description: The ID of the account associated with this subscription.
        autoRenew:
          type: boolean
          description: |
            If `true`, the subscription automatically renews at the end of the
            term. 
          default: false
        cancelledDate:
          type: string
          format: date
          description: |
            The date on which the subscription was canceled.
        contractAcceptanceDate:
          type: string
          format: date
          description: >
            The date when the customer accepts the contract, in the `yyyy-mm-dd`
            format.


            If this field is not set:


            - If the `serviceActivationDate` field is not set, the value of this

            field is set to be the contract effective date.


            - If the `serviceActivationDate` field is set, the value of this
            field

            is set to be the service activation date.



            The billing trigger dates must follow this rule:


            contractEffectiveDate <= serviceActivationDate <=

            contractAcceptanceDate
        contractEffectiveDate:
          type: string
          format: date
          description: >
            The date when the subscription is activated, in the `yyyy-mm-dd`
            format.



            You must specify a Service Activation date if the Customer
            Acceptance

            date is set. If the Customer Acceptance date is not set, the value
            of

            the `serviceActivationDate` field defaults to be the Contract

            Effective Date.



            The billing trigger dates must follow this rule:



            contractEffectiveDate <= serviceActivationDate <=

            contractAcceptanceDate
        creatorAccountId:
          type: string
          description: >
            The ID of the account that created the subscription. This field is

            automatically populated with the ID of the account that creates the

            subscription.



            **Note**: This field is not available for single version
            subscriptions.
        creatorInvoiceOwnerId:
          type: string
          description: >
            The account ID that owns the invoices associated with the
            subscription or the amended subscription.



            **Note**: This field is not available for single version
            subscriptions.
        currentTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the current subscription term.
        currentTermPeriodType:
          type: string
          description: |
            The period type for the current subscription term.
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        initialTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the initial subscription term.
        initialTermPeriodType:
          type: string
          description: |
            The period type for the first subscription term.
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        invoiceOwnerId:
          type: string
          description: >
            The account ID that owns the invoices associated with the
            subscription. 
        isInvoiceSeparate:
          type: boolean
          default: false
          description: >
            Determines if the subscription is invoiced separately. 

            If `true`, then all charges for this subscription are collected into
            the subscription's own invoice.
        isSingleVersioned:
          type: boolean
          description: |
            If `true`, the subscription is a single version subscription.
        name:
          type: string
          description: |
            The name of the subscription.
        notes:
          type: string
          description: |
            Additional information about the subscription.
          maxLength: 65535
        originalCreatedDate:
          type: string
          description: >
            The date when the subscription was originally created. 

            This value is the same as the `createdDate` value until the
            subscription is amended.
        originalId:
          type: string
          description: >
            The original rate plan charge ID. Only available for update

            subscription.



            **Note**: This field is not available for single version
            subscriptions.
        previousSubscriptionId:
          type: string
          description: >
            The ID of the previous subscription. This field is only available if

            the subscription is a renewal subscription.



            **Note**: This field is not available for single version
            subscriptions.
        renewalSetting:
          type: string
          description: >
            Specifies whether a termed subscription will remain `TERMED` or
            change to `EVERGREEN` when it is renewed. 
          enum:
            - RENEW_WITH_SPECIFIC_TERM
            - RENEW_TO_EVERGREEN
          default: RENEW_WITH_SPECIFIC_TERM
        renewalTerm:
          type: integer
          format: int64
          description: |
            The length of the period for the subscription renewal term.
        renewalTermPeriodType:
          type: string
          description: |
            The period type for the subscription renewal term.
          enum:
            - Month
            - Year
            - Day
            - Week
          default: Month
        revision:
          type: string
          description: >
            An auto-generated decimal value uniquely tagged with a subscription.

            The value always contains one decimal place, for example, the
            revision

            of a new subscription is 1.0. If a further version of the
            subscription

            is created, the revision value will be increased by 1. Also, the

            revision value is always incremental regardless of deletion of

            subscription versions.
        serviceActivationDate:
          type: string
          format: date
          description: >
            The date on which the services or products within a subscription
            have been activated and access has been provided to the customer, in
            the `yyyy-mm-dd` format.
        status:
          type: string
          description: |
            Subscription status.
          enum:
            - Draft
            - Pending Activation
            - Pending Acceptance
            - Active
            - Cancelled
            - Suspended
        isLatestVersion:
          description: >
            If `true`, the current subscription object is the latest version.



            **Note**: This field is not available for single version
            subscriptions.
          type: boolean
        subscriptionEndDate:
          type: string
          format: date
          description: >
            The date when the subscription term ends, where the subscription
            ends

            at midnight the day before.


            For example, if the `subscriptionEndDate` is 12/31/2016, the

            subscriptions ends at midnight (00:00:00 hours) on 12/30/2016.


            This date is the same as the term end date or the cancelation date,
            as

            appropriate.
        subscriptionStartDate:
          type: string
          format: date
          description: |
            Date the subscription becomes effective.
        subscriptionVersionAmendmentId:
          type: string
          description: >
            The ID of the amendment made to this subscription version.



            **Note**: This field is not available for single version
            subscriptions.
        termEndDate:
          type: string
          format: date
          description: |
            Date the subscription term ends. If the subscription is evergreen,
            this is null or is the cancellation date (if one has been set).
        termStartDate:
          type: string
          format: date
          description: >
            Date the subscription term begins. If this is a renewal
            subscription,

            this date is different from the subscription start date.
        termType:
          type: string
          description: |
            The type of the subscription term.
          enum:
            - TERMED
            - EVERGREEN
        version:
          type: integer
          format: int64
          description: >-
            This is the subscription version automatically generated by Zuora
            Billing. Each order or amendment creates a new version of the
            subscription, which incorporates the changes made in the order or
            amendment.
        cMRR:
          type: number
          description: |
            Monthly recurring revenue of the subscription.
        billToContactSnapshotId:
          type: string
          description: |
            The ID of the bill-to contact snapshot.
        billToContactId:
          type: string
          description: |
            The ID of the bill-to contact for the subscription.
        invoiceTemplateId:
          type: string
          description: |
            The ID of the invoice template associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
        sequenceSetId:
          description: |
            The ID of the sequence set associated with the subscription.

            **Note**: 
              - If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. 
              - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.
          type: string
          nullable: true
        shipToContactId:
          type: string
          description: |
            The ID of the ship-to contact for the subscription.
        shipToContactSnapshotId:
          type: string
          description: |
            The ID of the ship-to contact snapshot.
        soldToContactId:
          type: string
          description: |
            The ID of the sold-to contact for the subscription.
        soldToContactSnapshotId:
          type: string
          description: |
            The ID of the sold-to contact snapshot.
        externallyManagedBy:
          type: string
          description: >
            An enum field on the Subscription object to indicate the name of a

            third-party store. This field is used to represent subscriptions
            created

            through third-party stores.
          enum:
            - Amazon
            - Apple
            - Google
            - Roku
        lastBookingDate:
          description: >
            The last booking date of the subscription object. This field is

            writable only when the subscription is newly created as a first

            version subscription. You can override the date value when creating
            a

            subscription through the Subscribe and Amend API or the subscription

            creation UI (non-Orders). Otherwise, the default value `today` is
            set

            per the user's timezone. The value of this field is as follows:


            * For a new subscription created by the [Subscribe and Amend

            APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate),

            this field has the value of the subscription creation date.


            * For a subscription changed by an amendment, this field has the
            value

            of the amendment booking date.


            * For a subscription created or changed by an order, this field has

            the value of the order date. 
          format: date
          type: string
        invoiceScheduleId:
          type: string
          description: >
            The ID of the invoice schedule associated with the subscription.



            If multiple invoice schedules are created for different terms of a

            subscription, this field stores the latest invoice schedule.



            **Note**: This field is available only if you have the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Billing_Schedule"

            target="_blank">Billing Schedule</a> feature enabled.
        cancelReason:
          type: string
          description: >
            The reason for a subscription cancellation copied from the

            `changeReason` field of a Cancel Subscription order action. 


            This field contains valid value only if a subscription is cancelled

            through the Orders UI or API. Otherwise, the value for this field
            will

            always be `null`.
        prepayment:
          type: boolean
          description: |
            Whether the subscription is prepaid.
        currency:
          description: >
            The currency of the subscription.


            **Note**: This field is available only if you have the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies"
            target="_blank">Multiple Currencies</a> feature enabled.
          type: string
        orderId:
          description: >
            The ID of the order associated with the subscription.


            **Note**: This field is available only for orders that exist after
            the end of June 2023.
          type: string
        rampId:
          type: string
          description: >
            The ID of the ramp object associated with the subscription.


            **Note**: This field is available only if you have the <a

            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Ramp"

            target="_blank">Ramp</a> feature enabled.
        paymentTerm:
          type: string
          description: |
            Name of the payment term associated with the account. For example,
            "Net 30". The payment term determines the due dates of invoices.
        quoteNumber__QT:
          type: string
          description: >
            The unique identifier of the Quote. This field is used in Zuora data

            sources to report on Subscription metrics. If the subscription
            originated

            from Zuora Quotes, the value is populated with the value from Zuora

            Quotes.
          maxLength: 32
        quoteType__QT:
          description: >
            The Quote type that represents the subscription lifecycle stage such
            as

            New, Amendment, Renew or Cancel. This field is used in Zuora data
            sources

            to report on Subscription metrics. If the subscription originated
            from

            Zuora Quotes, the value is populated with the value from Zuora
            Quotes.
          maxLength: 32
          type: string
        quoteBusinessType__QT:
          type: string
          description: >
            The specific identifier for the type of business transaction the
            Quote

            represents such as New, Upsell, Downsell, Renewal or Churn. This
            field is

            used in Zuora data sources to report on Subscription metrics. If the

            subscription originated from Zuora Quotes, the value is populated
            with the

            value from Zuora Quotes.
          maxLength: 32
        opportunityName__QT:
          type: string
          description: >
            The unique identifier of the Opportunity. This field is used in
            Zuora data

            sources to report on Subscription metrics. If the subscription
            originated

            from Zuora Quotes, the value is populated with the value from Zuora

            Quotes.
          maxLength: 100
        opportunityCloseDate__QT:
          type: string
          format: date
        cpqBundleJsonId__QT:
          description: >
            The Bundle product structures from Zuora Quotes if you utilize
            Bundling in Salesforce. Do not change the value in this field.
          maxLength: 32
          type: string
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        invoiceOwner:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        billToContact:
          $ref: '#/components/schemas/ExpandedContact'
        soldToContact:
          $ref: '#/components/schemas/ExpandedContact'
        invoiceItems:
          type: array
          items:
            $ref: '#/components/schemas/NestedInvoiceItemOnExpand'
        ratePlans:
          type: array
          items:
            $ref: '#/components/schemas/NestedRatePlanOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Subscription object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QuerySubscriptionResponse
    ExpandedUsage:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the usage.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the usage.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the usage was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the usage.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the usage was last updated.
        accountId:
          type: string
          description: |
            The ID of the customer account associated with the usage.
        accountNumber:
          type: string
          description: |
            The number of the customer account associated with the usage.
        ratePlanChargeId:
          type: string
          description: |
            ID of the rate plan charge that pays for this usage.
        endDateTime:
          type: string
          description: |
            End date of the time period in which usage is tracked. Zuora uses
            this field value to determine the usage date.
          format: date-time
        productRatePlanChargeId:
          type: string
          description: >
            The product rate plan charge number that you use for a dynamic usage
            charge.
        quantity:
          type: number
          description: |
            Number of units used.
        rbeStatus:
          type: string
          description: >
            Indicates if the rating and billing engine (RBE) processed usage
            data for an invoice.
          enum:
            - Importing
            - Pending
            - Processed
        sourceType:
          type: string
          description: >
            Indicates if the usage records were imported from the web-based UI
            or the API.
          enum:
            - API
            - Import
        startDateTime:
          description: |
            Start date of the time period in which usage is tracked. Zuora uses
            this field value to determine the usage date.
          format: date-time
          type: string
        subscriptionId:
          type: string
          description: >
            The original ID of the subscription that contains the fees related
            to the usage data.
        submissionDateTime:
          type: string
          format: date-time
          description: |
            The date and time when the usage was submitted.
        uOM:
          type: string
          description: >
            The units to measure usage. Units of measure are configured in the
            web-based UI. Your values depend on your configuration in **Billing
            Settings**.
        description:
          type: string
          description: |
            A description of the usage record.
        importId:
          type: string
          description: |
            The unique identifier of the import.
        uniqueKey:
          description: >
            a customer-defined specific identifier of a usage record.


            **Note**: This field is only available if you have the [Prepaid with

            Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown)

            feature or the <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage"
            target="_blank">Unbilled Usage</a> feature enabled. See [Upload
            usage record with unique

            key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key)

            for more information.
          type: string
        fileId:
          description: >
            File ID of the uploaded usage records file. You can use this file ID
            with [Get
            files](https://developer.zuora.com/api-references/api/operation/GET_Files)
            to download the file.
          type: string
        fileName:
          type: string
          description: >
            The name of the import file when the usage record is imported from
            the file.
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Usage object. Only the indexed custom fields with
          a specified value (not null) are returned. The name of each custom
          field has the form <code>*customField*__c</code>. Custom field names
          are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryUsageResponse
    ExpandedValidityPeriodSummary:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the validity period summary.
        createdById:
          type: string
          description: >
            The unique identifier of the user who created the validity period
            summary.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the validity period summary was created.
        updatedById:
          type: string
          description: >
            The unique identifier of the user who last updated the validity
            period summary.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the validity period summary was last updated.
        prepaidBalanceId:
          type: string
          description: |
            The unique identifier of the prepaid balance.
        startDate:
          type: string
          format: date
          description: |
            The start date of the validity period.
        endDate:
          type: string
          format: date
          description: |
            The end date of the validity period.
        totalBalance:
          type: number
          description: |
            The total prepaid balance for the current validity period.
        remainingBalance:
          type: number
          description: |
            The remaining prepaid balance for the current validity period.
        totalBilledAmount:
          type: number
          description: |
            The total amount that has been billed.
        billedBalanceAmount:
          type: number
          description: |
            The total amount of the billing documents balances.
        subscriptionNumber:
          type: string
          description: |
            The number of the subscription the validity period belongs to.
        uom:
          type: string
          description: |
            The UOM of the validity period.
        accountNumber:
          type: string
          description: |
            The number of the account to which the prepaid balance belongs.
        accountId:
          type: string
          description: |
            The ID of the account to which the prepaid balance belongs.
        billingTiming:
          type: string
          description: |
            The billing timing of the validity period.
          enum:
            - In Advance
            - In Arrears
        overageRatedQuantity:
          type: number
          format: double
          description: >
            The overage rated quantity for the validity period.


            **Note**: The `overageRatedQuantity` and `overageRatedAmount` fields
            of the Validity Period Summary object are approaching end of support
            on  February 01, 2025. For more information, see <a
            href="https://knowledgecenter.zuora.com/Releases/ZProduct_and_feature_end_of_support_plan#overageRatedQuantity_and_overageRatedAmount_fields_end_of_support_plan"
            target="_blank">Product and feature end of support plan</a>.
        overageRatedAmount:
          type: number
          format: double
          description: >
            The overage rated amount for the validity period. 


            **Note**: The `overageRatedQuantity` and `overageRatedAmount` fields
            of the Validity Period Summary object are approaching end of support
            on  February 01, 2025. For more information, see <a
            href="https://knowledgecenter.zuora.com/Releases/ZProduct_and_feature_end_of_support_plan#overageRatedQuantity_and_overageRatedAmount_fields_end_of_support_plan"
            target="_blank">Product and feature end of support plan</a>.
        account:
          $ref: '#/components/schemas/NestedAccountOnExpand'
        prepaidBalance:
          $ref: '#/components/schemas/NestedPrepaidBalanceOnExpand'
      additionalProperties:
        type: object
        description: >
          Custom fields of the Validity Period Summary object. Only the indexed
          custom fields with a specified value (not null) are returned. The name
          of each custom field has the form <code>*customField*__c</code>.
          Custom field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryValidityPeriodSummaryResponse
    ExpandedContactSnapshot:
      properties:
        id:
          type: string
          description: |
            The unique identifier of the contact snapshot.
        createdById:
          type: string
          description: |
            The unique identifier of the user who created the snapshot.
        createdDate:
          type: string
          format: date-time
          description: |
            The date and time when the contact snapshot was created.
        updatedById:
          type: string
          description: |
            The unique identifier of the user who last updated the snapshot.
        updatedDate:
          type: string
          format: date-time
          description: |
            The date and time when the contact snapshot was last updated.
        accountId:
          type: string
          description: |
            The unique identifier of the associated billing account.
        contactId:
          type: string
          description: |
            The unique identifier of the original contact.
        firstName:
          type: string
          description: |
            The first name of the contact.
        lastName:
          type: string
          description: |
            The last name of the contact.
        nickName:
          type: string
          description: |
            The nickname of the contact.
        address1:
          type: string
          description: |
            The first line of the address.
        address2:
          type: string
          description: |
            The second line of the address.
        city:
          type: string
          description: |
            The city of the contact's address.
        state:
          type: string
          description: |
            The state or province of the contact's address.
        postalCode:
          type: string
          description: |
            The postal or ZIP code.
        county:
          type: string
          description: |
            The county or region of the contact.
        country:
          type: string
          description: |
            The county or region of the contact.
        taxRegion:
          type: string
          description: |
            The tax region applicable to the contact.
        description:
          type: string
          description: |
            The free-form description of the contact snapshot.
        homePhone:
          type: string
          description: |
            The home phone number.
        otherPhone:
          type: string
          description: |
            Any other phone number.
        otherPhoneType:
          type: string
          description: |
            The type of the other phone number.
        fax:
          type: string
          description: |
            The fax number.
        personalEmail:
          type: string
          description: |
            The personal email address.
        workEmail:
          type: string
          description: |
            The personal email address.
        deleted:
          type: boolean
          description: |
            Indicates whether the contact snapshot is marked as deleted.
      additionalProperties:
        type: object
        description: >
          Custom fields of the ContactSnapshot object. Only the indexed custom
          fields with a specified value (not null) are returned. The name of
          each custom field has the form <code>*customField*__c</code>. Custom
          field names are case sensitive. See <a
          href="https://docs.zuora.com/en/zuora-platform/extensibility/custom-fields/custom-field-overview"
          target="_blank">Custom Fields</a> for more information.
      type: object
      title: QueryContactSnapshotResponse
    RatingDetails:
      type: object
      title: RatingDetailResponse
      properties:
        id:
          type: string
          description: The unique identifier of the Rating Detail.
        invoiceItemId:
          type: string
          description: >-
            The unique identifier of the Invoice Item this Rating Detail is
            associated to.
        creditMemoItemId:
          type: string
          nullable: true
          description: >-
            The unique identifier of the Credit Memo Item this Rating Detail is
            associated to.
        chargeType:
          type: string
          description: The type of charge of the associated Invoice Item.
        chargeModel:
          type: string
          description: The charge model of the associated Invoice Item.
        formula:
          type: string
          description: Text with mathematical formula used to rate the amount.
        calculation:
          type: string
          description: Details of the rating done by replacing values in the formula.
        calculatedAmount:
          type: number
          format: double
          description: The output result of the rating calculation.
        currency:
          type: string
          description: The currency code of the calculated amount.
        unitOfMeasure:
          type: string
          description: Unit of measure if it's a usage charge.
        quantity:
          type: number
          format: double
          nullable: true
          description: If usage charge, quantity of usages.
        billedQuantity:
          type: number
          format: double
          nullable: true
          description: >-
            For on-demand usage charges, previously billed quantity in the same
            billing period.
        billedAmount:
          type: number
          format: double
          nullable: true
          description: >-
            For on-demand usage charges, previously billed amount in the same
            billing period.
        isProration:
          type: boolean
          description: True if the billing period is a prorated period.
        isCredit:
          type: boolean
          description: True if this is a credit.
        listPriceBase:
          type: string
          description: List price base from the rate plan charge.
        billingCycleDay:
          type: integer
          description: Billing cycle day from the rate plan charge.
        billingCycleType:
          type: string
          description: Billing cycle type from the rate plan charge.
        billingPeriod:
          type: string
          description: Billing period from the rate plan charge.
        specificBillingPeriod:
          type: string
          description: Specific billing period from the rate plan charge.
        validityPeriodType:
          type: string
          description: Validity period type for prepaid or commitment charges.
        billingPeriodAlignment:
          type: string
          description: Billing period alignment from the rate plan charge.
        alignmentStartDate:
          type: string
          format: date
          description: Start date used for billing alignment.
        amountWithoutTax:
          type: number
          format: double
          description: The amount from the Invoice Item or Credit Memo Item.
        isInclusiveTaxNoRounding:
          type: boolean
          description: True if tax mode option is set to tax inclusive.
        isProrationPartialPeriod:
          type: boolean
          description: >-
            True if billing rule "Prorate recurring charges for partial period?"
            is Yes.
        isProrateMonthlyCharges:
          type: boolean
          description: >-
            True if billing rule "Bill usage/recurring charges for partial
            month?" is Yes.
        isProrateWeeklyCharges:
          type: boolean
          description: >-
            True if billing rule "Bill usage/recurring charges for partial
            week?" is Yes.
        prorationUnitRule:
          type: string
          description: Value of billing rule for prorating units.
        daysInMonthRule:
          type: string
          description: Value of billing rule for days in a month.
        recurringCreditProrationOptionRule:
          type: string
          description: Billing rule for recurring credit proration option.
        isCreditWithOriginalCE:
          type: boolean
          description: >-
            True if permission for credit with original invoice item amount is
            enabled.
        isProrateDiscountCredit:
          type: boolean
          description: True if prorated discount credit rule is enabled.
        stackedDiscountClassApplyRule:
          type: string
          description: Billing rule for applying stacked discount class.
        recurringPeriodStart:
          type: string
          format: date
          description: Start date of the current service period.
        recurringPeriodEnd:
          type: string
          format: date
          description: End date of the current service period.
        chargeStartDate:
          type: string
          format: date
          description: Charge start date.
        chargeEndDate:
          type: string
          format: date
          description: Charge end date.
        subStartDate:
          type: string
          format: date
          description: Subscription start date.
        subEndDate:
          type: string
          format: date
          description: Subscription end date.
        termStartDate:
          type: string
          format: date
          description: Term start date.
        termEndDate:
          type: string
          format: date
          description: Term end date.
        creditOption:
          type: string
          description: Credit option from the rate plan charge.
        fundingPrice:
          type: number
          format: double
          description: Total price of current validity period fund.
        totalBalance:
          type: number
          format: double
          description: Total fund or discount schedule balance.
        remainingBalance:
          type: number
          format: double
          description: Remaining fund or discount schedule balance.
        originalBillingPeriodStart:
          type: string
          format: date
          description: Start date of original billing period if credit.
        originalBillingPeriodEnd:
          type: string
          format: date
          description: End date of original billing period if credit.
        originalAmount:
          type: number
          format: double
          description: Original billed amount if credit.
        basePrice:
          type: number
          format: double
          description: Base price or fixed amount.
        discountClass:
          type: string
          description: Discount class as in rate plan charge.
        discountClassOrder:
          type: integer
          description: Order number of discount class.
        discountLevel:
          type: string
          description: Discount level from rate plan charge.
        discountApplySequence:
          type: integer
          description: Sequence in which the discount is applied.
        discountSchedulePeriodStart:
          type: string
          format: date
          description: Discount schedule start date.
        discountSchedulePeriodEnd:
          type: string
          format: date
          description: Discount schedule end date.
        regularChargeAmount:
          type: number
          format: double
          description: Amount of the charge that the discount is applied to.
        regularChargeAmountLeft:
          type: number
          format: double
          description: Remaining amount of charge before this discount is applied.
        originalRegularChargeAmount:
          type: number
          format: double
          description: Original amount of charge before credit.
        discountBalanceFormula:
          type: string
          description: Formula used to calculate discount total balance.
      additionalProperties: false
    QueryRatingDetailsResponse:
      type: object
      title: QueryRatingDetailsResponse
      properties:
        nextPage:
          type: string
          nullable: true
          description: >
            A string to use as the `cursor` value in the next request to
            paginate results.
        data:
          type: array
          description: Array of rating detail results.
          items:
            $ref: '#/components/schemas/RatingDetails'
      additionalProperties: false
    DataQueryJobCommon:
      properties:
        createdBy:
          description: |
            The query job creator's Id.
          format: uuid
          maxLength: 64
          minLength: 64
          type: string
        id:
          description: |
            Internal identifier of the query job.
          format: uuid
          maxLength: 64
          minLength: 64
          type: string
        query:
          description: |
            The query that was submitted.
          type: string
        remainingRetries:
          description: >
            The number of times that Zuora will retry the query if Zuora is
            unable to perform the query.
          type: integer
        sourceData:
          description: >
            Indicates the source that data queries run against:


            * `LIVE` represents the live transactional databases at Zuora (Data
            Query Live).


            * `WAREHOUSE` represents Zuora Warehouse, which has better
            performance and fewer limitations than the live transactional
            database. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview"
            target="_blank">Zuora Warehouse</a>.
          type: string
        updatedOn:
          description: >
            Date and time when the query job was last updated, in ISO 8601
            format.
          format: date-time
          type: string
        useIndexJoin:
          description: >
            Indicates whether to use Index Join. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Query/Data_Query/Best_practices_when_writing_data_queries/General_best_practices#Index_JOIN"
            target="_blank">Index Join</a> for more information.
          type: boolean
      type: object
    DataQueryJob:
      allOf:
        - $ref: '#/components/schemas/DataQueryJobCommon'
        - properties:
            dataFile:
              description: >
                The URL of the query results. Only applicable if the value of
                the `queryStatus` field is `completed`.
              format: URL
              type: string
            outputRows:
              description: >
                The number of rows the query results. Only applicable if the
                value of the `queryStatus` field is `completed`.
              type: integer
            processingTime:
              description: >
                Processing time of the query job, in milliseconds. Only
                applicable if the value of the `queryStatus` field is
                `completed`.
              type: integer
            queryStatus:
              description: >
                Status of the query job.


                * `submitted` - query submitted to query service for processing

                * `accepted` - query accepted by the query service

                * `in_progress` - query executed by the query service

                * `completed` - query execution completed by the query service

                * `failed` - query unable to be processed by the query service

                * `cancelled` - query cancelled by the user


                If the value of this field is `completed`, the `dataFile` field
                contains the location of the query results.


                If the value of this field is `accepted` or `in_progress`, you
                can use [Cancel a data query
                job](#operation/DELETE_DataQueryJob) to prevent Zuora from
                performing the query. Zuora then sets the status of the query
                job to `cancelled`.
              enum:
                - submitted
                - accepted
                - in_progress
                - completed
                - failed
                - cancelled
              type: string
          type: object
      description: |
        A data query job.
      title: queryJob
    GetDataQueryJobsResponse:
      properties:
        data:
          description: >
            List of data query jobs. The query jobs are listed in reverse order
            of creation.
          items:
            $ref: '#/components/schemas/DataQueryJob'
          type: array
      type: object
    SubmitDataQueryRequest:
      example:
        query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100
        compression: NONE
        output:
          target: S3
        outputFormat: CSV
      properties:
        columnSeparator:
          description: >
            The column separator. Only applicable if the `outputFormat` is
            `DSV`.
          type: string
        compression:
          description: |
            Specifies whether Zuora compresses the query results.
          enum:
            - NONE
            - GZIP
            - ZIP
          type: string
        encryptionKey:
          description: >
            Base-64 encoded public key of an RSA key-pair. 


            Note that Data Query only supports 1024-bit RSA keys.


            If you set this field, Zuora encrypts the query results using the
            provided public key. You must use the corresponding private key to
            decrypt the query results.
          format: byte
          type: string
        output:
          description: |
            Additional information about the query results.
          properties:
            target:
              description: |
                Set this field to `S3`.
              enum:
                - S3
              type: string
          required:
            - target
          type: object
        outputFormat:
          description: >
            Specifies the format of the query results.


            * `JSON` - Each row in the query results will be a JSON object. The
            format of the query result file is [JSON
            Lines](http://jsonlines.org/).

            * `CSV` - Each row in the query results will be a comma-separated
            list of values.

            * `TSV` - Each row in the query results will be a tab-separated list
            of values.

            * `DSV` - Pass any character as your custom delimiter into the
            `columnSeparator` field.
          enum:
            - JSON
            - CSV
            - TSV
            - DSV
          type: string
        query:
          description: >
            The query to perform. See [SQL Queries in Data
            Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/BA_SQL_Queries_in_Data_Query)
            for more information.
          type: string
        readDeleted:
          default: false
          description: >
            Indicates whether the query will retrieve only the deleted record.
            If `readDeleted` is set to `false` or it is not included in the
            request body, the query will retrieve only the non-deleted records.
            If it is set to `true`, only the deleted records will be retrieved.


            If you select the `deleted` column in the `query` field, both
            non-deleted and deleted records will be retrieved regardless of the
            value in the `readDeleted` field.


            Note that Data Query is subject to Zuora Data Retention Policy. The
            retention period of deleted data is 30 days. You can only retrieve
            deleted data for 30 days through Data Query.
          type: boolean
        sourceData:
          description: >
            Specify the source that data queries run against:


            * `LIVE` represents the live transactional databases at Zuora (Data
            Query Live).


            * `WAREHOUSE` represents Zuora Warehouse, which has better
            performance and fewer limitations than the live transactional
            database. This option is available only if you have the Zuora
            Warehouse feature enabled in your tenant. For more information, see
            <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview"
            target="_blank">Zuora Warehouse</a>. <br>If this option is selected,
            you can specify warehouse size in `warehouseSize`.


            If this field is not specified, the default value `LIVE` will be
            used.
          enum:
            - LIVE
            - WAREHOUSE
          type: string
        useIndexJoin:
          description: >-
            Indicates whether to use Index Join. Index join is useful when you
            have a specific reference value in your WHERE clause to index
            another large table by. See [Use Index
            Join](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/Best_practices_of_Data_Query#Use_Index_Join)
            for more information.
          type: boolean
        warehouseSize:
          description: >
            Specify the size of Zuora Warehouse. This field is available only if
            the `sourceData` is `WAREHOUSE`.


            If this field is not specified or set to `NULL`, the default value
            `xsmall` will be used.
          enum:
            - xsmall
            - 'NULL'
          type: string
      required:
        - query
        - outputFormat
        - compression
        - output
      type: object
    SubmitDataQueryResponse:
      properties:
        data:
          $ref: '#/components/schemas/DataQueryJob'
      type: object
    DataQueryErrorResponse:
      properties:
        code:
          description: |
            Error code.
          type: integer
        message:
          description: |
            Error message.
          type: string
      type: object
    GetDataQueryJobResponse:
      properties:
        data:
          $ref: '#/components/schemas/DataQueryJob'
      type: object
    DataQueryJobCancelled:
      allOf:
        - $ref: '#/components/schemas/DataQueryJobCommon'
        - properties:
            queryStatus:
              description: |
                Status of the query job.
              enum:
                - cancelled
              type: string
          type: object
      description: |
        A cancelled data query job.
      title: cancelledQueryJob
    DeleteDataQueryJobResponse:
      properties:
        data:
          $ref: '#/components/schemas/DataQueryJobCancelled'
      type: object
    BatchQuery:
      properties:
        apiVersion:
          description: >
            The API version for the query. If an API version is not specified,
            the latest version is used by default. Using the latest WSDL version
            is most useful for reporting use cases. For integration purposes,
            specify the WSDL version to ensure consistent query behavior, that
            is, what is supported and included in the response returned by the
            API.


            **Note**: As of API version 69 and later, Zuora changed the format
            of certain fields. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API"
            target="_blank">Date Field Changes in the SOAP API</a> for more
            information and a list of affected fields.
          type: string
        convertToCurrencies:
          description: >
            The currencies that you want to convert transaction amounts into.
            You can specify any number of currencies. Specify the currencies
            using their <a
            href="https://knowledgecenter.zuora.com/Quick_References/Country%2C_State%2C_and_Province_Codes/D_Currencies_and_Their_3-Letter_Codes"
            target="_blank">ISO currency codes</a> and separate each currency
            with a comma, for example, "EUR,GBP,JPY".


            See <a
            href="https://knowledgecenter.zuora.com/Zuora_Collect/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion/Foreign_Currency_Conversion_for_Data_Source_Exports#Creating_the_Data_Source_Export_Using_the_AQuA_API"
            target="_blank">Convert Transaction Amounts Into Any Currency</a>
            for more information and examples.


            To use this field, you must have <a
            href="https://knowledgecenter.zuora.com/Zuora_Collect/Zuora_Finance/D_Finance_Settings/F_Foreign_Currency_Conversion"
            target="_blank">Foreign Currency Conversion</a> enabled and you must
            be using API version 78 or later.
          type: string
        deleted:
          description: >
            This field indicates that the AQuA incremental load will retrieve
            deleted records.


            If you want to export deleted data, this field is required.


            **Note**: AQuA API is subject to Zuora Data Retention Policy. The
            retention period of deleted data is 30 days. You can only retrieve
            deleted data for 30 days through AQuA.
          items:
            properties:
              column:
                description: >
                  Name of the Column in the extracted file that points to the
                  deleted records. 
                type: string
              format:
                description: >
                  Can be set to either `Numeric` or `Boolean`. If set to
                  `Numeric`, deleted records are marked as `1`. If set to
                  `Boolean`, deleted records are marked as `true`.
                type: string
            title: deletedRecord
            type: object
          type: array
        name:
          description: >
            The query name that can uniquely identify the query in this API
            request.
          type: string
        query:
          description: |
            A valid ZOQL query or Export ZOQL query statement.
          type: string
        type:
          description: |
            The query type.
          enum:
            - zoql
            - zoqlexport
          type: string
      title: query
    SubmitBatchQueryRequest:
      example:
        queries:
          - query: select AccountNumber, BillCycleDay from Account
            type: zoql
      properties:
        dateTimeUtc:
          description: >
            When using WSDL 69 and later you can ensure that the exported output
            of dateTime records are rendered according to ISO-8601 generic UTC
            form by setting `dateTimeUtc` to `true`.


            When `dateTimeUtc` is set to `true`, exports of dateTime data types
            will be rendered in the following generic format:
            `YYYY-MM-DDThh:mm:ss-hhmm` or `YYYY-MM-DDThh:mm:ss+hhmm`.


            **Note**: Regardless of what batchType query is used (`zoql` or
            `zoqlexport`), the query response output for datetime data types can
            be standardized by setting dateTimeUtc to `true`. When `true`, the
            results will display datetime types with the format:
            YYYY-MM-DDThh:mm:ss+/-hhmm.
          type: boolean
        format:
          description: |
            The format of the query. The default value is `csv`.
          enum:
            - csv
            - zip
            - gzip
          type: string
        incrementalTime:
          description: >
            Allows you to override the time from which a Stateful AQuA job
            incrementally retrieves records that have been created or modified,
            using the `incrementalTime` parameter. For example, if you set
            `incrementalTime` = `2015-01-21 10:30:01`, AQuA will retrieve
            records that have created or modified beginning at 10:30:01. If this
            parameter is not set, AQuA continues to use the Start Time of the
            last AQuA session to retrieve records incrementally.


            The time zone of `incrementalTime` depends on which Zuora data
            center you use. For US Data Center customers, the time zone of
            `incrementalTime` is Pacific Time. For EU Data Center customers, the
            time zone of `incrementalTime` is UTC. If the time zone of your
            system is different from the time zone of `incrementalTime`, you
            will need to convert to the appropriate time zone before setting
            `incrementalTime`.


            **Note**: This field can only be used in Stateful AQuA mode.
          format: dateTime
          type: string
        name:
          description: |
            The name of the job. 32 character limit.
          type: string
        notifyUrl:
          description: >
            If URL is provided, the AQuA job will call this `notifyUrl` once the
            job has completed. The value of `notifyUrl` needs to have `${JOBID}`
            and `${STATUS}` placeholders. These placeholders will be replaced by
            the actual job ID and status when returned in the response. Status
            will be `Completed` after the AQuA job is done.


            If you submit an AQuA query with `notifyUrl` specified, the value of
            `notifyUrl` will be ignored if your organization has already <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Callout_Notification_for_Completed_AQuA_Jobs"
            target="_blank">configured a callout notification through the Zuora
            user interface</a>. 
          type: string
        nullReplacement:
          description: >
            The string used to represent null values in the query results. If
            you do not set this parameter, null values are represented by the
            empty string in the query results.
          type: string
        offset:
          default: 0
          description: >
            This field specifies the time offset for AQuA queries in stateful
            mode. It is an integer in the range 0 to 3,600 seconds.


            For example, if you set this field to 600 seconds and you post a
            query in stateful mode at 2:00 AM, it will query against data
            created or updated between the completion time of the previous query
            and 1:50 AM.


            The value of this field will override the value you configured in
            **Settings** > **Administration** > **AQuA API Stateful Mode Time
            Offset**.        
          type: integer
        partner:
          description: >
            The partner field indicates the unique ID of a data integration
            partner. The dropdown list of this field displays partner IDs for
            the past thirty days.

            It must be used together with "project" field to uniquely identify a
            data integration target.


            For example, if a continuous AQuA session is to retrieve data
            incrementally for a Salesforce.com Org 00170000011K3Ub, you can use
            partner as "Salesforce", and "project" as "00170000011K3Ub." 

            This field is required only if you are using AQuA in stateful mode.
            Otherwise, if you are using AQuA in stateless mode, partner field
            can be null.


            **Note**: Zuora highly recommends you use the stateless mode instead
            of the stateful mode to extract bulk data. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA"
            target="_blank">Bulk data extraction from Zuora using AQuA</a> for
            best practices.

            **Note**: Submit a request at <a href="http://support.zuora.com"
            target="_blank">Zuora Global Support</a> to obtain a partner ID.
          type: string
        project:
          description: >
            The project field contains the unique ID of a data integration
            project for a particular partner. The dropdown list of this field
            displays project IDs for the past thirty days.


            This field must be used together with partner field to uniquely
            identify a data integration target. 


            This field is required only if you are using AQuA in stateful mode.
            Otherwise, if you are using AQuA in stateless mode, partner field
            can be null.
          type: string
        queries:
          description: |
            A JSON array object that contains a list of batch objects.
          items:
            $ref: '#/components/schemas/BatchQuery'
          required:
            - name
            - query
          type: array
        sourceData:
          description: >
            Specify the source this aggregate query runs against:


            * `LIVE` represents the live transactional databases at Zuora (Data
            Query Live).

            If this field is not specified, the default value `LIVE` will be
            used.
          enum:
            - LIVE
          type: string
        useQueryLabels:
          description: >
            When this optional flag is set to `true` the request will use object
            and field API names for the CSV header output instead of the field
            labels. Data integration projects should set `useQueryLabels` to
            `true` so that API names remain the same.


            By default `useQueryLabels` is `false`, so that output CSV headers
            display the more user-friendly object and field labels. 
          type: boolean
        version:
          description: >
            The API version you want to use. 


            The supported versions are as follows:
              - `1.1`. It supports both modes
              - `1.0`. Default. It supports stateless modes only.

            See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes"
            target="_blank">Stateless and stateful modes</a> for more
            information.
          format: float
          type: number
      type: object
    BatchesQueries:
      properties:
        apiVersion:
          description: >
            The API version for the query. If an API version is not specified,
            the latest version is used by default. Using the latest WSDL version
            is most useful for reporting use cases. For integration purposes,
            specify the WSDL version to ensure consistent query behavior, that
            is, what is supported and included in the response returned by the
            API.


            **Note**: As of API version 69 and later, Zuora changed the format
            of certain fields. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API"
            target="_blank">Date Field Changes in the SOAP API</a> for more
            information and a list of affected fields.
          type: string
        batchId:
          description: |
            A 32-character ID of the query batch.
          type: string
        batchType:
          description: |
            The kind of batch job being submitted.
          enum:
            - zoql
            - zoqlexport
          type: string
        deleted:
          description: >
            This field indicates that the AQuA incremental load will retrieve
            deleted records.


            **Note**: AQuA API is subject to Zuora Data Retention Policy. The
            retention period of deleted data is 30 days. You can only retrieve
            deleted data for 30 days through AQuA.
          items:
            properties:
              column:
                description: >
                  Name of the Column in the extracted file that points to the
                  deleted records. 
                type: string
              format:
                description: >
                  Can be set to either `Numeric` or `Boolean`. If set to
                  `Numeric`, deleted records are marked as `1`. If set to
                  `Boolean`, deleted records are marked as `true`.          
                type: string
            title: deletedRecord
            type: object
          type: array
        full:
          description: >
            This field indicates a full or incremental load. `True` = Full and
            `False` = Incremental.          
          type: boolean
        name:
          description: |
            Name of the query supplied in the request.
          type: string
        query:
          description: |
            The requested query string.
          type: string
        recordCount:
          description: |
            The number of records included in the query output file.
          type: string
        status:
          description: >
            The status of the query task:

            - submitted: The query was submitted to the query executor for
            processing.

            - pending: The query was waiting for being processed.

            - executing: The query is being processed.

            - completed: The query was successfully executed.

            - aborted: The query execution failed.

            - deleted_notallowed: The query execution failed because objects
            included in the query do not support the querying of deleted
            records.
          enum:
            - submitted
            - pending
            - executing
            - completed
            - aborted
            - deleted_notallowed
          type: string
      title: batch
    SubmitBatchQueryResponse:
      properties:
        batches:
          description: |
            A JSON array object that contains a list of batch objects.
          items:
            $ref: '#/components/schemas/BatchesQueries'
          required:
            - name
            - query
            - status
            - batchId
            - batchType
          type: array
        encrypted:
          description: >
            If enabled, you must supply the formatting (zip or unzip) first and
            decrypt it to get the actual contents.      
          enum:
            - pgp
            - none
          type: string
        format:
          description: |
            The format of the query. The default value is `csv`.
          enum:
            - csv
            - zip
            - gzip
          type: string
        id:
          description: >
            The job ID created for the AQuA API request. The job ID can be used
            for querying for the query status. 


            The ID exists only if the JSON request can be parsed and validated
            successfully. Otherwise, the job ID is null.
          type: string
        incrementalTime:
          description: >
            Allows you to override the time from which a Stateful AQuA job
            incrementally retrieves records that have been created or modified,
            using the `incrementalTime` parameter. For example, if you set
            `incrementalTime` = `2015-01-21 10:30:01`, AQuA will retrieve
            records that have created or modified beginning at 10:30:01. If this
            parameter is not set, AQuA continues to use the Start Time of the
            last AQuA session to retrieve records incrementally.


            The time zone of `incrementalTime` depends on which Zuora data
            center you use. For US Data Center customers, the time zone of
            `incrementalTime` is Pacific Time. For EU Data Center customers, the
            time zone of `incrementalTime` is UTC. If the time zone of your
            system is different from the time zone of `incrementalTime`, you
            will need to convert to the appropriate time zone before setting
            `incrementalTime`.


            **Note**: This field can only be used in Stateful AQuA mode.    
          format: dateTime
          type: string
        name:
          description: |
            The name of the job. 32 character limit.
          type: string
        notifyUrl:
          description: >
            If URL is provided, the AQuA job will call this `notifyUrl` once the
            job has completed. The value of `notifyUrl` needs to have `${JOBID}`
            and `${STATUS}` placeholders. These placeholders will be replaced by
            the actual job ID and status when returned in the response. Status
            will be `Completed` after the AQuA job is done.


            If you submit an AQuA query with `notifyUrl` specified, the value of
            `notifyUrl` will be ignored if your organization has already <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Callout_Notification_for_Completed_AQuA_Jobs"
            target="_blank">configured a callout notification through the Zuora
            user interface</a>.           
          type: string
        offset:
          default: 0
          description: >
            This field specifies the time offset for AQuA queries in stateful
            mode. It is an integer in the range 0 to 3,600 seconds.


            For example, if you set this field to 600 seconds and you post a
            query in stateful mode at 2:00 AM, it will query against data
            created or updated between the completion time of the previous query
            and 1:50 AM.


            The value of this field will override the value you configured in
            **Settings** > **Administration** > **AQuA API Stateful Mode Time
            Offset**.    
          type: integer
        partner:
          description: >
            The partner field indicates the unique ID of a data integration
            partner. The dropdown list of this field displays partner IDs for
            the past thirty days.


            It must be used together with "project" field to uniquely identify a
            data integration target.


            For example, if a continuous AQuA session is to retrieve data
            incrementally for a Salesforce.com Org 00170000011K3Ub, you can use
            partner as "Salesforce", and "project" as "00170000011K3Ub." 


            This field is required only if you are using AQuA in stateful mode.
            Otherwise, if you are using AQuA in stateless mode, partner field
            can be null.


            **Note**: Zuora highly recommends you use the stateless mode instead
            of the stateful mode to extract bulk data. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA"
            target="_blank">Bulk data extraction from Zuora using AQuA</a> for
            best practices.


            **Note**: Submit a request at <a href="http://support.zuora.com"
            target="_blank">Zuora Global Support</a> to obtain a partner ID.
          type: string
        project:
          description: >
            The project field contains the unique ID of a data integration
            project for a particular partner. The dropdown list of this field
            displays project IDs for the past thirty days.


            This field must be used together with partner field to uniquely
            identify a data integration target. 


            This field is required only if you are using AQuA in stateful mode.
            Otherwise, if you are using AQuA in stateless mode, partner field
            can be null.
          type: string
        sourceData:
          description: >
            Indicates the source this aggregate query runs against:


            * `LIVE` represents the live transactional databases at Zuora (Data
            Query Live).
          type: string
        status:
          description: >
            The status of the AQuA job:

            - submitted: The AQuA job was submitted to the query executor for
            processing.

            - executing: The AQuA job is being processed.

            - completed: The AQuA job was successfully executed.

            - error: The AQuA job was not processed because of validation
            errors.

            - aborted: The AQuA job execution failed because one or more queries
            of this job failed.

            - cancelled: The AQuA job was cancelled.
          enum:
            - submitted
            - executing
            - completed
            - error
            - aborted
            - cancelled
          type: string
        useLastCompletedJobQueries:
          description: >
            If this flag is set to `true`, then all the previous queries are
            merged with existing queries.


            If the flag is set to `false`, then the previous queries are
            ignored, and only the new query is executed.
          type: boolean
        version:
          description: >
            The API version you want to use. 


            The supported versions are as follows:
              - `1.1`. It supports both modes
              - `1.0`. Default. It supports stateless modes only.

            See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes"
            target="_blank">Stateless and stateful modes</a> for more
            information.
          format: float
          type: number
      type: object
    BatchesQueriesById:
      properties:
        apiVersion:
          description: >
            The API version for the query. If an API version is not specified,
            the latest version is used by default. Using the latest WSDL version
            is most useful for reporting use cases. For integration purposes,
            specify the WSDL version to ensure consistent query behavior, that
            is, what is supported and included in the response returned by the
            API.


            **Note**: As of API version 69 and later, Zuora changed the format
            of certain fields. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/G_SOAP_API/AB_Getting_started_with_the__SOAP_API/C_Date_Field_Changes_in_the_SOAP_API"
            target="_blank">Date Field Changes in the SOAP API</a> for more
            information and a list of affected fields.
          type: string
        batchId:
          description: |
            A 32-character ID of the query batch.
          type: string
        batchType:
          description: |
            The kind of batch job being submitted.
          enum:
            - zoql
            - zoqlexport
          type: string
        fileId:
          description: >
            The ID of the query results file.


            Use Get Results Files to download the query results file. The query
            results file is formatted as requested in the batch job. Supported
            formats are CSV, GZIP, and ZIP.
          type: string
        full:
          description: >
            This field indicates a full or incremental load. `True` = Full and
            `False` = Incremental.
          type: boolean
        message:
          description: |
            The error message.
          maximum: 2048
          type: string
        name:
          description: |
            Name of the query supplied in the request.
          type: string
        query:
          description: |
            The requested query string.
          type: string
        recordCount:
          description: |
            The number of records included in the query output file.
          type: string
        segments:
          description: >
            Array of IDs of query results files. Replaces fileId for full data
            loads in stateful mode if <a href =
            "https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/G_File_Segmentation"
            target="_blank">File Segmentation</a> is enabled.


            Use Get Results Files to download each query results file. Each
            query results file contains at most 500,000 records and is formatted
            as requested in the batch job. Supported formats are CSV, GZIP, and
            ZIP.
          type: array
          items: {}
        status:
          description: >
            The status of the query task:

            - submitted: The query was submitted to the query executor for
            processing.

            - pending: The query was waiting for being processed.

            - executing: The query is being processed.

            - completed: The query was successfully executed.

            - aborted: The query execution failed.

            - deleted_notallowed: The query execution failed because objects
            included in the query do not support the querying of deleted
            records.
          enum:
            - submitted
            - pending
            - executing
            - completed
            - aborted
            - deleted_notallowed
          type: string
      title: batch
    GetAggregateQueryJobResponse:
      properties:
        batches:
          description: |
            A JSON array object that contains a list of batch objects.
          items:
            $ref: '#/components/schemas/BatchesQueriesById'
          required:
            - name
            - query
            - status
            - batchId
            - batchType
          type: array
        encrypted:
          description: >
            If enabled, you must supply the formatting (zip or unzip) first and
            decrypt it to get the actual contents.
          enum:
            - pgp
            - none
          type: string
        format:
          description: |
            The format of the query. The default value is `csv`.
          enum:
            - csv
            - zip
            - gzip
          type: string
        id:
          description: >
            The job ID created for the AQuA API request. The job ID can be used
            for querying for the query status. 


            The ID exists only if the JSON request can be parsed and validated
            successfully. Otherwise, the job ID is null.
          type: string
        name:
          description: |
            The name of the job. 32 character limit.
          type: string
        partner:
          description: >
            The partner field indicates the unique ID of a data integration
            partner. The dropdown list of this field displays partner IDs for
            the past thirty days.


            It must be used together with "project" field to uniquely identify a
            data integration target.


            For example, if a continuous AQuA session is to retrieve data
            incrementally for a Salesforce.com Org 00170000011K3Ub, you can use
            partner as "Salesforce", and "project" as "00170000011K3Ub." 


            This field is required only if you are using AQuA in stateful mode.
            Otherwise, if you are using AQuA in stateless mode, partner field
            can be null.


            **Note**: Zuora highly recommends you use the stateless mode instead
            of the stateful mode to extract bulk data. See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA"
            target="_blank">Bulk data extraction from Zuora using AQuA</a> for
            best practices.


            **Note**: Submit a request at <a href="http://support.zuora.com"
            target="_blank">Zuora Global Support</a> to obtain a partner ID.
          type: string
        project:
          description: >
            The project field contains the unique ID of a data integration
            project for a particular partner. The dropdown list of this field
            displays project IDs for the past thirty days.


            This field must be used together with partner field to uniquely
            identify a data integration target. 


            This field is required only if you are using AQuA in stateful mode.
            Otherwise, if you are using AQuA in stateless mode, partner field
            can be null.
          type: string
        sourceData:
          description: >
            Indicates the source this aggregate query runs against:


            * `LIVE` represents the live transactional databases at Zuora (Data
            Query Live).


            * `WAREHOUSE` represents Zuora Warehouse, which has better
            performance and fewer limitations than the live transactional
            database. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview"
            target="_blank">Zuora Warehouse</a>.
          type: string
        startTime:
          description: |
            The start time of the query. 
          type: string
        status:
          description: >
            The status of the AQuA job:

            - submitted: The AQuA job was submitted to the query executor for
            processing.

            - executing: The AQuA job is being processed.

            - completed: The AQuA job was successfully executed.

            - error: The AQuA job was not processed because of validation
            errors.

            - aborted: The AQuA job execution failed because one or more queries
            of this job failed.

            - cancelled: The AQuA job was cancelled.
          enum:
            - submitted
            - executing
            - completed
            - error
            - aborted
            - cancelled
          type: string
        version:
          description: >
            The API version you want to use. 


            The supported versions are as follows:
              - `1.1`. It supports both modes
              - `1.0`. Default. It supports stateless modes only.

            See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes"
            target="_blank">Stateless and stateful modes</a> for more
            information.
          format: float
          type: number
      type: object
    BatchQueries:
      properties:
        batchId:
          description: |
            A 32-character ID of the query batch.
          type: string
        batchType:
          description: |
            The kind of batch job being submitted.              
          enum:
            - zoql
            - zoqlexport
          type: string
        fileId:
          description: >
            The ID of the query results file.


            Use Get Results Files to download the query results file. The query
            results file is formatted as requested in the batch job. Supported
            formats are CSV, GZIP, and ZIP.
          type: string
        message:
          description: |
            The error message.
          maximum: 2048
          type: string
        name:
          description: |
            Name of the query supplied in the request.
          type: string
        query:
          description: |
            The requested query string.
          type: string
        recordCount:
          description: |
            The number of records included in the query output file.
          type: string
        segments:
          description: >
            Array of IDs of query results files. Replaces fileId for full data
            loads in stateful mode if <a href =
            "https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/G_File_Segmentation"
            target="_blank">File Segmentation</a> is enabled.


            Use Get Results Files to download each query results file. Each
            query results file contains at most 500,000 records and is formatted
            as requested in the batch job. Supported formats are CSV, GZIP, and
            ZIP.
          type: array
          items: {}
        status:
          description: >
            The status of the query task:

            - submitted: The query was submitted to the query executor for
            processing.

            - pending: The query was waiting for being processed.

            - executing: The query is being processed.

            - completed: The query was successfully executed.

            - aborted: The query execution failed.

            - deleted_notallowed: The query execution failed because objects
            included in the query do not support the querying of deleted
            records.
          enum:
            - submitted
            - pending
            - executing
            - completed
            - aborted
            - deleted_notallowed
          type: string
      title: batch
    DeleteBatchQueryJobResponse:
      properties:
        batches:
          description: |
            A JSON array object that contains a list of batch objects.
          items:
            $ref: '#/components/schemas/BatchQueries'
          required:
            - name
            - query
            - status
            - batchId
            - batchType
          type: array
        format:
          description: |
            The format of the query. The default value is `csv`.
          enum:
            - csv
            - zip
            - gzip
          type: string
        id:
          description: >
            The job ID created for the AQuA API request. The job ID can be used
            for querying for the query status. 


            The ID exists only if the JSON request can be parsed and validated
            successfully. Otherwise, the job ID is null.
          type: string
        name:
          description: |
            The name of the job. 32 character limit.
          type: string
        sourceData:
          description: >
            Indicates the source this aggregate query runs against:


            * `LIVE` represents the live transactional databases at Zuora (Data
            Query Live).


            * `WAREHOUSE` represents Zuora Warehouse, which has better
            performance and fewer limitations than the live transactional
            database. For more information, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_Warehouse/A_Zuora_Warehouse_overview"
            target="_blank">Zuora Warehouse</a>.
          type: string
        status:
          description: >
            The status of the AQuA job:

            - submitted: The AQuA job was submitted to the query executor for
            processing.

            - executing: The AQuA job is being processed.

            - completed: The AQuA job was successfully executed.

            - error: The AQuA job was not processed because of validation
            errors.

            - aborted: The AQuA job execution failed because one or more queries
            of this job failed.

            - cancelled: The AQuA job was cancelled.
          enum:
            - submitted
            - executing
            - completed
            - error
            - aborted
            - cancelled
          type: string
        version:
          description: >
            The API version you want to use. 


            The supported versions are as follows:
              - `1.1`. It supports both modes
              - `1.0`. Default. It supports stateless modes only.

            See <a
            href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes"
            target="_blank">Stateless and stateful modes</a> for more
            information.
          format: float
          type: number
      type: object
    JsonNode:
      description: Json node object contains metadata.
      title: JsonNode
      type: object
    ConfigTemplateErrorResponse:
      example:
        reasons:
          - code: ObjectNotFound
            message: Configuration Templates does not exist.
      properties:
        reasons:
          items:
            properties:
              code:
                description: |
                  The error code of response.
                type: string
              message:
                description: A detailed description of the error response.
                type: string
            type: object
          type: array
      type: object
    MigrationComponentContent:
      description: >-
        When a comparison is made between a source and target tenant, it sends a
        response to the user interface.
      properties:
        attribute:
          type: string
        componentType:
          description: Type of selected components to be migrated.
          type: string
        currentTargetResponse:
          $ref: '#/components/schemas/JsonNode'
        description:
          type: string
        disabled:
          type: string
        errorMessage:
          description: Error information.
          type: string
        httpMethods:
          type: string
        id:
          type: string
        key:
          type: string
        migratedOn:
          description: It is the time when migration is triggered.
          format: date-time
          type: string
        migrationId:
          description: Migration ID. It is generated at the time of triggering deployment.
          type: string
        pathPattern:
          description: PathPattern of component.
          type: string
        previousTargetResponse:
          $ref: '#/components/schemas/JsonNode'
        result:
          description: Returns the result details of Components.
          type: string
        segregationKey:
          description: Displays the differences between components.
          type: string
        sourceResponse:
          $ref: '#/components/schemas/JsonNode'
        status:
          description: Returns the status of each component.
          type: string
        updateStatus:
          description: Updated Status.
          type: string
      title: MigrationComponentContent
      type: object
    CompareSchemaKeyValue:
      description: >-
        When a comparison is made between a source and target tenant, it sends a
        response to the user interface.
      properties:
        difference:
          additionalProperties:
            items:
              type: string
            type: array
          description: Returns the different components list.
          type: object
        response:
          description: Provides the total reponse of the components.
          items:
            $ref: '#/components/schemas/MigrationComponentContent'
          type: array
        segregationKeys:
          description: Provides separation of components.
          items:
            type: string
          type: array
      title: CompareSchemaKeyValue
      type: object
    CompareSchemaInfoResponse:
      description: >-
        When Tenant's Compare API returns a result, this object is used to send
        the response to UI.
      properties:
        customFields:
          items:
            $ref: '#/components/schemas/CompareSchemaKeyValue'
          type: array
        customObjects:
          items:
            $ref: '#/components/schemas/CompareSchemaKeyValue'
          type: array
        dataAccessControl:
          items:
            $ref: '#/components/schemas/CompareSchemaKeyValue'
          type: array
        metaData:
          $ref: '#/components/schemas/JsonNode'
        notifications:
          items:
            $ref: '#/components/schemas/CompareSchemaKeyValue'
          type: array
        productCatalog:
          items:
            $ref: '#/components/schemas/CompareSchemaKeyValue'
          type: array
        settings:
          items:
            $ref: '#/components/schemas/CompareSchemaKeyValue'
          type: array
        workflows:
          items:
            $ref: '#/components/schemas/CompareSchemaKeyValue'
          type: array
      title: CompareSchemaInfoResponse
      type: object
    TemplateMigrationClientRequest:
      description: >
        Request to add a new Template migration.

        TemplateMigrationClientRequest object contains request details of target
        tenant, source tenant, and template information needed for migration.
      properties:
        comments:
          type: string
        description:
          description: Description of the migration.
          example: Migration from/to Sandbox
          type: string
        emailIds:
          description: List of Emails with comma separator.
          example: abcd@zuora.com,xyz@zuora.com
          type: string
        entityUuid:
          description: Entity UUID
          example: 11111
          type: string
        metaData:
          $ref: '#/components/schemas/JsonNode'
        name:
          description: Name of the migration.
          example: Job A
          type: string
        request:
          description: List of settings need to be migrated.
          example: ST 4
          items:
            $ref: '#/components/schemas/MigrationComponentContent'
          type: array
        sendEmail:
          description: Flag determines whether or not to send an email.
          example: true
          type: boolean
      required:
        - description
        - entityUuid
        - name
        - sendEmail
      title: TemplateMigrationClientRequest
      type: object
    MigrationClientResponse:
      description: Response after migration is added.
      properties:
        emailIds:
          description: 'List of Emails with comma separator '
          type: string
        environment:
          description: Environment information
          type: string
        id:
          description: Variable to hold the job ID.
          type: string
        migratedBy:
          description: User responsible for migration.
          example: Jane Cooper
          type: string
        migrationDescription:
          description: Description of the migration.
          example: Migration from/to Sandbox
          type: string
        migrationEnd:
          description: Timestamp when migration ended.
          example: '2020-11-01 18:00:00'
          type: string
        migrationName:
          description: Name of the migration.
          example: Job A
          type: string
        migrationStart:
          description: Timestamp when migration started.
          example: '2020-11-01 18:00:00'
          type: string
        response:
          items:
            $ref: '#/components/schemas/MigrationComponentContent'
          type: array
        sourceTenantDescription:
          description: Source Tenant Description.
          example: Duno
          type: string
        sourceTenantName:
          description: Source Tenant Name.
          example: Duno
          type: string
        status:
          description: Status of the Migration Job.
          example: IN PROGRESS
          type: string
        type:
          type: string
      required:
        - id
        - migratedBy
        - migrationDescription
        - migrationEnd
        - migrationName
        - migrationStart
        - sourceTenantDescription
        - sourceTenantName
        - status
      title: MigrationClientResponse
      type: object
    ConfigurationTemplateContent:
      description: It contains information about template schemas with segregation keys.
      properties:
        componentType:
          description: Type of Component.
          type: string
        error:
          description: Error Information.
          type: string
        id:
          description: Id of Each component.
          type: string
        key:
          description: Key value of fields inside component.
          type: string
        method:
          description: Http method which is used to retrieve the particular component.
          type: string
        payload:
          $ref: '#/components/schemas/JsonNode'
        result:
          description: >-
            Contains the response of details fetched regarding selected
            component.
          type: string
        segregationKey:
          description: Gives the difference between components and sub components.
          type: string
        templateId:
          description: Id of the Template.
          type: string
        url:
          description: Metadata is retrieved from this URL.
          type: string
      title: ConfigurationTemplateContent
      type: object
    SettingComponentKeyValue:
      description: >-
        Provides details about the individual components that need to be
        compared and deployed.
      properties:
        errors:
          items:
            type: string
          type: array
        originalPayload:
          $ref: '#/components/schemas/JsonNode'
        response:
          items:
            $ref: '#/components/schemas/ConfigurationTemplateContent'
          type: array
        segregationKeys:
          items:
            type: string
          type: array
      title: SettingComponentKeyValue
      type: object
    SettingSourceComponentResponse:
      description: >-
        Provides details about the different components that need to be compared
        and deployed.
      properties:
        customFields:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        customObjects:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        dataAccessControl:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        dataQuery:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        multiOrg:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        notifications:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        organizationHierarchy:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        productCatalog:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        settings:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
        workflows:
          items:
            $ref: '#/components/schemas/SettingComponentKeyValue'
          type: array
      title: SettingSourceComponentResponse
      type: object
    TemplateDetailResponse:
      description: Contains all template details.
      properties:
        active:
          description: Whether or not the template is active.
          type: boolean
        content:
          $ref: '#/components/schemas/SettingSourceComponentResponse'
        createdBy:
          description: Information about the user who created it.
          type: string
        createdOn:
          description: When it is created.
          type: string
        description:
          description: >-
            Template description which contains the information about the
            created template.
          type: string
        entityName:
          description: Name of the Entity
          type: string
        environment:
          description: Details of the environment in which the template was created.
          type: string
        errors:
          description: Error information.
          type: string
        id:
          description: Id of the template.
          type: string
        name:
          description: Name of the template.
          type: string
        status:
          description: >-
            The status of the template creation, such as whether it is in
            progress, completed, or failed.
          type: string
        tenantName:
          description: Tenant's name for whom the template is created.
          type: string
      title: TemplateDetailResponse
      type: object
    TemplateResponse:
      description: It contains a collection of all the templates that have been created.
      properties:
        templates:
          description: Contains list of template details.
          items:
            $ref: '#/components/schemas/TemplateDetailResponse'
          type: array
      title: TemplateResponse
      type: object
    CreateTemplateRequestContent:
      description: >
        CreateTemplateRequestContent object contains information for creating
        template.
      properties:
        content:
          $ref: '#/components/schemas/SettingSourceComponentResponse'
        customFields:
          description: Selected custom fields component or not.
          type: boolean
        customObjects:
          description: Selected custom objects component or not.
          type: boolean
        description:
          description: Creates template description.
          type: string
        name:
          description: Name of the Template.
          type: string
        notifications:
          description: Selected Notification component or not.
          type: boolean
        selectedComponents:
          description: >-
            ConfigurationTemplateContent object contains the selected meta data
            information.
          items:
            $ref: '#/components/schemas/ConfigurationTemplateContent'
          type: array
        settings:
          description: Selected Settings component or not.
          type: boolean
        templateTenant:
          description: ID of the template tenant.
          example: 80b3f8cd-5801-4ed7-bee7-ad1569916c2f
          type: string
        workflows:
          description: Selected Workflow component or not.
          type: boolean
      required:
        - description
        - name
        - templateTenant
      title: CreateTemplateRequestContent
      type: object
    SyncDeploymentTemplateRequest:
      description: Request schema for syncing a deployment template to another tenant.
      type: object
      properties:
        templateId:
          type: string
          description: The ID of the deployment template to be synced.
          example: f7849a41-8a3b-4cd2-8ec0-c9d225d7720b
        targetTenantId:
          type: string
          description: The ID of the target tenant to which the template should be synced.
          example: 4d6ab8fc-4faa-4ef2-a9ec-3b90bf3f3ddf
      required:
        - templateId
        - targetTenantId
    DeploymentManagerResponse:
      type: object
      properties:
        id:
          type: string
          description: ID of the Deployment Manager migration process
        status:
          type: string
          description: Status of the Deployment Manager migration process
          enum:
            - DEPLOYING
            - REVERTING
            - PARTIALLY-REVERTED
            - FAILED
            - ROLLBACK-FAILED
            - REVERTED
            - COMPARING
            - SUBMITTED
            - SKIPPED
            - IDENTICAL
            - COMPARE-DONE
            - COMPARE-FAILED
            - CANCELLED
    BulkJobRequest:
      type: object
      required:
        - name
        - objectType
      properties:
        name:
          type: string
          description: Name of the job. Max length is 255 characters
        objectType:
          type: string
          description: |-
            Type of the object. Supported object types:   
            - `account`
            - `accountingcode`
            - `accountingperiod`
            - `amendment`
            - `bill-run`
            - `bill-run-batches`
            - `bill-run-filters`
            - `contact`
            - `credit-memo`
            - `credit-memo-from-charge`
            - `credit-memo-from-invoice`
            - `debit-memo`
            - `debit-memo-from-charge`
            - `debit-memo-from-invoice`
            - `invoice`
            - `journal-entry`
            - `journal-run`
            - `offer`
            - `omni-channel-subscription`
            - `order`
            - `order-create-order-line-item`
            - `order-create-subscription-existing-account`
            - `order-create-subscription-existing-account-with-volume-charge`
            - `order-create-subscription-with-new-account`
            - `order-remove-product`
            - `order-update-subscription-add-product`
            - `order-update-subscription-change-plan`
            - `order-update-subscription-price-quantity-change`
            - `payment`
            - `payment-profile`
            - `payment-schedule`
            - `payment-schedule-item`
            - `payments-simple`
            - `payments-unapply`
            - `price-book-item`
            - `product`
            - `product-charge-definition`
            - `product-rate-plan`
            - `product-rate-plan-charge`
            - `product-rate-plan-charge-tier`
            - `product-rate-plan-definition`
            - `refund`
            - `revenue-accounting-code`
            - `subscription`
            - `subscription-add-rate-plan`
            - `subscription-change-rate-plan`
            - `subscription-remove-rate-plan`
            - `subscription-update-rate-plan`
            - `taxation-item`
            - `unitofmeasure`
            - `usage`
        description:
          type: string
          description: Short description of the job. Max length is 255 characters
        mappings:
          type: array
          description: >-
            List of mappings. Each mapping maps a source field to a target field
            in the object. If the field is an array, the type and arrayType must
            be specified.
          items:
            type: object
            required:
              - source
              - target
            properties:
              source:
                type: string
                description: Source field name
              target:
                type: string
                description: >
                  Target field name. 


                  **Note**: The `target` field must not contain spaces, dots
                  (`.`), underscores (`_`), or asterisks (`*`).
              type:
                type: string
                description: Field type
                enum:
                  - array
                  - string
                  - number
                  - boolean
              arrayType:
                type: string
                description: Type of objects in the array if the field is an array type
                enum:
                  - string
                  - number
                  - boolean
        headers:
          type: array
          description: >-
            List of headers in the source file. Required if the source file does
            not have a header row.
          items:
            type: string
        rowIdHeader:
          type: string
          description: Header in the source file that contains the row id.
        delimiter:
          type: string
          description: |-
            Delimiter used in the source file. Default is comma.
              Supported values: comma, tab, pipe, semicolon, colon, caret, tilde, dot/period
        hasHeaders:
          type: boolean
          description: Indicates if the source file has a header row. Default is false
        fileType:
          type: string
          description: >-
            Type of the source file. Supported values: csv, jsonl 

            Default is csv, which means delimited file where the delimiter can
            be comma but can also be one of the other supported delimiters
          enum:
            - csv
            - jsonl
        jobType:
          type: string
          description: Type of the bulk job being created. Default is IMPORT
          enum:
            - Import
            - Delete
            - Update
            - Cancel
        isCustomObject:
          type: boolean
          description: Indicates if the object type is a custom object. Default is false
        customObjectNamespace:
          type: string
          description: >-
            Namespace of the custom object. Applicable only when isCustomObject
            is true. Default namespace is 'default'.
        dataSourceType:
          type: string
          description: The data source type of the job
          readOnly: true
          enum:
            - UserUpload
            - Salesforce
            - Chargebee
            - Stripe
        systemType:
          type: string
          description: The system type for the job
          readOnly: true
          enum:
            - BILLING
    CreateResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the job
        uploadUrl:
          type: string
          description: >-
            URL to upload the file. This is the URL to which the file should be
            uploaded using a PUT request.
        uploadRequest:
          type: object
          properties:
            uri:
              type: string
              format: uri
              description: URL to which the file must be uploaded.
            fields:
              type: object
              description: Form fields required to complete the S3 file upload.
              additionalProperties:
                type: string
        status:
          type: string
          description: Status of the job
          enum:
            - Created
            - Submitted
            - In Progress
            - Aborting
            - Completed
            - Failed
            - Aborted
            - Cancelled
            - Downloading
        jobType:
          type: string
          description: Type of the job
          enum:
            - Import
            - Delete
            - Update
            - Cancel
    UploadRequest:
      type: object
      description: Information required to upload the file to S3.
      properties:
        uri:
          type: string
          format: uri
          description: URL to which the file must be uploaded.
        fields:
          type: object
          description: Form fields to include in the upload request.
          additionalProperties:
            type: string
    SubmitBulkJobResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the job
        uploadUrl:
          type: string
          description: >-
            URL to upload the file. This is the URL to which the file should be
            uploaded using a PUT request.
        uploadRequest:
          $ref: '#/components/schemas/UploadRequest'
        status:
          type: string
          description: Status of the job
          enum:
            - Created
            - Submitted
            - In Progress
            - Aborting
            - Completed
            - Failed
            - Aborted
            - Cancelled
            - Downloading
        jobType:
          type: string
          description: Type of the job
          readOnly: true
          enum:
            - Import
            - Delete
            - Update
            - Cancel
    QueryJobSummaryResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the job
          readOnly: true
        name:
          type: string
          description: Name of the job
          readOnly: true
        description:
          type: string
          description: Description of the job
          readOnly: true
        createdAt:
          type: integer
          format: int64
          description: Time the job was created
          readOnly: true
        createdBy:
          type: string
          description: User who created the job
          readOnly: true
        status:
          type: string
          description: Status of the job
          readOnly: true
          enum:
            - Created
            - Submitted
            - In Progress
            - Aborting
            - Completed
            - Failed
            - Aborted
            - Cancelled
            - Downloading
        rowCount:
          type: integer
          format: int32
          description: Number of rows in the job
          readOnly: true
        rowsSucceeded:
          type: integer
          format: int32
          description: Number of rows that succeeded in the job
          readOnly: true
        rowsFailed:
          type: integer
          format: int32
          description: Number of rows that failed in the job
          readOnly: true
        lastUpdatedAt:
          type: integer
          format: int64
          description: Time the job was last updated
          readOnly: true
        failureReason:
          type: string
          description: Reason the job failed
          readOnly: true
        objectType:
          type: string
          description: Type of object the job is for
          readOnly: true
        jobType:
          type: string
          description: Type of job
          readOnly: true
          enum:
            - Import
            - Delete
            - Update
            - Cancel
        isCustomObject:
          type: boolean
          description: Whether the job is for a custom object
          readOnly: true
        customObjectNamespace:
          type: string
          description: Namespace of the custom object the job is for
          readOnly: true
        dataSourceType:
          type: string
          description: Type of data source the job is for
          readOnly: true
          enum:
            - UserUpload
            - Salesforce
            - Chargebee
            - Stripe
        systemType:
          type: string
          description: Type of system the job is for
          readOnly: true
          enum:
            - BILLING
        fileType:
          type: string
          description: Type of the source file
          readOnly: true
          enum:
            - csv
            - jsonl
    IdStatusResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the job
          readOnly: true
        status:
          type: string
          description: Status of the job
          readOnly: true
          enum:
            - Created
            - Submitted
            - In Progress
            - Aborting
            - Completed
            - Failed
            - Aborted
            - Cancelled
            - Downloading
    DownloadsResponse:
      type: object
      properties:
        jobId:
          type: string
          format: uuid
          description: Unique identifier for the job.
          readOnly: true
        status:
          type: string
          description: Status of the job.
          enum:
            - Created
            - Submitted
            - In Progress
            - Aborting
            - Completed
            - Failed
            - Aborted
            - Cancelled
            - Downloading
          readOnly: true
        sourceFile:
          type: string
          description: Source file URL.
          readOnly: true
        errorRowsFile:
          type: string
          description: URL for the file containing rows that failed.
          readOnly: true
        successRowsFile:
          type: string
          description: URL for the file containing successfully processed rows.
          readOnly: true
        delimiter:
          type: string
          description: Delimiter used in the source file (e.g., comma or pipe).
          readOnly: true
    GetSummariesResponse:
      type: object
      properties:
        data:
          type: array
          description: List of job summaries
          readOnly: true
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                description: Unique identifier for the job
                readOnly: true
              name:
                type: string
                description: Name of the job
                readOnly: true
              status:
                type: string
                description: Status of the job
                readOnly: true
                enum:
                  - Created
                  - Submitted
                  - In Progress
                  - Aborting
                  - Completed
                  - Failed
                  - Aborted
                  - Cancelled
                  - Downloading
              description:
                type: string
                description: Description of the job
                readOnly: true
              createdAt:
                type: integer
                format: int64
                description: Time the job was created
                readOnly: true
              createdBy:
                type: string
                description: User who created the job
                readOnly: true
              submittedAt:
                type: integer
                format: int64
                description: Time the job was submitted
                readOnly: true
              submittedBy:
                type: string
                description: User who submitted the job
                readOnly: true
              rowCount:
                type: integer
                format: int32
                description: Number of rows in the job
                readOnly: true
              rowsSucceeded:
                type: integer
                format: int32
                description: Number of rows that succeeded in the job
                readOnly: true
              rowsFailed:
                type: integer
                format: int32
                description: Number of rows that failed in the job
                readOnly: true
              lastUpdatedAt:
                type: integer
                format: int64
                description: Time the job was last updated
                readOnly: true
              failureReason:
                type: string
                description: Reason the job failed
                readOnly: true
              objectType:
                type: string
                description: Type of object the job is for
                readOnly: true
              jobType:
                type: string
                description: Type of job
                readOnly: true
                enum:
                  - Import
                  - Delete
                  - Update
                  - Cancel
              isCustomObject:
                type: boolean
                description: Whether the job is for a custom object
                readOnly: true
              customObjectNamespace:
                type: string
                description: Namespace of the custom object the job is for
                readOnly: true
              dataSourceType:
                type: string
                description: Type of data source the job is for
                readOnly: true
                enum:
                  - UserUpload
                  - Salesforce
                  - Chargebee
                  - Stripe
              systemType:
                type: string
                description: Type of system the job is for
                readOnly: true
                enum:
                  - BILLING
              fileType:
                type: string
                readOnly: true
                enum:
                  - csv
                  - jsonl
        nextPageCursor:
          type: string
          description: Cursor for the next page of results
          readOnly: true
    SubmitDataLabelingJobRequest:
      example:
        objectType: Account
        orgIds:
          - 12345678-1234-1234-1234-123456789012
        query: select Id from Account where BillToContact.Country = 'US'
        queryType: ByZoql
      properties:
        ids:
          description: >
            The IDs of the objects to be labeled, only required if the
            `queryType` is `ById`.


            There is a 4MB limit of the JSON payload, so in case of a large
            number of IDs, please make sure the payload is less than 4MB.
          items:
            type: string
          type: array
        objectType:
          description: |
            The object type of the data labeling job.

            Currently, the following objects are supported:
              * `User`
              * `Account` 

                All the associated transaction objects of the account being labeled will automatically inherit the org label of the account.
              * `Product`

                You have to label the Account object first, make sure all accounts have been labeled, then you can proceed with the Product object. 

                You can get all the unlabeled accounts by running a Data Source export job, with the following query:
                ``` sql
                SELECT Id, Name FROM Account WHERE Organization.Id IS NULL
                ```              
                
                All the ProductRatePlanS of the product will be automatically labeled with the same `orgs`.
                
                When labeling products, you can omit the `orgs` parameter, i.e, leave it empty, the system will find all the subscriptions that include the product and get the org list of those subscriptions, then label the product with those `orgs`, aka, the `derived orgs`.
                
                You can also explicitly specify the orgs parameter, in that case, you will need to provide a super set of the `derived orgs`.  
              * `BillRun`

                You don't need to specify the `orgs` parameter, we will label the `BillRun` with all the orgs because existing runs could pick up all accounts. You can definitely create new bill run with certain `orgs` to operate separately by `orgs`.
              * `PaymentRun`

                Same as BillRun.
              * `ForecastRun`
          type: string
        orgIds:
          description: >
            The IDs of the organizations that the data labeling job will
            associate with the data to be labeled. Either the `orgIds` or `orgs`
            field is required.


            For `Account` object, one and only one org Id is required.


            For configuration objects, `null` and `[]` are treated differently,
            use `null` to unlabel the object, `[]` to label it with all orgs.
          format: byte
          items:
            format: uuid
            maxLength: 36
            minLength: 36
            type: string
          type: array
        orgs:
          description: >
            The names of the organizations that the data labeling job will
            associate with the data to be labeled. Either the `orgIds` or `orgs`
            field is required.


            For `Account` object, one and only one org name is required.


            For configuration objects, `null` and `[]` are treated differently,
            use `null` to unlabel the object, `[]` to label it with all orgs.
          items:
            type: string
          type: array
        query:
          description: >
            The query that the data labeling job will run to fetch the data to
            be labeled, only required if the `queryType` is `ByZoql`.
          type: string
        queryType:
          description: >
            Specifies the type of query that the data labeling job will run to
            fetch the data to be labeled.


            * `ByZoql` - The data labeling job will run a ZOQL query which is
            specified in the `query` field to fetch the data to be labeled.

            * `ById` - The data labeling job will fetch the data to be labeled
            by the IDs specified in the `ids` field.
          enum:
            - ByZoql
            - ById
          type: string
      required:
        - objectType
        - queryType
      type: object
    SubmitDataLabelingJobResponse:
      properties:
        jobId:
          description: |
            Identifier of the data labeling job.
          format: uuid
          maxLength: 32
          minLength: 32
          type: string
        jobStatus:
          description: >
            Status of the data labeling job.


            * `Accepted` - The data labeling job has been accepted by the
            system.

            * `Dispatched` - The data labeling job is dispatched to the data
            labeling service.

            * `Completed` - The data labeling job has completed. Please note
            that `Completed` simply means the data labeling job has completed,
            but it does not mean the data labeling job has labeled all the data.
            You can check the `progress` field to see how many data have been
            `labeled`, `failed` or `timeout`.
          enum:
            - Accepted
            - Dispatched
            - Completed
          type: string
        success:
          description: |
            Indicates whether the job was submitted successfully.
          type: boolean
      type: object
    GetDataLabelingJobResponse:
      properties:
        jobId:
          description: |
            Identifier of the data labeling job.
          format: uuid
          maxLength: 32
          minLength: 32
          type: string
        jobStatus:
          description: >
            Status of the data labeling job.


            * `Accepted` - The data labeling job has been accepted by the
            system.

            * `Dispatched` - The data labeling job is dispatched to the data
            labeling service.

            * `Completed` - The data labeling job has completed. Please note
            that `Completed` simply means the data labeling job has completed,
            but it does not mean the data labeling job has labeled all the data.
            You can check the `progress` field to see how many data have been
            `labeled`, `failed` or `timeout`.
          enum:
            - Accepted
            - Dispatched
            - Completed
          type: string
        objectType:
          description: |
            The object type of the data labeling job.
          type: string
        progress:
          properties:
            failed:
              description: |
                The number of objects that have failed to be labeled.
              type: integer
            labeled:
              description: |
                The number of objects that have been labeled.
              type: integer
            timeout:
              description: >
                The number of objects that have timed out to be
                labeled.          
              type: integer
          type: object
        success:
          description: |
            Indicates whether the job was submitted successfully.
          type: boolean
        totalObject:
          description: |
            The total number of objects to be labeled.
          type: integer
      type: object
    RegenerateBookingRequest:
      example:
        subscriptionName: A-S00000001
        subscriptionVersion: 1
        type: Subscription
      properties:
        itemNumber:
          description: |
            The item number.
          type: string
        orderLineItemId:
          description: |
            The order line item ID.
          type: string
        orderNumber:
          description: |
            The order number.
          type: string
        subscriptionId:
          description: |
            The subscription ID.
          type: string
        subscriptionName:
          description: |
            The subscription name.
          type: string
        subscriptionVersion:
          description: |
            The subscription version.
          type: integer
        ratePlanChargeId:
          description: |
            The rate plan charge ID of dynamic usage charge.
          type: string
        chargeNumber:
          description: |
            The charge number of dynamic usage charge.
          type: string
        type:
          description: >
            The type of business object for which you want to generate the
            transactions.
          enum:
            - Subscription
            - OrderLineItem
            - DynamicUsageCharge
          type: string
      type: object
    ResponseReasons:
      properties:
        code:
          description: |
            The error code of response.
          type: string
        message:
          description: |
            The detail information of the error response.
          type: string
      type: object
    RegenerateTransactionObjectResponse:
      properties:
        idList:
          description: >
            A list of the IDs for the business objects for which you generate
            the transactions. 
          items:
            type: string
          type: array
        reasons:
          items:
            $ref: '#/components/schemas/ResponseReasons'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    RegenerateBillingRequest:
      example:
        number: CM00000001
        type: CreditMemo
      properties:
        id:
          description: |
            ID of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment.
          type: string
        number:
          description: |
            Number of Invoice, CreditMemo, DebitMemo, or InvoiceItemAdjustment.
          type: string
        type:
          description: >
            The type of business object for which you want to generate the
            transactions.
          enum:
            - Invoice
            - CreditMemo
            - DebitMemo
            - InvoiceItemAdjustment
          type: string
      type: object
    RegenerateRevRecEventsResponse:
      properties:
        reasons:
          items:
            $ref: '#/components/schemas/ResponseReasons'
          type: array
        success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    DailyConsumptionRevRecRequest:
      example:
        chargeSegmentNumber: '1'
        fundId: 2c9890508ad035db018ad0d8d1685fef
        originalChargeId: 2c9890508ad035db018ad0d8d1685fef
      properties:
        chargeSegmentNumber:
          description: |
            Rate plan charge number.
          type: string
        fundId:
          description: >
            Fund ID. For more information about fund, see <a
            href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Prepaid_with_Drawdown"
            target="_blank">Prepaid with Drawdown</a>.
          type: string
        originalChargeId:
          description: |
            Original rate plan charge ID.
          type: string
      required:
        - originalChargeId
      type: object
    GETAutoBackfillJobResponse:
      type: object
      properties:
        id:
          description: Job ID
          type: string
        createdOn:
          description: |
            The created-on date in the `int64` format
          type: integer
          format: int64
        createdOnReadable:
          description: |
            The created-on date in the `datetime` format
          type: string
          format: datetime
        updatedOn:
          description: |
            The updated-on date in the `int64` format
          type: integer
          format: int64
        updatedOnReadable:
          description: |
            The updated-on date in the `datetime` format
          type: string
          format: datetime
        updatedByUsername:
          description: |
            The user who performs the booking date backfill job
          type: string
        status:
          description: |
            The status of the booking date backfill job
          type: string
          enum:
            - ACCEPTED
            - PROCESSING
            - COMPLETED
            - FAILED
            - STOPPED
        type:
          description: |
            The type of the auto backfill job
          type: string
          enum:
            - BookingDate
            - RatePlanCharge
            - OrderLineItem
        batchSentCount:
          description: |
            The batch count sent for execution
          type: integer
          format: int32
        batchFinishedCount:
          description: |
            The finished batch count
          type: integer
          format: int32
        errorCount:
          description: |
            The failed record count
          type: integer
          format: int32
        progress:
          description: |
            The progress of the booking date backfill job
          type: string
    DataBackfillJobType:
      description: The data backfill job type
      type: string
      enum:
        - ProductRatePlanCharge
        - RatePlanCharge
        - InvoiceDetail
        - MemoDetail
        - InvoiceItemAdjustment
    DataBackfillJobStatus:
      description: The status of the data backfill job
      type: string
      enum:
        - Pending
        - Processing
        - Completed
        - Canceled
        - Failed
        - Stopping
        - Stopped
    DataBackfillJob:
      type: object
      properties:
        id:
          description: Job ID
          type: string
        importType:
          $ref: '#/components/schemas/DataBackfillJobType'
        uploadedFileId:
          description: ID of the uploaded file
          type: string
        uploadedFileName:
          description: Name of the uploaded file
          type: string
        uploadedFileUrl:
          description: >-
            URL of the uploaded file. You can download the uploaded file via
            this url.
          type: string
        uploadedFileSize:
          description: Size of the uploaded file
          type: string
        inputFileSize:
          description: Size of the uploaded file, in the `int64` format
          type: integer
          format: int64
        outputSize:
          description: |
            Size of the output file. 
          type: string
        outputType:
          description: Type of the output file.
          type: string
        outputFileSize:
          description: |
            Size of the output file, in the `int64` format. 
          type: integer
          format: int64
        resultFileId:
          description: >
            ID of the output result file that you can download when a data
            backfill job is completed. 
          type: string
        resultFileName:
          description: >
            Name of the result file that you can download when a data backfill
            job is completed
          type: string
        resultFileUrl:
          description: >
            URL of the result file that you can download when a data backfill
            job is completed. You can download the result file via this URL. In
            the result file, you can see the data that you uploaded and the
            result for each record in the `Success` column of the file. For the
            record that fails to be updated, you can see the reason for failure
            in the `Error Message` column of the file.
          type: string
        uploadedBy:
          description: |
            The user who uploads the file
          type: string
        uploadedOn:
          description: |
            The date and time when the file is uploaded
          type: string
          format: date-time
        completedOn:
          description: |
            The date and time when the data backfill action is completed
          type: string
          format: date-time
        startedProcessingOn:
          description: |
            The date and time when the data backfill action is started
          type: string
          format: date-time
        totalCount:
          description: |
            The total count of the data records to backfill
          type: integer
          format: int32
        failedCount:
          description: |
            The count of the data records that failed to be backfilled
          type: integer
          format: int32
        status:
          $ref: '#/components/schemas/DataBackfillJobStatus'
        failureMessage:
          description: |
            Message for the failure
          type: string
        processedCount:
          description: |
            The count of the data records that are being processed
          type: integer
          format: int64
        successCount:
          description: |
            The count of the data records that are successfully backfilled
          type: integer
          format: int64
        remainingTime:
          description: |
            The remaining time for the data backfill job, in the `int64` format
          type: integer
          format: int64
        remainingTimeText:
          description: |
            The remaining time for the data backfill job, in the text format
          type: string
        completedPercentage:
          description: |
            The percentage of the completed data records
          type: integer
          format: int32
    zObject:
      additionalProperties:
        description: |
          Field of the object.
      type: object
    ProxyActioncreateRequest:
      example:
        type: Account
        objects:
          - Name: Amy Lawrence
            Status: Draft
            Currency: USD
            BillCycleDay: 1
      properties:
        objects:
          description: ''
          items:
            $ref: '#/components/schemas/zObject'
          type: array
        type:
          description: ''
          type: string
      required:
        - objects
        - type
      type: object
    ActionsErrorResponse:
      properties:
        Code:
          description: ''
          type: string
        Message:
          description: ''
          type: string
      type: object
    SaveResult:
      properties:
        Errors:
          description: ''
          items:
            $ref: '#/components/schemas/ActionsErrorResponse'
          type: array
        Id:
          description: ''
          type: string
        Success:
          description: ''
          type: boolean
      type: object
    ProxyActiondeleteRequest:
      example:
        type: ProductRatePlanCharge
        ids:
          - 2c93808457d787030157e031fcd34e19
      properties:
        ids:
          description: |
            A list of one or more IDs for the objects you want to delete.
          items:
            type: string
          type: array
        type:
          description: |
            The type of object that you are deleting.
          type: string
      required:
        - type
        - ids
      type: object
    DeleteResult:
      properties:
        errors:
          description: |
            If the delete failed, this contains an array of Error objects.
          items:
            $ref: '#/components/schemas/ActionsErrorResponse'
          type: array
        id:
          description: |
            ID of the deleted object.
          type: string
        success:
          description: >
            A boolean field indicating the success of the delete operation. If
            the delete was successful, it is `true`. Otherwise, `false`.
          type: boolean
      type: object
    ProxyActionqueryRequest:
      example:
        queryString: >-
          select AccountNumber, BillCycleDay from Account where Id =
          '8ad09378905a5af201907ca1edb524c2'
      properties:
        conf:
          description: Configuration of the query result.
          properties:
            batchSize:
              description: >
                Defines the batch size of the query result. The range is 1 -
                2000 (inclusive). If a value higher than 2000 is submitted, only
                2000 results are returned.
              type: integer
          type: object
        queryString:
          description: >
            [ZOQL](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language)
            expression that specifies the object to query, the fields to
            retrieve, and any filters.


            **Note:** When querying one time charges from ProductRatePlanCharge,
            you need to specify the `ChargeType` value as `One-Time` rather than
            `OneTime`.
          type: string
      required:
        - queryString
      type: object
    ProxyActionqueryResponse:
      properties:
        done:
          description: >
            Indicates whether the returned records contain all the query
            results.

            * If the `queryLocator` field is returned, this field is set to
            `false`.

            * If no `queryLocator` field is returned, this field is set to
            `true`.
          type: boolean
        queryLocator:
          description: >-
            A marker passed to QueryMore to get the next set of results. For
            more information, see
            [QueryMore](https://developer.zuora.com/api-references/api/operation/Action_POSTqueryMore/).
          type: string
        records:
          description: A list of queried results.
          items:
            $ref: '#/components/schemas/zObject'
          type: array
        size:
          description: The number of the returned query results.
          format: int32
          type: integer
      type: object
    ProxyActionqueryMoreRequest:
      example:
        queryLocator: 2c92c0f9602fb240016049ac7e0b47e7-2000
      properties:
        conf:
          description: Configuration of the query result.
          properties:
            batchSize:
              description: >
                Defines the batch size of the query result. The range is 1 -
                2000 (inclusive). If a value higher than 2000 is submitted, only
                2000 results are returned.
              type: integer
          type: object
        queryLocator:
          description: A marker passed to QueryMore to get the next set of results.
          type: string
      required:
        - queryLocator
      type: object
    ProxyActionqueryMoreResponse:
      properties:
        done:
          description: >
            Indicates whether the returned records contain all the query
            results.

            * If the `queryLocator` field is returned, this field is set to
            `false`.

            * If no `queryLocator` field is returned, this field is set to
            `true`.
          type: boolean
        queryLocator:
          description: A marker passed to QueryMore to get the next set of results.
          type: string
        records:
          description: A list of queried results.
          items:
            $ref: '#/components/schemas/zObject'
          type: array
        size:
          description: The number of the returned query results.
          format: int32
          type: integer
      type: object
    zObject_update:
      allOf:
        - properties:
            Id:
              description: ''
              type: string
            fieldsToNull:
              description: |
                Used to set a list of fields to null.
              items:
                type: string
              type: array
          required:
            - Id
          type: object
        - $ref: '#/components/schemas/zObject'
      title: zObject
    ProxyActionupdateRequest:
      example:
        objects:
          - Id: 8ad09378905a5af201907ca1edb524c2
            BillCycleDay: 1
        type: Account
      properties:
        objects:
          description: ''
          items:
            $ref: '#/components/schemas/zObject_update'
          type: array
        type:
          description: ''
          type: string
      required:
        - objects
        - type
      type: object
    BodyInSettingValueRequest:
      additionalProperties: true
      description: Request payload if any
      title: settingsRequestBody
      type: object
    ChildrenSettingValueRequest:
      properties:
        body:
          $ref: '#/components/schemas/BodyInSettingValueRequest'
        id:
          description: >
            The id of the request. You can set it to any string. It must be
            unique within the whole batch.
          type: string
        method:
          description: >
            One of the HTTP methods supported by the setting endpoint, for
            example, GET,PUT,POST or DELETE.
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        url:
          description: >
            The relative URL of the setting. It is the same as in the
            `pathPattern` field in the response body of [Listing all
            settings](https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings).
            For example, `/billing-rules`.
          type: string
      title: childSettingsRequest
      type: object
    SettingValueRequest:
      properties:
        body:
          $ref: '#/components/schemas/BodyInSettingValueRequest'
        children:
          description: >
            An array of requests that can only be executed after its parent
            request has been executed successfully.
          items:
            $ref: '#/components/schemas/ChildrenSettingValueRequest'
          type: array
        id:
          description: >
            The id of the request. You can set it to any string. It must be
            unique within the whole batch.
          type: string
        method:
          description: >
            One of the HTTP methods supported by the setting endpoint, for
            example, GET,PUT,POST or DELETE.
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        url:
          description: >
            The relative URL of the setting. It is the same as in the
            `pathPattern` field in the response body of [Listing all
            Settings](https://developer.zuora.com/api-references/api/operation/GET_ListAllSettings).
            For example, `/billing-rules`.
          type: string
      title: settingsRequest
      type: object
    SettingsBatchRequest:
      example:
        requests:
          - id: '1'
            method: GET
            url: /billing-rules
          - id: '2'
            method: GET
            url: /accounting-rules
      properties:
        requests:
          items:
            $ref: '#/components/schemas/SettingValueRequest'
          type: array
      type: object
    BodyInSettingValueReponse:
      additionalProperties: true
      description: Response body if the request is executed successfully.
      title: settingsResponseBody
      type: object
    SettingValueResponse:
      properties:
        body:
          $ref: '#/components/schemas/BodyInSettingValueReponse'
        errorMessages:
          description: >
            An array of error messages if errors occur when executing the
            request.
          items:
            type: string
          type: array
        status:
          description: |
            User readable response status, for example, 502 BAD_GATEWAY.
          type: string
      title: settingsValueResponse
      type: object
    SettingValueResponseWrapper:
      properties:
        id:
          description: |
            The Id of the corresponding request.
          type: string
        method:
          description: >
            The HTTP method. It is the same as that of the corresponding
            request.
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        response:
          $ref: '#/components/schemas/SettingValueResponse'
        url:
          description: |
            The url as specified in the corresponding request.
          type: string
      title: settingsValueResponseWrapper
      type: object
    SettingsBatchResponse:
      properties:
        responses:
          items:
            $ref: '#/components/schemas/SettingValueResponseWrapper'
          type: array
      title: batchResponse
      type: object
    SettingItemHttpRequestParameter:
      properties:
        description:
          description: The description of the paramter.
          type: string
        name:
          description: The name of the parameter.
          type: string
      title: httpRequestParameter
      type: object
    SettingItemHttpOperation:
      properties:
        method:
          description: >-
            One of the HTTP methods supported by the setting endpoint, for
            example, GET,PUT,POST or DELETE.
          enum:
            - GET
            - HEAD
            - POST
            - PUT
            - PATCH
            - DELETE
            - OPTIONS
            - TRACE
          type: string
        parameters:
          description: An array of paramters required by this operation.
          items:
            $ref: '#/components/schemas/SettingItemHttpRequestParameter'
          type: array
        requestType:
          description: JSON Schema for the request body of this operation.
          type: object
        responseType:
          description: JSON Schema for the response body of this operation.
          type: object
        url:
          description: >-
            The endpoint url of the operation method. For example,
            `/settings/billing-rules`.
          type: string
      title: httpOperation
      type: object
    SettingItemWithOperationsInformation:
      properties:
        context:
          description: The context where this setting item is effective.
          enum:
            - Tenant
            - Entity
            - User
            - None
          type: string
        description:
          description: The description of the setting item as you see from Zuora UI.
          type: string
        httpOperations:
          description: >-
            An array of HTTP operation methods that are supported on this
            setting endpoint.
          items:
            $ref: '#/components/schemas/SettingItemHttpOperation'
          type: array
        key:
          description: The unique key to distinguish the setting item.
          type: string
        pathPattern:
          description: >-
            The path pattern of the setting endpoint, relative to `/settings`.
            For example, `/billing-rules`.
          type: string
      title: settingItem
      type: object
    ListAllSettingsResponse:
      properties:
        settings:
          items:
            $ref: '#/components/schemas/SettingItemWithOperationsInformation'
          type: array
      title: allSettings
      type: object
    RestoreFile:
      properties:
        success:
          description: >
            Returns `true` if the request was processed successfully.


            Returns `false` if the quota limit is exceeded, and you will see an
            error message in the response body.


            For example,


            "Your file restoration request can not be processed currently due to
            reaching the maximum daily limit of 1000 files as of 2024-04-01
            14:12. Please wait for the limit to be refreshed or reach out to
            Zuora support if the request is urgent."


            In such cases, wait for a limit refresh or submit a request at
            [Zuora Global Support](https://support.zuora.com/).
          type: boolean
        fileId:
          description: |
            The unique ID of the file.
          type: string
        status:
          description: |
            The status of the file restore operation.
          enum:
            - ACTIVE
            - ARCHIVING
            - ARCHIVED
            - RESTORE_ACCEPTED
            - RESTORE_IN_PROGRESS
            - RESTORED
          type: string
      type: object
    RetrieveFileStatus:
      properties:
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        accessible:
          description: |
            Returns `true` if the file is accessible.
          type: boolean
        status:
          description: |
            The status of the file restore operation.
          enum:
            - ACTIVE
            - ARCHIVING
            - ARCHIVED
            - RESTORE_ACCEPTED
            - RESTORE_IN_PROGRESS
            - RESTORED
          type: string
      type: object
    ProxyPostImport:
      properties:
        Id:
          description: |
            The ID of the Import object that was created.
          type: string
        Success:
          description: |
            Indicates whether the call succeeded.
          type: boolean
      type: object
    ProxyGetImport:
      properties:
        CreatedById:
          description: |2-
             The user ID of the person who created the import.

            **Character limit**: 32

            **Values**: automatically generated 
          type: string
        CreatedDate:
          description: |2-
             The date when the import was created.

            **Character limit**: 29

            **Values**: automatically generated 
          format: date-time
          type: string
        Id:
          description: Object identifier.
          type: string
        ImportType:
          description: |2-
             The type of item imported.

            **Character limit**: 7

            **Values**: Usage 
          type: string
        ImportedCount:
          description: |-
            The number of records successfully imported.

            **Values**: automatically generated 
          format: int32
          type: integer
        Md5:
          description: |2-
             A check to validate the import file's integrity.

            **Character limit:** 32

            **System-generated:** no

            **Values**: a string of 32 characters or fewer 
          type: string
        Name:
          description: |2
             A descriptive name for the import.

            **Character limit:** 100

            **Values:** one of the following:

            - a string of 100 characters or fewer
            - if NULL default is: `import <ImportType_value>`
          type: string
        OriginalResourceUrl:
          description: |2-
             The URL for your import file, which contains your records for upload. When you upload the file, Zuora assigns it to this address.

            **Values:** automatic dynamically-generated URL 
          type: string
        ResultResourceUrl:
          description: |2-
             The URL for the import result file, which is a zipped CSV file.

            **Values**: automatic dynamically-generated URL 
          type: string
        Status:
          description: >
            The status of the import process.


            **Values**: automatically generated using one of the following
            values:


            - Pending

            - Processing

            - Completed

            - Failed
          type: string
        StatusReason:
          description: |2-
             The reason for the system-generated status. Use this information if the import fails.

            **Character limit**: 2000

            **Values**: automatically generated error message 
          type: string
        TotalCount:
          description: |2-
             The number of records in the import file.

            **Character limit**:

            **Values**: automatically generated 
          format: int32
          type: integer
        UpdatedById:
          description: |2-
             The ID of the user who last updated the import.

            **Character limit**: 32

            **Values**: automatically generated 
          type: string
        UpdatedDate:
          description: |2-
             The date when the import was last updated.
            **Character limit**: 29 **Values**: automatically generated 
          format: date-time
          type: string
      type: object
    GETCustomExchangeRatesType:
      properties:
        inverse:
          description: >
            - If `true`, the exchange rate in the response is an inverse
            exchange rate.

            - If `false`, the exchange rate in the response is not an inverse
            exchange rate.

            The value is determined by the **Use inverse rate** checkbox in your
            Zuora Finance Manage Currency Conversion settings.
          type: boolean
        rateSetName:
          description: >
            The name of the exchange rate set.


            You can specify the exchange rate set only when **Exchange Rate
            Set** permission is available. To enable the **Exchange Rate Set**
            option, submit a request at [Zuora Global
            Support](http://support.zuora.com/).
          type: string
        rates:
          description: >
            Container for exchange rate data. Contains a set of fields that
            provide exchange rate data for each day between the specified
            `startDate` and `endDate` (inclusive). 
          additionalProperties:
            type: object
            title: rate
            description: >
              Container for exchange rate information on a given date. The field
              name is a  date in the `yyyy-mm-dd` format. For example,
              `2024-01-15`.
            properties:
              providerExchangeRateDate:
                description: >
                  The date of the exchange rate used. The date is in
                  `yyyy-mm-dd` format.


                  Corresponds to the value specified in the Provider Exchange
                  Rate Date column in the Import Foreign Exchange Rates template
                  when you uploaded the rates through the Mass Updater.
                format: date
                type: string
            additionalProperties:
              type: number
              format: double
              description: >
                The exchange rate on the **providerExchangeRateDate**.

                The field name is the ISO currency code of the currency, for
                example, `EUR`. The value is the exchange rate for the specified
                date, in the format of `0.0000000000`.


                There may be more than one currency returned for a given
                  **providerExchangeRateDate**. If the rate for a certain currency is
                  not available on the **providerExchangeRateDate**, the currency is not
                  returned in the response.
          type: object
          title: rates
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    POSTAttachmentResponseType:
      properties:
        fileId:
          description: >
            ID to identify the attached file. Use this file ID with [Get
            files](https://developer.zuora.com/api-references/api/operation/GET_Files)
            to download the file.
          type: string
        id:
          description: |
            Attachment id.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
    GETAttachmentResponseType:
      properties:
        createdBy:
          description: |
            Zuora user id who added this attachment to the object.
          type: string
        createdOn:
          description: |
            Date and time when the attachment was added to the object.
          format: date-time
          type: string
        description:
          description: |
            Description of the attachment.
          type: string
        fileContentType:
          description: |
            File type.
          type: string
        fileId:
          description: >
            File ID of the attached file. Use this file ID with [Get
            files](https://developer.zuora.com/api-references/api/operation/GET_Files)
            to download the file.
          type: string
        fileName:
          description: |
            Attachment file name.
          type: string
        id:
          description: |
            Id of this attachment.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
        updatedBy:
          description: |
            Zuora user id who last updated the attachment.
          type: string
        updatedOn:
          description: |
            Date and time when the attachment was last updated.
          format: date-time
          type: string
      type: object
    PUTAttachmentType:
      example:
        description: Details of the attachment
      properties:
        description:
          description: |
            Description of the attachment.
          type: string
        fileName:
          description: >
            File name of the attachment. The value should not contain the file
            extension. Only the file name without the extension can be edited.
          type: string
      type: object
    GETAttachmentResponseWithoutSuccessType:
      properties:
        createdBy:
          description: |
            Zuora user id of who added this attachment to the object.
          type: string
        createdOn:
          description: |
            Date and time when the attachment was added to the object.
          format: date-time
          type: string
        description:
          description: |
            Description of the attachment.
          type: string
        fileContentType:
          description: |
            Attachment file type.
          type: string
        fileId:
          description: >
            File ID of the attached file. Use this file ID with [Get
            files](https://developer.zuora.com/api-references/api/operation/GET_Files)
            to download the file.
          type: string
        fileName:
          description: |
            Attachment file name.
          type: string
        id:
          description: |
            Zuora id of this attachement.
          type: string
        organizationLabel:
          description: >
            The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is
            enabled.
          type: string
        updatedBy:
          description: |
            Zuora user id who last updated the attachment.
          type: string
        updatedOn:
          description: |
            Date and time when the attachment was last updated.
          format: date-time
          type: string
      title: attachments
      type: object
    GETAttachmentsResponseType:
      properties:
        attachments:
          description: |
            Container for one or more attachments.
          items:
            $ref: '#/components/schemas/GETAttachmentResponseWithoutSuccessType'
          type: array
        nextPage:
          description: >
            URL to retrieve the next page of the response if it exists;
            otherwise absent.
          format: URL
          type: string
        success:
          description: |
            Returns `true` if the request was processed successfully.
          type: boolean
      type: object
  headers:
    GLOBAL_HEADER_RESPONSE_Zuora_TrackId:
      schema:
        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.
    GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type:
      schema:
        type: string
      description: >
        The type of the concurrency limit, which can be `Default`, `High-volume
        transactions`, or `Object Query`.


        For more information, see [Concurrent request
        limits](https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits).
    GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit:
      schema:
        type: integer
      description: >
        The total number of the permitted concurrent requests.


        For more information, see [Concurrent request
        limits](https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits).
    GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining:
      schema:
        type: integer
      description: >
        The remaining number of the permitted concurrent requests.


        For more information, see [Concurrent request
        limits](https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits).
    GLOBAL_HEADER_RESPONSE_Zuora_RequestId:
      schema:
        type: string
        minLength: 36
        maxLength: 36
      description: |
        The Zuora internal identifier of the API call. 
        You cannot control the value of this header.
    GLOBAL_HEADER_RESPONSE_Content_Encoding:
      schema:
        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.


        Note that only the following MIME types support gzipped responses:
          - `application/json`
          - `application/xml`
          - `text/html`
          - `text/csv`
          - `text/plain`
    GLOBAL_HEADER_RESPONSE_RateLimit_Limit:
      schema:
        type: string
      description: >
        The request limit quota for the time window closest to exhaustion. See
        [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for
        more information.
    GLOBAL_HEADER_RESPONSE_RateLimit_Remaining:
      schema:
        type: number
      description: >
        The number of requests remaining in the time window closest to quota
        exhaustion. See [rate
        limits](https://developer.zuora.com/docs/guides/rate-limits/) for more
        information.
    GLOBAL_HEADER_RESPONSE_RateLimit_Reset:
      schema:
        type: number
      description: >-
        The number of seconds until the quota resets for the time window closest
        to quota exhaustion. See [rate
        limits](https://developer.zuora.com/docs/guides/rate-limits/) for more
        information. 
x-tagGroups:
  - name: Authentication
    tags:
      - OAuth
  - name: Commerce
    tags:
      - Commerce
  - name: Customer Accounts
    tags:
      - Accounts
      - Contacts
      - Contact Snapshots
  - name: Orders and Subscriptions
    tags:
      - Sign Up
      - Orders
      - Order Actions
      - Order Line Items
      - Fulfillments
      - Ramps
      - Subscriptions
      - Omnichannel Subscriptions
      - Subscription Change History
      - Rate Plans
      - Commitments
  - name: Advanced Consumption Billing
    tags:
      - Prepaid with Drawdown
  - name: Usage
    tags:
      - Usage
  - name: Mediation
    tags:
      - Meters
  - name: Billing Documents
    tags:
      - Delivery Adjustments
      - Billing Documents
      - Invoices
      - Credit Memos
      - Debit Memos
      - E-Invoicing
      - Invoice Schedules
      - Taxation Items
      - Sequence Sets
      - Operations
      - Summary Statements
  - 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
      - Payment Profiles
      - Configurable Payment Retry
  - name: Object Query
    tags:
      - Object Queries
  - 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
      - Tax Health
  - name: Workflow
    tags:
      - Workflows
  - name: Data Query
    tags:
      - Data Queries
  - name: AQuA
    tags:
      - Aggregate Queries
  - name: Deployment Manager
    tags:
      - Configuration Templates
      - Metadata
  - name: Data Loader
    tags:
      - Bulk Data
  - name: OneID
    tags:
      - SCIM
  - name: Multiple Organizations
    tags:
      - Data Labeling
  - name: Order to Revenue
    tags:
      - Data Backfill
      - Regenerate
  - name: Test Environments
    tags:
      - Test Environments
      - Test Environment Jobs
      - Test Environment Notifications
  - name: General-Purpose Operations
    tags:
      - Actions
      - Settings
      - Files
      - Imports
      - Custom Exchange Rates
      - Attachments
      - Describe
  - name: Legacy v1 Products
    tags:
      - Products
      - Catalog
      - Catalog Groups
      - Product Rate Plans
      - Product Rate Plan Definitions
      - Product Rate Plan Charges
      - Product Charge Definitions
      - Product Rate Plan Charge Tiers
      - Zuora Revenue Integration
